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:

Cake\Datasource\EntityInterface implements ArrayAccess, JsonSerializable

Direct Implementers

Namespace: Cake\Datasource
Location: Datasource/EntityInterface.php

Magic properties summary

  • $id public
    mixed
    Alias for commonly used primary key.

Method Summary

  • accessible() public

    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.

  • clean() public

    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

    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.

  • errors() public

    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.

  • extract() public

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

  • get() public
    Returns the value of a property by name
  • has() public

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

  • Get/Set the hidden properties on this entity.
  • isNew() public

    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.

  • set() public
    Sets one or multiple properties to the specified value
  • toArray() public
    Returns an array with all the visible properties set in this entity.
  • Removes a property or list of properties from this entity
  • Get/Set the virtual properties on this entity.
  • Get the list of visible properties.

Method Detail

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

Deprecated

3.4.0 Use setAccess() and isAccessible() instead.

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

clean()source 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()source public 

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

Deprecated

3.4.0 Use setDirty() and isDirty() instead.

Parameters

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

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

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

Deprecated

3.4.0 Use setErrors() and getErrors() instead.

Parameters

string|array|null $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

extract()source 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

get()source public 

get( string $property )

Returns the value of a property by name

Parameters

string $property
the name of the property to retrieve

Returns

mixed

has()source 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

hiddenProperties()source 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

isNew()source 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


set()source 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

toArray()source 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()source 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\Datasource\EntityInterface

virtualProperties()source 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

visibleProperties()source public 

visibleProperties( )

Get the list of visible properties.

Returns

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

Magic methods summary

extractOriginal()source public 

extractOriginal( array $properties )

Parameters

array $properties

Returns

array

extractOriginalChanged()source public 

extractOriginalChanged( array $properties )

Parameters

array $properties

Returns

array

getError()source public 

getError( $field )

Parameters

$field

Returns

array

getErrors()source public 

getErrors( )

Returns

array

getHidden()source public 

getHidden( )

Returns

array

getSource()source public 

getSource( )

Returns

array

getVirtual()source public 

getVirtual( )

Returns

array

isAccessible()source public 

isAccessible( $property )

Parameters

$property

Returns

boolean

isDirty()source public 

isDirty( $property )

Parameters

$property optional

Returns

boolean

setError()source public 

setError( $field , $errors , $overwrite )

Parameters

$field
$errors
$overwrite optional

Returns

array

setErrors()source public 

setErrors( array $fields , $overwrite )

Parameters

array $fields
$overwrite optional

Returns

array

Magic properties detail

$idsource

public mixed

© 2005–2017 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.4/class-Cake.Datasource.EntityInterface.html