Skip to main content

Zymba Documentation

ZeyOS.Object​

Text
object @ZeyOS.Object(@Base) {
construct(string $entity, ?int $id) {}
addTags(object $names): $this {}
canDelete(): bool {}
clear(): $this {}
delete(): bool {}
erase(?function $callback): bool {}
eraseRaw(): bool {}
exists(): bool {}
getEntity(): string {}
getField(string $name): ?string {}
getFieldArray(string $name): ?object {}
getFieldJSON(string $name): ?object {}
getID(): int {}
hasAccess(bool $writable): bool {}
hasField(string $name): bool {}
listExtData(): object {}
listFieldNames(): object {}
listFields(): object {}
listTags(): object {}
readBinFile(string $name): string {}
reload(): $this {}
removeFields(object $names): $this {}
removeTags(object $names): $this {}
resetTags(object $names): $this {}
save(?function $callback, object $extdata, object $tags): $this {}
saveRaw(): $this {}
selectExtData(): object {}
selectTags(): object {}
setExtData(object $fields): $this {}
setField(string $name, ?string $value): $this {}
setFieldArray(string $name, ?object $array): $this {}
setFieldEncrypted(string $name, ?string $value): $this {}
setFieldJSON(string $name, ?object $array): $this {}
setFields(object $fields): $this {}
writeBinFile(string $name, string $data): $this {}
}

Prototype​

Base

Methods​

CODE
$this.construct(string $entity, ?int $id): void
Parameters​
NameTypeValueDefault
entitystring""
id?intnew
CODE
$this.addTags(object $names): this
Parameters​
NameTypeValueDefault
namesobject[name, ...][]
Returns​
TypeValue
$this
CODE
$this.canDelete(): bool
Returns​
TypeValue
bool
CODE
$this.clear(): this
Returns​
TypeValue
$this
CODE
$this.delete(): bool
Returns​
TypeValue
bool
CODE
$this.erase(?function $callback): bool
Parameters​
NameTypeValueDefault
callback?functionno callback
Returns​
TypeValue
bool
CODE
$this.eraseRaw(): bool
Returns​
TypeValue
bool
CODE
$this.exists(): bool
Returns​
TypeValue
bool
CODE
$this.getEntity(): string
Returns​
TypeValue
string
CODE
$this.getField(string $name): ?string
Parameters​
NameTypeValueDefault
namestring""
Returns​
TypeValue
?string
CODE
$this.getFieldArray(string $name): ?object
Parameters​
NameTypeValueDefault
namestring""
Returns​
TypeValue
?object
CODE
$this.getFieldJSON(string $name): ?object
Parameters​
NameTypeValueDefault
namestring""
Returns​
TypeValue
?object
CODE
$this.getID(): int
Returns​
TypeValue
int
null
CODE
$this.hasAccess(bool $writable): bool
Parameters​
NameTypeValueDefault
writableboolfalse
Returns​
TypeValue
bool
CODE
$this.hasField(string $name): bool
Parameters​
NameTypeValueDefault
namestring""
Returns​
TypeValue
bool
CODE
$this.listExtData(): object
Returns​
TypeValue
object[name: value, ...]
CODE
$this.listFieldNames(): object
Returns​
TypeValue
object[name, ...]
CODE
$this.listFields(): object
Returns​
TypeValue
object[name: value, ...]
CODE
$this.listTags(): object
Returns​
TypeValue
object[name, ...]
CODE
$this.readBinFile(string $name): string
Parameters​
NameTypeValueDefault
namestring""
Returns​
TypeValue
string
CODE
$this.reload(): this
Returns​
TypeValue
$this
CODE
$this.removeFields(object $names): this
Parameters​
NameTypeValueDefault
namesobject[name, ...][]
Returns​
TypeValue
$this
CODE
$this.removeTags(object $names): this
Parameters​
NameTypeValueDefault
namesobject[name, ...][]
Returns​
TypeValue
$this
CODE
$this.resetTags(object $names): this
Parameters​
NameTypeValueDefault
namesobject[name, ...][]
Returns​
TypeValue
$this
CODE
$this.save(?function $callback, object $extdata, object $tags): this
Parameters​
NameTypeValueDefault
callback?functionno callback
extdataobject[name: value, ...][]
tagsobject[name, ...][]
Returns​
TypeValue
$this
CODE
$this.saveRaw(): this
Returns​
TypeValue
$this
CODE
$this.selectExtData(): @ZeyOS.ExtData
Returns​
TypeValue
@ZeyOS.ExtData
null
CODE
$this.selectTags(): @ZeyOS.Tags
Returns​
TypeValue
@ZeyOS.Tags
null
CODE
$this.setExtData(object $fields): this
Parameters​
NameTypeValueDefault
fieldsobject[name: value, ...][]
Returns​
TypeValue
$this
CODE
$this.setField(string $name, ?string $value): this
Parameters​
NameTypeValueDefault
namestring""
value?stringnull
Returns​
TypeValue
$this
CODE
$this.setFieldArray(string $name, ?object $array): this
Parameters​
NameTypeValueDefault
namestring""
array?object[value, ...]null
Returns​
TypeValue
$this
CODE
$this.setFieldEncrypted(string $name, ?string $value): this
Parameters​
NameTypeValueDefault
namestring""
value?stringnull
Returns​
TypeValue
$this
CODE
$this.setFieldJSON(string $name, ?object $array): this
Parameters​
NameTypeValueDefault
namestring""
array?objectnull
Returns​
TypeValue
$this
CODE
$this.setFields(object $fields): this
Parameters​
NameTypeValueDefault
fieldsobject[name: value, ...][]
Returns​
TypeValue
$this
CODE
$this.writeBinFile(string $name, string $data): this
Parameters​
NameTypeValueDefault
namestring""
datastring""
Returns​
TypeValue
$this