Property |
Type |
Description |
|
$actual |
string | null |
Actual field name. |
|
$dateTimeClass |
|
For example, 'DateTime', 'Carbon' etc. |
|
$dateTimeZoneClass |
|
For example, 'DateTimeZone', 'Carbon' etc. |
|
$default |
mixed |
Default value of field. |
|
$enum |
array | null |
For several types enum can provide list of available options. |
|
$join |
Join | null |
Join object. |
|
$mandatory |
boolean | string |
Can contain error message for UI. |
|
$never_persist |
boolean |
Setting this to true will never actually load or store
the field in the database. It will action as normal,
but will be skipped by load/iterate/update/insert. |
|
$never_save |
boolean |
Setting this to true will never actually store
the field in the database. It will action as normal,
but will be skipped by update/insert. |
|
$persist_format |
string |
For example, for date it can be 'Y-m-d', for datetime - 'Y-m-d H:i:s' etc. |
|
$persist_timezone |
string |
For example, 'IST', 'UTC', 'Europe/Riga' etc. |
|
$read_only |
boolean |
For example, expressions are read only. |
|
$serialize |
null | boolean | array |
Value can be array [$encode_callback, $decode_callback]. |
|
$system |
boolean |
Is it system field?
System fields will be always loaded and saved. |
|
$type |
string |
Values are: 'string', 'boolean', 'integer', 'money', 'float',
'date', 'datetime', 'time', 'array', 'object'.
Can also be set to unspecified type for your own custom handling. |
|
$typecast |
null | boolean | array |
Value can be array [$typecast_save_callback, $typecast_load_callback]. |
|
$ui |
array |
Array with UI flags like editable, visible and hidden. |
|