Class Entity

__constructsource public

__construct( array $properties [] , array $options [] )

Initializes the internal properties of this entity out of the keys in an array. The following list of options can be used:

• useSetters: whether use internal setters for properties or not
• markClean: whether to mark all properties as clean after setting them
• markNew: whether this instance has not yet been persisted
• guard: whether to prevent inaccessible properties from being set (default: false)
• source: A string representing the alias of the repository this entity came from

Example:

$entity = new Entity(['id' => 1, 'name' => 'Andrew'])

Parameters

array $properties optional []

hash of properties to set in this entity

array $options optional []

list of options to use when creating this entity

__debugInfosource public

__debugInfo( )

Returns an array that can be used to describe the internal state of this object.

Returns

array
array

__getsource public

__get( string $property )

Magic getter to access properties that have been set in this entity

Parameters

string $property

Name of the property to access

Returns

mixed
mixed

__issetsource public

__isset( 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

See

Cake\ORM\Entity::has()

__setsource public

__set( string $property , mixed $value )

Magic setter to add or edit a property in this entity

Parameters

string $property

The name of the property to set

mixed $value

The value to set to the property

__toStringsource public

__toString( )

Returns a string representation of this object in a human readable format.

Returns

string
string

__unsetsource public

__unset( string $property )

Removes a property from this entity

Parameters

string $property

The property to unset

_methodExistssource protected

_methodExists( string $method )

Determines whether a method exists in this class

Parameters

string $method

the method to check for existence

Returns

boolean
true if method exists

_nestedErrorssource protected

_nestedErrors( string $field )

Auxiliary method for getting errors in nested entities

Parameters

string $field

the field in this entity to check for errors

Returns

array
errors in nested entity if any

_readErrorsource protected

_readError( array|Cake\Datasource\EntityTrait $object , string $path null )

Read the error(s) from one or many objects.

Parameters

array|Cake\Datasource\EntityTrait $object

The object to read errors from.

string $path optional null

The field name for errors.

Returns

array
array

accessiblesource public

accessible( string|array $property , boolean $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.

You can also call this method with an array of properties, in which case they will each take the accessibility value specified in the second argument.

Example:

$entity->accessible('id', true); // Mark id as not protected
$entity->accessible('author_id', false); // Mark author_id as protected
$entity->accessible(['id', 'user_id'], true); // Mark both properties as accessible
$entity->accessible('*', false); // Mark all properties as protected

When called without the second param it will return whether or not the property can be set.

Example:

$entity->accessible('id'); // Returns whether it can be set or not

Parameters

string|array $property

single or list of properties to change its accessibility

boolean $set optional null

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

Returns

mixed
$this|bool

Implementation of

Cake\Datasource\EntityInterface::accessible()

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

Implementation of

Cake\Datasource\EntityInterface::clean()

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

Implementation of

Cake\Datasource\EntityInterface::dirty()

errorssource public

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 and any other nested entity.

Example

// Sets the error messages for a single field
$entity->errors('salary', ['must be numeric', 'must be a positive number']);

// Returns the error messages for a single field
$entity->errors('salary');

// Returns all error messages indexed by field name
$entity->errors();

// Sets the error messages for multiple fields at once
$entity->errors(['salary' => ['message'], 'name' => ['another message']);

When used as a setter, this method will return this entity instance for method chaining.

Parameters

string|array|null $field optional null

The field to get errors for, or the array of errors to set.

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|$this
$this

Implementation of

Cake\Datasource\EntityInterface::errors()

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

Implementation of

Cake\Datasource\EntityInterface::extract()

extractOriginalsource public

extractOriginal( array $properties )

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

Properties that are unchanged from their original value will be included in the return of this method.

Parameters

array $properties

List of properties to be returned

Returns

array
array

extractOriginalChangedsource public

extractOriginalChanged( array $properties )

Returns an array with only the original properties stored in this entity, indexed by property name.

This method will only return properties that have been modified since the entity was built. Unchanged properties will be omitted.

Parameters

array $properties

List of properties to be returned

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

Throws

InvalidArgumentException
if an empty property name is passed

Implementation of

Cake\Datasource\EntityInterface::get()

getOriginalsource public

getOriginal( string $property )

Returns the value of an original property by name

Parameters

string $property

the name of the property for which original value is retrieved.

Returns

mixed
mixed

Throws

InvalidArgumentException
if an empty property name is passed.

hassource public

has( string|array $property )

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

Example:

$entity = new Entity(['id' => 1, 'name' => null]);
$entity->has('id'); // true
$entity->has('name'); // false
$entity->has('last_name'); // false

When checking multiple properties. All properties must not be null in order for true to be returned.

Parameters

string|array $property

The property or properties to check.

Returns

boolean
bool

Implementation of

Cake\Datasource\EntityInterface::has()

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|$this
$this

Implementation of

Cake\Datasource\EntityInterface::hiddenProperties()

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 it will set the known status of this instance, true means that the instance is not yet persisted in the database, false that it already is.

Parameters

boolean|null $new optional null

true if it is known this instance was persisted

Returns

boolean
Whether or not the entity has been persisted.

Implementation of

Cake\Datasource\EntityInterface::isNew()

jsonSerializesource public

jsonSerialize( )

Returns the properties that will be serialized as JSON

Returns

array
array

offsetExistssource public

offsetExists( mixed $offset )

Implements isset($entity);

Parameters

mixed $offset

The offset to check.

Returns

boolean
Success

offsetGetsource public

offsetGet( mixed $offset )

Implements $entity[$offset];

Parameters

mixed $offset

The offset to get.

Returns

mixed
mixed

offsetSetsource public

offsetSet( mixed $offset , mixed $value )

Implements $entity[$offset] = $value;

Parameters

mixed $offset

The offset to set.

mixed $value

The value to set.

offsetUnsetsource public

offsetUnset( mixed $offset )

Implements unset($result[$offset);

Parameters

mixed $offset

The offset to remove.

setsource public

set( string|array $property , mixed $value null , array $options [] )

Sets a single property inside this entity.

Example:

$entity->set('name', 'Andrew');

It is also possible to mass-assign multiple properties to this entity with one call by passing a hashed array as properties in the form of property => value pairs

Example:

$entity->set(['name' => 'andrew', 'id' => 1]);
echo $entity->name // prints andrew
echo $entity->id // prints 1

Some times it is handy to bypass setter functions in this entity when assigning properties. You can achieve this by disabling the setter option using the $options parameter:

$entity->set('name', 'Andrew', ['setter' => false]);
$entity->set(['name' => 'Andrew', 'id' => 1], ['setter' => false]);

Mass assignment should be treated carefully when accepting user input, by default entities will guard all fields when properties are assigned in bulk. You can disable the guarding for a single set call with the guard option:

$entity->set(['name' => 'Andrew', 'id' => 1], ['guard' => true]);

You do not need to use the guard option when assigning properties individually:

// No need to use the guard option.
$entity->set('name', 'Andrew');

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

mixed
$this

Throws

InvalidArgumentException
\InvalidArgumentException

Implementation of

Cake\Datasource\EntityInterface::set()

sourcesource public

source( string $alias null )

Returns the alias of the repository from which this entity came from.

If called with no arguments, it returns the alias of the repository this entity came from if it is known.

Parameters

string $alias optional null

the alias of the repository

Returns

string|$this
$this

toArraysource public

toArray( )

Returns an array with all the properties that have been set to this entity

This method will recursively transform entities assigned to properties into arrays as well.

Returns

array
array

Implementation of

Cake\Datasource\EntityInterface::toArray()

unsetPropertysource public

unsetProperty( string|array $property )

Removes a property or list of properties from this entity

Examples:

$entity->unsetProperty('name');
$entity->unsetProperty(['name', 'last_name']);

Parameters

string|array $property

The property to unset.

Returns

mixed
$this

Implementation of

Cake\Datasource\EntityInterface::unsetProperty()

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|$this
$this

Implementation of

Cake\Datasource\EntityInterface::virtualProperties()

visiblePropertiessource public

visibleProperties( )

Get the list of visible properties.

The list of visible properties is all standard properties plus virtual properties minus hidden properties.

Returns

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

Implementation of

Cake\Datasource\EntityInterface::visibleProperties()

['*' => true]

[]

[]

[]

[]

true

[]

[]

[]