Interface EntityInterface
Describes the methods that any class representing a data storage should comply with.
In 4.x the following methods will officially be added to the interface:
Property Summary
-
$id public @property
mixedAlias for commonly used primary key.
Method Summary
-
accessible() public deprecated
Stores whether or not a property value can be changed or set in this entity. The special property
*can also be marked as accessible or protected, meaning that any other property specified before will take its value. For example$entity->accessible('*', true)means that any property not specified already will be accessible by default. -
clean() public
Sets the entire entity as clean, which means that it will appear as no properties being modified or added at all. This is an useful call for an initial object hydration
-
dirty() public deprecated
Sets the dirty status of a single property. If called with no second argument, it will return whether the property was modified or not after the object creation.
-
errors() public deprecated
Sets the error messages for a field or a list of fields. When called without the second argument it returns the validation errors for the specified fields. If called with no arguments it returns all the validation error messages stored in this entity.
-
extract() public
Returns an array with the requested properties stored in this entity, indexed by property name
-
extractOriginal() public @method
-
extractOriginalChanged() public @method
-
get() public
Returns the value of a property by name
-
getAccessible() public @method
-
getDirty() public @method
-
getError() public @method
-
getErrors() public @method
-
getHidden() public @method
-
getSource() public @method
-
getVirtual() public @method
-
getVisible() public @method
-
has() public
Returns whether this entity contains a property named $property regardless of if it is empty.
-
hasErrors() public @method
-
hiddenProperties() public
Get/Set the hidden properties on this entity.
-
isAccessible() public @method
-
isDirty() public @method
-
isNew() public
Returns whether or not this entity has already been persisted. This method can return null in the case there is no prior information on the status of this entity.
-
set() public
Sets one or multiple properties to the specified value
-
setAccess() public @method
-
setDirty() public @method
-
setError() public @method
-
setErrors() public @method
-
setHidden() public @method
-
setNew() public @method
-
setSource() public @method
-
setVirtual() public @method
-
toArray() public
Returns an array with all the visible properties set in this entity.
-
unsetProperty() public
Removes a property or list of properties from this entity
-
virtualProperties() public
Get/Set the virtual properties on this entity.
-
visibleProperties() public
Get the list of visible properties.
Method Detail
accessible() ¶ public
accessible(string|array $property, bool|null $set = null): Cake\Datasource\EntityInterface|boolStores whether or not a property value can be changed or set in this entity.
The special property * can also be marked as accessible or protected, meaning
that any other property specified before will take its value. For example
$entity->accessible('*', true) means that any property not specified already
will be accessible by default.
Parameters
-
string|array$property Either a single or list of properties to change its accessibility.
-
bool|null$set optional true marks the property as accessible, false will mark it as protected.
Returns
Cake\Datasource\EntityInterface|boolclean() ¶ public
clean(): voidSets the entire entity as clean, which means that it will appear as no properties being modified or added at all. This is an useful call for an initial object hydration
Returns
voiddirty() ¶ public
dirty(string|null $property = null, bool|null $isDirty = null): boolSets the dirty status of a single property. If called with no second argument, it will return whether the property was modified or not after the object creation.
When called with no arguments it will return whether or not there are any dirty property in the entity
Parameters
-
string|null$property optional the field to set or check status for
-
bool|null$isDirty optional true means the property was changed, false means it was not changed and null will make the function return current state for that property
Returns
boolerrors() ¶ public
errors(string|array|null $field = null, string|array|null $errors = null, bool $overwrite = false): array|Cake\Datasource\EntityInterfaceSets the error messages for a field or a list of fields. When called without the second argument it returns the validation errors for the specified fields. If called with no arguments it returns all the validation error messages stored in this entity.
When used as a setter, this method will return this entity instance for method chaining.
Parameters
-
string|array|null$field optional The field to get errors for.
-
string|array|null$errors optional The errors to be set for $field
-
bool$overwrite optional Whether or not to overwrite pre-existing errors for $field
Returns
array|Cake\Datasource\EntityInterfaceextract() ¶ public
extract(array $properties, bool $onlyDirty = false): arrayReturns an array with the requested properties stored in this entity, indexed by property name
Parameters
-
array$properties list of properties to be returned
-
bool$onlyDirty optional Return the requested property only if it is dirty
Returns
arrayextractOriginal() ¶ public @method
extractOriginal(array $properties): arrayParameters
-
array$properties
Returns
arrayextractOriginalChanged() ¶ public @method
extractOriginalChanged(array $properties): arrayParameters
-
array$properties
Returns
arrayget() ¶ public
get(string $property): mixedReturns the value of a property by name
Parameters
-
string$property the name of the property to retrieve
Returns
mixedhas() ¶ public
has(string|array $property): boolReturns whether this entity contains a property named $property regardless of if it is empty.
Parameters
-
string|array$property The property to check.
Returns
boolhasErrors() ¶ public @method
hasErrors(mixed $includeNested = true): boolParameters
-
$includeNested optional
Returns
boolhiddenProperties() ¶ public
hiddenProperties(array|null $properties = null): array|Cake\Datasource\EntityInterfaceGet/Set the hidden properties on this entity.
If the properties argument is null, the currently hidden properties will be returned. Otherwise the hidden properties will be set.
Parameters
-
array|null$properties optional Either an array of properties to hide or null to get properties
Returns
array|Cake\Datasource\EntityInterfaceisAccessible() ¶ public @method
isAccessible(mixed $property): boolParameters
-
$property
Returns
boolisDirty() ¶ public @method
isDirty(mixed $property = null): boolParameters
-
$property optional
Returns
boolisNew() ¶ public
isNew(bool|null $new = null): boolReturns whether or not this entity has already been persisted. This method can return null in the case there is no prior information on the status of this entity.
If called with a boolean, this method will set the status of this instance.
Using true means that the instance has not been persisted in the database, false
that it already is.
Parameters
-
bool|null$new optional Indicate whether or not this instance has been persisted.
Returns
boolset() ¶ public
set(string|array $property, mixed $value = null, array $options = []): Cake\Datasource\EntityInterfaceSets one or multiple properties to the specified value
Parameters
-
string|array$property the name of property to set or a list of properties with their respective values
-
mixed$value optional The value to set to the property or an array if the first argument is also an array, in which case will be treated as $options
-
array$options optional options to be used for setting the property. Allowed option keys are
setterandguard
Returns
Cake\Datasource\EntityInterfacesetAccess() ¶ public @method
setAccess(mixed $property, mixed $set): $thisParameters
-
$property -
$set
Returns
$thissetDirty() ¶ public @method
setDirty(mixed $property, mixed $isDirty = true): $thisParameters
-
$property -
$isDirty optional
Returns
$thissetError() ¶ public @method
setError(mixed $field, mixed $errors, mixed $overwrite = false): arrayParameters
-
$field -
$errors -
$overwrite optional
Returns
arraysetErrors() ¶ public @method
setErrors(array $fields, mixed $overwrite = false): arrayParameters
-
array$fields -
$overwrite optional
Returns
arraysetHidden() ¶ public @method
setHidden(array $properties, mixed $merge = false): $thisParameters
-
array$properties -
$merge optional
Returns
$thissetVirtual() ¶ public @method
setVirtual(array $properties, mixed $merge = false): $thisParameters
-
array$properties -
$merge optional
Returns
$thistoArray() ¶ public
toArray(): arrayReturns an array with all the visible properties set in this entity.
Note hidden properties are not visible, and will not be output by toArray().
Returns
arrayunsetProperty() ¶ public
unsetProperty(string|array $property): Cake\Datasource\EntityInterfaceRemoves a property or list of properties from this entity
Parameters
-
string|array$property The property to unset.
Returns
Cake\Datasource\EntityInterfacevirtualProperties() ¶ public
virtualProperties(array|null $properties = null): array|Cake\Datasource\EntityInterfaceGet/Set the virtual properties on this entity.
If the properties argument is null, the currently virtual properties will be returned. Otherwise the virtual properties will be set.
Parameters
-
array|null$properties optional Either an array of properties to treat as virtual or null to get properties
Returns
array|Cake\Datasource\EntityInterfacevisibleProperties() ¶ public
visibleProperties(): arrayGet the list of visible properties.
Returns
array