Zymba Documentation

ZeyOS

Text

object @ZeyOS() {
	BASEURL;
	EXTURL;
	LICENSEKEY;
	VERSION;
	authenticateUser(string $name, string $password, string $otp): object {}
	createShareToken(string $entity, int $id, ?int $expdate): string {}
	createZUGFERD(string $pdf, string $xml): string {}
	extractZUGFERD(string $pdf): string {}
	getTempPath(): string {}
	initializeItems(object $items): object {}
	listSessionVariables(): object {}
	log(string $message, string $type, string $severity) {}
	queueMail(string $message, ?int $mailserver, ?int $senddate): ?int {}
	readConfig(): object {}
	resetCron(string $name) {}
	selectDatabase(): object {}
	selectSession(): object {}
	sendFile(string $path) {}
	writeConfig(object $config) {}
}

Functions

CODE

@ZeyOS.authenticateUser(string $name, string $password, string $otp): @ZeyOS.ObjectUser

Parameters

Name	Type	Value	Default
name	string		""
password	string		""
otp	string		""

Returns

Type	Value
@ZeyOS.ObjectUser
null

CODE

@ZeyOS.createShareToken(string $entity, int $id, ?int $expdate): string

Parameters

Name	Type	Value	Default
entity	string		""
id	int		0
expdate	?int		100 days from now

Returns

Type	Value
string

CODE

@ZeyOS.createZUGFERD(string $pdf, string $xml): string

Parameters

Name	Type	Value	Default
pdf	string		""
xml	string		""

Returns

Type	Value
string

CODE

@ZeyOS.extractZUGFERD(string $pdf): string

Parameters

Name	Type	Value	Default
pdf	string		""

Returns

Type	Value
string
null

CODE

@ZeyOS.getTempPath(): string

Returns

Type	Value
string

CODE

@ZeyOS.initializeItems(object $items): object

Parameters

Name	Type	Value	Default
items	object		[]

Returns

Type	Value
object

Lists all session variables.

CODE

@ZeyOS.listSessionVariables(): object

Returns

Type	Value
object	[name: value, ...]

CODE

@ZeyOS.log(string $message, string $type, string $severity): void

Parameters

Name	Type	Value	Default
message	string		""
type	string		""
severity	string		""

CODE

@ZeyOS.queueMail(string $message, ?int $mailserver, ?int $senddate): ?int

Parameters

Name	Type	Value	Default
message	string		""
mailserver	?int		null
senddate	?int		null

Returns

Type	Value
?int

CODE

@ZeyOS.readConfig(): object

Returns

Type	Value
object

CODE

@ZeyOS.resetCron(string $name): void

Parameters

Name	Type	Value	Default
name	string		""

CODE

@ZeyOS.selectDatabase(): @SQL.PostgreSQL

Returns

Type	Value
@SQL.PostgreSQL

CODE

@ZeyOS.selectSession(): @ZeyOS.ObjectUser

Returns

Type	Value
@ZeyOS.ObjectUser
null

Sends the content of a file as sole output on exit (if possible).

CODE

@ZeyOS.sendFile(string $path): void

Parameters

Name	Type	Value	Default
path	string		""

CODE

@ZeyOS.writeConfig(object $config): void

Parameters

Name	Type	Value	Default
config	object		[]