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:
$id public mixedStores 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.
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
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.
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.
Returns an array with the requested properties stored in this entity, indexed by property name
Returns whether this entity contains a property named $property regardless of if it is empty.
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.
accessible( string|array $property , boolean|null $set null )
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.
$property $set optional null true marks the property as accessible, false will mark it as protected.
Cake\Datasource\EntityInterface|booleanclean( )
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( string|null $property null , null|boolean $isDirty null )
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.
When called with no arguments it will return whether or not there are any dirty property in the entity
$property optional null $isDirty optional null true means the property was changed, false means it was not changed and null will make the function return current state for that property
errors( string|array|null $field null , string|array|null $errors null , boolean $overwrite false )
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.
When used as a setter, this method will return this entity instance for method chaining.
$field optional null $errors optional null $overwrite optional false Cake\Datasource\EntityInterfaceextract( array $properties , boolean $onlyDirty false )
Returns an array with the requested properties stored in this entity, indexed by property name
$properties $onlyDirty optional false get( string $property )
Returns the value of a property by name
$property has( string|array $property )
Returns whether this entity contains a property named $property regardless of if it is empty.
$property hiddenProperties( null|array $properties null )
Get/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.
$properties optional null Cake\Datasource\EntityInterfaceisNew( boolean|null $new null )
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.
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.
$new optional null If it is known whether the entity was already persisted null otherwise
set( string|array $property , mixed $value null , array $options [] )
Sets one or multiple properties to the specified value
$property the name of property to set or a list of properties with their respective values
$value optional null 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
$options optional [] options to be used for setting the property. Allowed option keys are setter and guard
Cake\Datasource\EntityInterfacetoArray( )
Returns an array with all the visible properties set in this entity.
Note hidden properties are not visible, and will not be output by toArray().
unsetProperty( string|array $property )
Removes a property or list of properties from this entity
$property Cake\Datasource\EntityInterfacevirtualProperties( null|array $properties null )
Get/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.
$properties optional null Cake\Datasource\EntityInterfacevisibleProperties( )
Get the list of visible properties.
public mixed
© 2005–2018 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Datasource.EntityInterface.html