Describes the methods that any class representing a data storage should comply with.
mixedAlias for commonly used primary key.
Sets the entire entity as clean, which means that it will appear as no fields being modified or added at all. This is an useful call for an initial object hydration
Returns an array with the requested fields stored in this entity, indexed by field name
Returns an array with the requested original fields stored in this entity, indexed by field name.
Returns an array with only the original fields stored in this entity, indexed by field name.
Returns whether this entity contains a field named $field regardless of if it is empty.
clean()
Sets the entire entity as clean, which means that it will appear as no fields being modified or added at all. This is an useful call for an initial object hydration
extract(array $fields, bool $onlyDirty)
Returns an array with the requested fields stored in this entity, indexed by field name
string[] $fields list of fields to be returned
bool $onlyDirty optional Return the requested field only if it is dirty
arrayextractOriginal(array $fields)
Returns an array with the requested original fields stored in this entity, indexed by field name.
string[] $fields List of fields to be returned
arrayextractOriginalChanged(array $fields)
Returns an array with only the original fields stored in this entity, indexed by field name.
string[] $fields List of fields to be returned
arrayget(string $field)
Returns the value of a field by name
string $field the name of the field to retrieve
mixedgetAccessible()
getDirty()
Gets the dirty fields.
string[]getError(string $field)
Returns validation errors of a field
string $field Field name to get the errors from
arraygetErrors()
Returns all validation errors.
arraygetHidden()
Gets the hidden fields.
string[]getOriginal(string $field)
Returns the original value of a field.
string $field The name of the field.
mixedgetOriginalValues()
Gets all original values of the entity.
arraygetSource()
Returns the alias of the repository from which this entity came from.
stringgetVirtual()
Gets the virtual fields on this entity.
string[]getVisible()
Get the list of visible fields.
string[]A list of fields that are 'visible' in all representations.
has(mixed $field)
Returns whether this entity contains a field named $field regardless of if it is empty.
string|string[] $field The field to check.
boolhasErrors(bool $includeNested)
Returns whether this entity has errors.
bool $includeNested optional true will check nested entities for hasErrors()
boolisAccessible(string $field)
Checks if a field is accessible
string $field Field name to check
boolisDirty(?string $field)
Checks if the entity is dirty or if a single field of it is dirty.
string|null $field optional The field to check the status for. Null for the whole entity.
boolWhether the field was changed or not
isNew()
Returns whether or not this entity has already been persisted.
boolWhether or not the entity has been persisted.
set(mixed $field, mixed $value, array $options)
Sets one or multiple fields to the specified value
string|array $field the name of field to set or a list of fields with their respective values
mixed $value optional The value to set to the field 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 field. Allowed option keys are setter and guard
$thissetAccess(mixed $field, bool $set)
Stores whether or not a field value can be changed or set in this entity.
string|array $field single or list of fields to change its accessibility
bool $set true marks the field as accessible, false will mark it as protected.
$thissetDirty(string $field, bool $isDirty)
Sets the dirty status of a single field.
string $field the field to set or check status for
bool $isDirty optional true means the field was changed, false means it was not changed. Default true.
$thissetError(string $field, mixed $errors, bool $overwrite)
Sets errors for a single field
string $field The field to get errors for, or the array of errors to set.
string|array $errors The errors to be set for $field
bool $overwrite optional Whether or not to overwrite pre-existing errors for $field
$thissetErrors(array $errors, bool $overwrite)
Sets error messages to the entity
array $errors The array of errors to set.
bool $overwrite optional Whether or not to overwrite pre-existing errors for $fields
$thissetHidden(array $fields, bool $merge)
Sets hidden fields.
string[] $fields An array of fields to hide from array exports.
bool $merge optional Merge the new fields with the existing. By default false.
$thissetNew(bool $new)
Set the status of this entity.
Using true means that the entity has not been persisted in the database, false indicates that the entity has been persisted.
bool $new Indicate whether or not this entity has been persisted.
$thissetSource(string $alias)
Sets the source alias
string $alias the alias of the repository
$thissetVirtual(array $fields, bool $merge)
Sets the virtual fields on this entity.
string[] $fields An array of fields to treat as virtual.
bool $merge optional Merge the new fields with the existing. By default false.
$thistoArray()
Returns an array with all the visible fields set in this entity.
Note hidden fields are not visible, and will not be output by toArray().
arrayunset(mixed $field)
Removes a field or list of fields from this entity
string|string[] $field The field to unset.
$thisAlias for commonly used primary key.
mixed
© 2005–present 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/4.1/interface-Cake.Datasource.EntityInterface.html