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:

Namespace: Cake\Datasource

Properties summary

  • $id public
    mixed

    Alias for commonly used primary key.

Method Summary

Method Detail

accessible() public 

accessible(mixed $property, mixed $set)

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.

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|bool

clean() public 

clean()

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 

dirty(mixed $property, mixed $isDirty)

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

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

bool

whether the property was changed or not

errors() public 

errors(mixed $field, mixed $errors, mixed $overwrite)

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.

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\EntityInterface

extract() public 

extract(array $properties, mixed $onlyDirty)

Returns 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

array

extractOriginal() public 

extractOriginal(array $properties)

Parameters

array $properties

extractOriginalChanged() public 

extractOriginalChanged(array $properties)

Parameters

array $properties

get() public 

get(mixed $property)

Returns the value of a property by name

Parameters

string $property

the name of the property to retrieve

Returns

mixed

getAccessible() public 

getAccessible()

getDirty() public 

getDirty()

getError() public 

getError(mixed $field)

Parameters

mixed $field

getErrors() public 

getErrors()

getHidden() public 

getHidden()

getSource() public 

getSource()

getVirtual() public 

getVirtual()

getVisible() public 

getVisible()

has() public 

has(mixed $property)

Returns whether this entity contains a property named $property regardless of if it is empty.

Parameters

string|array $property

The property to check.

Returns

bool

hasErrors() public 

hasErrors(mixed $includeNested)

Parameters

mixed $includeNested

hiddenProperties() public 

hiddenProperties(mixed $properties)

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.

Parameters

array|null $properties optional

Either an array of properties to hide or null to get properties

Returns

array|\Cake\Datasource\EntityInterface

isAccessible() public 

isAccessible(mixed $property)

Parameters

mixed $property

isDirty() public 

isDirty(mixed $property)

Parameters

mixed $property

isNew() public 

isNew(mixed $new)

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.

Parameters

bool|null $new optional

Indicate whether or not this instance has been persisted.

Returns

bool

If it is known whether the entity was already persisted null otherwise

set() public 

set(mixed $property, mixed $value, array $options)

Sets 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 setter and guard

Returns

\Cake\Datasource\EntityInterface

setAccess() public 

setAccess(mixed $property, mixed $set)

Parameters

mixed $property
mixed $set

setDirty() public 

setDirty(mixed $property, mixed $isDirty)

Parameters

mixed $property
mixed $isDirty

setError() public 

setError(mixed $field, mixed $errors, mixed $overwrite)

Parameters

mixed $field
mixed $errors
mixed $overwrite

setErrors() public 

setErrors(array $fields, mixed $overwrite)

Parameters

array $fields
mixed $overwrite

setHidden() public 

setHidden(array $properties, mixed $merge)

Parameters

array $properties
mixed $merge

setNew() public 

setNew(mixed $new)

Parameters

mixed $new

setSource() public 

setSource(mixed $source)

Parameters

mixed $source

setVirtual() public 

setVirtual(array $properties, mixed $merge)

Parameters

array $properties
mixed $merge

toArray() public 

toArray()

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().

Returns

array

unsetProperty() public 

unsetProperty(mixed $property)

Removes a property or list of properties from this entity

Parameters

string|array $property

The property to unset.

Returns

\Cake\Datasource\EntityInterface

virtualProperties() public 

virtualProperties(mixed $properties)

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.

Parameters

array|null $properties optional

Either an array of properties to treat as virtual or null to get properties

Returns

array|\Cake\Datasource\EntityInterface

visibleProperties() public 

visibleProperties()

Get the list of visible properties.

Returns

array

A list of properties that are 'visible' in all representations.

Property Detail

$id public

Alias for commonly used primary key.

Type

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/3.9/interface-Cake.Datasource.EntityInterface.html