Interface EntityInterface

accessiblesource public

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.

Parameters

string|array $property

Either a single or list of properties to change its accessibility.

boolean|null $set optional null

true marks the property as accessible, false will mark it as protected.

Returns

Cake\Datasource\EntityInterface|boolean
\Cake\Datasource\EntityInterface|bool

cleansource 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

dirtysource public

dirty( string $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

Parameters

string $property optional null

the field to set or check status for

null|boolean $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

Returns

boolean
whether the property was changed or not

errorssource public

errors( string|array $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.

Parameters

string|array $field optional null

The field to get errors for.

string|array|null $errors optional null

The errors to be set for $field

boolean $overwrite optional false

Whether or not to overwrite pre-existing errors for $field

Returns

array|Cake\Datasource\EntityInterface
array|\Cake\Datasource\EntityInterface

extractsource public

extract( array $properties , boolean $onlyDirty false )

Returns an array with the requested properties stored in this entity, indexed by property name

Parameters

array $properties

list of properties to be returned

boolean $onlyDirty optional false

Return the requested property only if it is dirty

Returns

array
array

getsource public

get( string $property )

Returns the value of a property by name

Parameters

string $property

the name of the property to retrieve

Returns

mixed
mixed

hassource public

has( string $property )

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

Parameters

string $property

The property to check.

Returns

boolean
bool

hiddenPropertiessource public

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.

Parameters

null|array $properties optional null

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

Returns

array|Cake\Datasource\EntityInterface
array|\Cake\Datasource\EntityInterface

isNewsource public

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

Parameters

boolean|null $new optional null

Indicate whether or not this instance has been persisted.

Returns

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

setsource public

set( string|array $property , mixed $value null , 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 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

array $options optional []

options to be used for setting the property. Allowed option keys are setter and guard

Returns

Cake\Datasource\EntityInterface
\Cake\Datasource\EntityInterface

toArraysource 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
array

unsetPropertysource public

unsetProperty( string|array $property )

Removes a property or list of properties from this entity

Parameters

string|array $property

The property to unset.

Returns

Cake\ORM\
\Cake\ORM\

virtualPropertiessource public

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

Parameters

null|array $properties optional null

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

Returns

array|Cake\Datasource\EntityInterface
array|\Cake\Datasource\EntityInterface

visiblePropertiessource public

visibleProperties( )

Get the list of visible properties.

Returns

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