• Главная
• lithium
• data
• Entity

PHP Класс lithium\data\Entity

The Entity class can also be used as a base class for your own custom data objects, and is the basis for generating forms with the Form helper. Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_autoConfig	array	Auto configuration.
$_data	array	Associative array of the entity's fields and values.
$_errors	array	The list of validation errors associated with this object, where keys are field names, and values are arrays containing one or more validation error messages.
$_exists	boolean	A flag indicating whether or not this entity exists. Set to false if this is a newly-created entity, or if this entity has been loaded and subsequently deleted. Set to true if the entity has been loaded from the database, or has been created and subsequently saved.
$_handlers	array	Hold the "data export" handlers where the keys are fully-namespaced class names, and the values are closures that take an instance of the class as a parameter, and return an array or scalar value that the instance represents.
$_increment	array	An array of key/value pairs corresponding to fields that should be updated using atomic incrementing / decrementing operations. Keys match field names, and values indicate the value each field should be incremented or decremented by.
$_model	string	Fully-namespaced class name of model that this record is bound to. Instance methods declared in the model may be called on the entity. See the Model class documentation for more information.
$_parent	object	If this record is chained off of another, contains the origin object.
$_relationships	array	An array containing all related records and recordsets, keyed by relationship name, as defined in the bound model class.
$_schema	array	to create a form.
$_updated	array	Contains the values of updated fields. These values will be persisted to the backend data store when the document is saved.

Открытые методы

Метод	Описание
__call ( string $method, array $params ) : mixed	Magic method that allows calling of model methods on this record instance, i.e.: $record->validates();
__construct ( array $config = [] ) : void	Constructor.
__get ( string $name ) : mixed	Overloading for reading inaccessible properties.
__isset ( string $name ) : mixed	Overloading for calling isset() or empty() on inaccessible properties.
__set ( string $name, mixed $value ) : void	PHP magic method used when setting properties on the Entity instance, i.e.
__toString ( ) : string	Returns a string representation of the Entity instance, based on the result of the 'title' meta value of the bound model class.
assignTo ( object $parent, array $config = [] )	Configures protected properties of an Entity so that it is parented to $parent.
data ( string $name = null ) : mixed	Access the data fields of the record. Can also access a $named field.
decrement ( string $field, string $value = 1 ) : integer	Decrements a field by the specified value. Works identically to increment(), but in reverse.
errors ( array | string $field = null, string $value = null ) : mixed	Access the errors of the record.
exists ( ) : boolean	A flag indicating whether or not this record exists.
export ( array $options = [] )
increment ( string $field, integer | string $value = 1 ) : integer	Safely (atomically) increments the value of the specified field by an arbitrary value.
model ( ) : string	Returns the model which this entity is bound to.
modified ( $field = null ) : mixed	Gets the current state for a given field or, if no field is given, gets the array of fields modified on this entity.
parent ( ) : object	Returns the parent object of this object, if any.
respondsTo ( string $method, boolean $internal = false ) : boolean	Determines if a given method can be called.
schema ( $field = null )
serialize ( ) : string	Prepares, enables and executes serialization of the object.
set ( array $data ) : void	Allows several properties to be assigned at once, i.e.: $record->set(array('title' => 'Lorem Ipsum', 'value' => 42));
sync ( mixed $id = null, array $data = [], array $options = [] )	Called after an Entity is saved. Updates the object's internal state to reflect the corresponding database entity, and sets the Entity object's key, if this is a newly-created object. **Do not** call this method if you intend to update the database's copy of the entity. Instead, see Model::save().
to ( string $format, array $options = [] ) : mixed	Converts the data in the record set to a different format, i.e. an array.
unserialize ( string $data ) : void	Prepares, enables and executes unserialization of the object.

Защищенные методы

Метод	Описание
_init ( )

Описание методов

Описание свойств