CopilotRoles extends Param
Table of Contents
Constants
- PARAM_TYPES = [self::TYPE_STRING, self::TYPE_INT, self::TYPE_BOOL, self::TYPE_JSON, self::TYPE_STRING_ARRAY, self::TYPE_INT_ARRAY]
- TYPE_BOOL = 'boolean'
- TYPE_INT = 'integer'
- TYPE_INT_ARRAY = 'arrayInteger'
- TYPE_JSON = 'json'
- TYPE_STRING = 'string'
- TYPE_STRING_ARRAY = 'arrayString'
Methods
- delete() : Result
- fill() : static
- Fills object's fields with provided values.
- fillActual() : self
- getChatId() : int|null
- getDataClass() : string
- Returns ORM tablet class name.
- getDataEntity() : EntityObject
- getJsonValue() : mixed
- getName() : string|null
- getParamId() : int|null
- getPrimaryId() : int|null
- getRegistry() : Registry|null
- Return link of the object's registry.
- getType() : string
- getValue() : mixed
- hasValue() : bool
- isChanged() : bool
- Tells true if object has been changed.
- isDeleted() : bool
- Tells true if object marked to drop.
- isHidden() : bool
- load() : Result
- loadJsonFilter() : mixed
- loadValueFilter() : mixed
- markChanged() : static
- Marks object changed.
- markDrop() : static
- Marks object to drop on save.
- onAfterOrmUpdate() : self
- prepareFields() : Result
- save() : Result
- saveJsonFilter() : mixed
- saveValueFilter() : mixed
- setChatId() : self
- setHidden() : self
- setJsonValue() : self
- setName() : self
- setParamId() : self
- setPrimaryId() : self
- setRegistry() : self
- setType() : self
- setValue() : self
- toArray() : array<string|int, mixed>
- Returns object state as array.
- toPullFormat() : array<string|int, mixed>|null
- toRestFormat() : array<string|int, mixed>|null
- unsetValue() : self
Constants
PARAM_TYPES
public
mixed
PARAM_TYPES
= [self::TYPE_STRING, self::TYPE_INT, self::TYPE_BOOL, self::TYPE_JSON, self::TYPE_STRING_ARRAY, self::TYPE_INT_ARRAY]
TYPE_BOOL
public
mixed
TYPE_BOOL
= 'boolean'
TYPE_INT
public
mixed
TYPE_INT
= 'integer'
TYPE_INT_ARRAY
public
mixed
TYPE_INT_ARRAY
= 'arrayInteger'
TYPE_JSON
public
mixed
TYPE_JSON
= 'json'
TYPE_STRING
public
mixed
TYPE_STRING
= 'string'
TYPE_STRING_ARRAY
public
mixed
TYPE_STRING_ARRAY
= 'arrayString'
Methods
delete()
public
delete() : Result
Return values
Resultfill()
Fills object's fields with provided values.
public
fill(array<string|int, mixed> $source) : static
Parameters
- $source : array<string|int, mixed>
Return values
staticfillActual()
public
fillActual(array<string|int, mixed> $fieldsToFill) : self
Parameters
- $fieldsToFill : array<string|int, mixed>
Return values
selfgetChatId()
public
getChatId() : int|null
Return values
int|nullgetDataClass()
Returns ORM tablet class name.
public
static getDataClass() : string
Return values
stringgetDataEntity()
public
getDataEntity() : EntityObject
Return values
EntityObjectgetJsonValue()
public
getJsonValue() : mixed
getName()
public
getName() : string|null
Return values
string|nullgetParamId()
public
getParamId() : int|null
Return values
int|nullgetPrimaryId()
public
getPrimaryId() : int|null
Return values
int|nullgetRegistry()
Return link of the object's registry.
public
getRegistry() : Registry|null
Return values
Registry|nullgetType()
public
getType() : string
Return values
stringgetValue()
public
getValue() : mixed
hasValue()
public
hasValue() : bool
Return values
boolisChanged()
Tells true if object has been changed.
public
isChanged() : bool
Return values
boolisDeleted()
Tells true if object marked to drop.
public
isDeleted() : bool
Return values
boolisHidden()
public
isHidden() : bool
Return values
boolload()
public
load(int|array<string|int, mixed>|EntityObject $source) : Result
Parameters
- $source : int|array<string|int, mixed>|EntityObject
Return values
ResultloadJsonFilter()
public
loadJsonFilter(mixed $value) : mixed
Parameters
- $value : mixed
loadValueFilter()
public
loadValueFilter(mixed $value) : mixed
Parameters
- $value : mixed
markChanged()
Marks object changed.
public
markChanged([bool|null $state = null ]) : static
Parameters
- $state : bool|null = null
Return values
staticmarkDrop()
Marks object to drop on save.
public
markDrop() : static
Return values
staticonAfterOrmUpdate()
public
onAfterOrmUpdate(array<string|int, mixed> $fields) : self
Parameters
- $fields : array<string|int, mixed>
Return values
selfprepareFields()
public
prepareFields() : Result
Return values
Resultsave()
public
save() : Result
Return values
ResultsaveJsonFilter()
public
saveJsonFilter(mixed $value) : mixed
Parameters
- $value : mixed
saveValueFilter()
public
saveValueFilter(mixed $value) : mixed
Parameters
- $value : mixed
setChatId()
public
setChatId(int $chatId) : self
Parameters
- $chatId : int
Return values
selfsetHidden()
public
setHidden(bool $isHidden) : self
Parameters
- $isHidden : bool
Return values
selfsetJsonValue()
public
setJsonValue(mixed $value) : self
Parameters
- $value : mixed
Return values
selfsetName()
public
setName(string $name) : self
Parameters
- $name : string
Return values
selfsetParamId()
public
setParamId(int $paramId) : self
Parameters
- $paramId : int
Return values
selfsetPrimaryId()
public
setPrimaryId(int $primaryId) : self
Parameters
- $primaryId : int
Return values
selfsetRegistry()
public
setRegistry(Registry $registry) : self
Parameters
- $registry : Registry
Return values
selfsetType()
public
setType(string $type) : self
Parameters
- $type : string
Return values
selfsetValue()
public
setValue(mixed $value) : self
Parameters
- $value : mixed
Return values
selftoArray()
Returns object state as array.
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>toPullFormat()
public
toPullFormat() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nulltoRestFormat()
public
toRestFormat() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullunsetValue()
public
unsetValue() : self