Особенность EntityTrait

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

__get()source public

__get( string $property )

Магический метод доступа для получения свойств, заданных в этом объекте.

Параметры

string $property

Имя свойства для доступа

Возвращает

mixed

__isset()source public

__isset( string $property )

Возвращает, содержит ли этот объект свойство с именем $property, независимо от того, пустое оно или нет.

Параметры

string $property

Проверяемое свойство.

Возвращает

boolean

См. также

\Cake\ORM\Entity::has()

__set()source public

__set( string $property , mixed $value )

Магический метод установки для добавления или изменения свойства в этом объекте.

Параметры

string $property

Имя свойства для установки

mixed $value

Значение для установки свойства

__toString()source public

__toString( )

Возвращает строковое представление этого объекта в удобочитаемом формате.

Возвращает

string

__unset()source public

__unset( string $property )

Удаляет свойство из этого объекта.

Параметры

string $property

Свойство для удаления

_accessor()source protected static

_accessor( string $property , string $type )

Получить имя метода доступа. Методы доступа (доступные или нет) кэшируются в $_accessors

Параметры

string $property

имя поля для получения имени метода доступа

string $type

тип доступа ('get' или 'set')

Возвращает

string
Имя метода или пустую строку (метод недоступен)

_nestedErrors()source protected

_nestedErrors( string $field )

Вспомогательный метод для получения ошибок в вложенных объектах.

Параметры

string $field

поле в этом объекте, для проверки ошибок

Возвращает

array
ошибки вложенного объекта, если есть

_readError()source protected

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

Считывание ошибки(ок) из одного или нескольких объектов.

Параметры

array|Cake\Datasource\EntityTrait $object

Объект для считывания ошибок.

string|null $path необязательно null

Имя поля для ошибок.

Возвращает

array

accessible()source public

accessible( string|array $property , boolean|null $set null )

Указывает, можно ли изменить или установить значение свойства в этом объекте. Специальное свойство * также может быть помечено как доступное или защищенное, что означает, что любое другое указанное свойство примет его значение. Например, $entity->accessible('*', true) означает, что любое свойство, которое не указано, будет доступно по умолчанию.

Также можно вызвать этот метод с массивом свойств, в этом случае каждое из них получит указанное значение доступности.

Пример:

$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

Если вызывается без второго параметра, возвращается, можно ли установить свойство.

Пример:

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

Устарело

3.4.0 Используйте EntityTrait::setAccess() и EntityTrait::isAccessible()

Параметры

string|array $property

одно или список свойств для изменения доступности

boolean|null $set необязательно null

true отмечает свойство как доступное, false отмечает как защищенное.

Возвращает

$this|bool

clean()source public

clean( )

Устанавливает весь объект как чистый, что означает, что он не будет отображаться как изменённое или добавленное свойство. Это полезный вызов для начальной загрузки объекта.

dirty()source public

dirty( string|null $property null , null|boolean $isDirty null )

Устанавливает состояние «изменённое» для отдельного свойства. Если вызывается без второго аргумента, возвращается, было ли свойство изменено после создания объекта.

Если вызывается без аргументов, возвращается, есть ли в объекте изменённые свойства.

Устарело

3.4.0 Используйте EntityTrait::setDirty() и EntityTrait::isDirty()

Параметры

string|null $property необязательно null

поле для установки или проверки статуса

null|boolean $isDirty необязательно null

true означает, что свойство было изменено, false означает, что оно не было изменено, а null заставит функцию вернуть текущее состояние для этого свойства.

Возвращает

boolean
Было ли свойство изменено

errors()source public

errors( string|array|null $field null , string|array|null $errors null , boolean $overwrite false )

Устанавливает сообщения об ошибках для поля или списка полей. Если вызывается без второго аргумента, возвращаются сообщения об ошибках проверки для указанных полей. Если вызывается без аргументов, возвращаются все сообщения об ошибках проверки, хранящиеся в этом объекте и любых других вложенных объектах.

Пример

// 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']);

При использовании в качестве метода-установщика этот метод вернет экземпляр этого объекта для цепочки методов.

Устарело

3.4.0 Используйте EntityTrait::setError(), EntityTrait::setErrors(), EntityTrait::getError() и EntityTrait::getErrors()

Параметры

string|array|null $field необязательно null

Поле для получения ошибок или массив ошибок для установки.

string|array|null $errors необязательно null

Ошибки, которые должны быть установлены для $field

boolean $overwrite необязательно false

Заменить ли уже существующие ошибки для $field

Возвращает

array|Cake\Datasource\EntityTrait
$this

extract()source public

extract( array $properties , boolean $onlyDirty false )

Возвращает массив с запрошенными свойствами, хранящимися в этом объекте, индексированными по имени свойства.

Параметры

array $properties

список свойств, которые нужно вернуть

boolean $onlyDirty необязательно false

Возвратить запрошенное свойство только в том случае, если оно изменено

Возвращает

array

extractOriginal()source public

extractOriginal( array $properties )

Возвращает массив с исходными запрошенными свойствами, хранящимися в этом объекте, индексированными по имени свойства.

Свойства, которые не изменены со своего начального значения, будут включены в возвращаемое значение этого метода.

Параметры

array $properties

Список свойств, которые нужно вернуть

Возвращает

array

extractOriginalChanged()source public

extractOriginalChanged( array $properties )

Возвращает массив, содержащий только исходные свойства сущности, индексированные по имени свойства.

Этот метод вернёт только свойства, изменённые с момента создания сущности. Неизменённые свойства будут пропущены.

Параметры

массив $properties

Список свойств, которые должны быть возвращены

Возвращаемое значение

массив

get()source public

get( string $property )

Возвращает значение свойства по имени

Параметры

строка $property

имя свойства для извлечения

Возвращаемое значение

смешанное

Исключения

InvalidArgumentException
если передано пустое имя свойства

getDirty()source public

getDirty( )

Возвращает изменённые свойства.

Возвращаемое значение

массив

getError()source public

getError( string $field )

Возвращает ошибки валидации для поля

Параметры

строка $field

Имя поля, для которого нужно получить ошибки

Возвращаемое значение

массив

getErrors()source public

getErrors( )

Возвращает все ошибки валидации.

Возвращаемое значение

массив

getHidden()source public

getHidden( )

Возвращает скрытые свойства.

Возвращаемое значение

массив

getInvalid()source public

getInvalid( )

Получает список невалидных полей и их данных для ошибок при валидации/обновлении.

Возвращаемое значение

массив

getInvalidField()source public

getInvalidField( string $field )

Получает единственное значение невалидного поля. Возвращает null, если поле не задано.

Параметры

строка $field

Имя поля.

Возвращаемое значение

смешанное

getOriginal()source public

getOriginal( string $property )

Возвращает значение исходного свойства по имени

Параметры

строка $property

имя свойства, для которого нужно получить исходное значение.

Возвращаемое значение

смешанное

Исключения

InvalidArgumentException
если передано пустое имя свойства.

getOriginalValues()source public

getOriginalValues( )

Возвращает все исходные значения сущности.

Возвращаемое значение

массив

getSource()source public

getSource( )

Возвращает псевдоним репозитория, из которого была получена эта сущность.

Возвращаемое значение

строка

getVirtual()source public

getVirtual( )

Получает виртуальные свойства этой сущности.

Возвращаемое значение

массив

has()source public

has( string|array $property )

Возвращает true, если сущность содержит свойство $property, содержащее ненулевое значение.

Пример:

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

Вы можете проверить несколько свойств, передав массив:

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

Для получения истинного значения все свойства должны быть не нулевыми.

При проверке нескольких свойств все свойства должны быть не нулевыми для возвращения true.

Параметры

строка|массив $property

Проверяемое свойство или свойства.

Возвращаемое значение

булево

hiddenProperties()source public

hiddenProperties( null|array $properties null )

Получение/Установка скрытых свойств сущности.

Если аргумент properties равен null, будут возвращены текущие скрытые свойства. В противном случае скрытые свойства будут установлены.

Устарело

3.4.0 Используйте EntityTrait::setHidden() и EntityTrait::getHidden()

Параметры

null|массив $properties необязательно null

Массив свойств для скрытия или null для получения свойств

Возвращаемое значение

массив|Cake\Datasource\EntityTrait
$this

invalid()source public

invalid( string|array|null $field null , mixed|null $value null , boolean $overwrite false )

Отмечает поле как невалидное и непригодное для изменения в сущности.

Полезно для пакетных операций, когда нужно получить исходное значение для сообщения об ошибке после обновления. Это значение не может быть обновлено в сущности и просто копируется в свойство _invalid для отладки или протоколирования.

Устарело

3.5 Используйте getInvalid()/getInvalidField()/setInvalid() вместо этого.

Параметры

строка|массив|null $field необязательно null

Поле для получения невалидного значения или значение для установки.

смешанное|null $value необязательно null

Невалидное значение для установки для $field.

булево $overwrite необязательно false

Заменить ли существующие значения для $field.

Возвращаемое значение

$this|смешанное

isAccessible()source public

isAccessible( string $property )

Проверяет, доступно ли свойство

Пример:

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

Параметры

строка $property

Имя свойства для проверки

Возвращаемое значение

булево

isDirty()source public

isDirty( string $property null )

Проверяет, является ли сущность грязной или грязным ли является определенное свойство.

Параметры

строка $property необязательно null

Свойство для проверки состояния

Возвращаемое значение

булево
Является ли свойство изменённым

isNew()source public

isNew( boolean|null $new null )

Возвращает, сохранена ли сущность в базе данных. Может вернуть null, если нет информации о статусе сущности.

При вызове с булевым значением устанавливает известный статус экземпляра. true означает, что экземпляр ещё не сохранён в базе данных, false — что уже сохранён.

Параметры

булево|null $new необязательно null

true, если известно, что экземпляр ещё не сохранён

Возвращаемое значение

булево
Сохранена ли сущность в базе данных.

jsonSerialize()source public

jsonSerialize( )

Возвращает свойства, которые будут сериализованы как JSON

Возвращаемое значение

массив

offsetExists()source public

offsetExists( mixed $offset )

Реализует isset($entity);

Параметры

mixed $offset

Смещение для проверки.

Возвращает

boolean
Успех

offsetGet()source public

offsetGet( mixed $offset )

Реализует $entity[$offset];

Параметры

mixed $offset

Смещение для получения.

Возвращает

mixed

offsetSet()source public

offsetSet( mixed $offset , mixed $value )

Реализует $entity[$offset] = $value;

Параметры

mixed $offset

Смещение для установки.

mixed $value

Значение для установки.

offsetUnset()source public

offsetUnset( mixed $offset )

Реализует unset($result[$offset]);

Параметры

mixed $offset

Смещение для удаления.

set()source public

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

Устанавливает одно свойство внутри сущности.

Пример:

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

Также возможно массовое назначение нескольких свойств этой сущности одним вызовом, передав хешированный массив как свойства в виде пар свойство => значение

Пример:

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

Иногда удобно обойти функции-сеттеры в этой сущности при назначении свойств. Это можно сделать, отключив опцию setter с помощью параметра $options:

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

Массовое назначение следует рассматривать с осторожностью при приеме пользовательского ввода; по умолчанию сущности будут защищать все поля при массовом назначении свойств. Вы можете отключить защиту для одного вызова с помощью опции guard:

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

Вам не нужно использовать опцию защиты при индивидуальном назначении свойств:

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

Параметры

string|array $property

имя свойства для установки или список свойств с соответствующими значениями

mixed $value необязательно null

Значение для установки свойства или массив, если первый аргумент также является массивом, в этом случае будет обрабатываться как $options

array $options необязательно []

опции, используемые для установки свойства. Допустимые ключи опций — setter и guard

Возвращает

$this

Исключения

InvalidArgumentException

setAccess()source public

setAccess( string|array $property , boolean $set )

Хранит информацию о том, может ли значение свойства быть изменено или установлено в этой сущности. Специальное свойство * также может быть помечено как доступное или защищенное, что означает, что любое другое указанное ранее свойство примет его значение. Например, $entity->setAccess('*', true) означает, что любое не указанное ранее свойство будет по умолчанию доступно.

Вы также можете вызвать этот метод с массивом свойств, в этом случае каждое из них получит значение доступности, указанное во втором аргументе.

Пример:

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

Параметры

string|array $property

одиночное или список свойств, для изменения доступности

boolean $set

true отмечает свойство как доступное, false — как защищенное.

Возвращает

$this

setDirty()source public

setDirty( string $property , boolean $isDirty )

Устанавливает состояние «измененного» для одного свойства.

Параметры

string $property

поле для установки или проверки статуса

boolean $isDirty

true означает, что свойство было изменено, false — нет

Возвращает

$this

setError()source public

setError( string $field , string|array $errors , boolean $overwrite false )

Устанавливает ошибки для отдельного поля

Пример

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

Параметры

string $field

Поле для получения ошибок или массив ошибок для установки.

string|array $errors

Ошибки, которые нужно установить для $field

boolean $overwrite необязательно false

Перезаписывать ли уже существующие ошибки для $field

Возвращает

$this

setErrors()source public

setErrors( array $fields , boolean $overwrite false )

Устанавливает сообщения об ошибках для сущности

Пример

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

Параметры

array $fields

Массив ошибок для установки.

boolean $overwrite необязательно false

Перезаписывать ли уже существующие ошибки для $fields

Возвращает

$this

setHidden()source public

setHidden( array $properties , boolean $merge false )

Устанавливает скрытые свойства.

Параметры

array $properties

Массив свойств, которые нужно скрыть из экспорта массива.

boolean $merge необязательно false

Объединить новые свойства с существующими. По умолчанию false.

Возвращает

$this

setInvalid()source public

setInvalid( array $fields , boolean $overwrite false )

Помечает поля как недопустимые и непригодные для подстановки в сущность.

Это полезно для пакетных операций, когда необходимо получить исходное значение для сообщения об ошибке после подстановки. Это значение не может быть подставлено в сущность и просто копируется в свойство _invalid для отладки или логгирования.

Параметры

array $fields

Значения для установки.

boolean $overwrite необязательно false

Перезаписывать ли уже существующие значения для $field.

Возвращает

$this

setInvalidField()source public

setInvalidField( string $field , mixed $value )

Помечает поле как недопустимое и непригодное для подстановки в сущность.

Параметры

string $field

Значение для установки.

mixed $value

Недопустимое значение, которое нужно установить для $field.

Возвращает

$this

setSource()source public

setSource( string $alias )

Устанавливает псевдоним источника

Параметры

string $alias

псевдоним репозитория

Возвращает

$this

setVirtual()source public

setVirtual( array $properties , boolean $merge false )

Устанавливает виртуальные свойства в этой сущности.

Параметры

array $properties

Массив свойств, которые нужно рассматривать как виртуальные.

boolean $merge необязательно false

Объединить новые свойства с существующими. По умолчанию false.

Возвращает

$this

source()source public

source( string|null $alias null )

Возвращает псевдоним репозитория, из которого была получена эта сущность.

Если вызывается без аргументов, возвращает псевдоним репозитория, из которого была получена эта сущность, если он известен.

Устаревшее

3.4.0 Используйте EntityTrait::getSource() и EntityTrait::setSource()

Параметры

string|null $alias необязательно null

псевдоним репозитория

Возвращает

string|Cake\Datasource\EntityTrait
$this

toArray()source public

toArray( )

Возвращает массив со всеми свойствами, которые были установлены для данного объекта.

Этот метод будет рекурсивно преобразовывать объекты, назначенные свойствам, в массивы тоже.

Возвращает

array

unsetProperty()source public

unsetProperty( string|array $property )

Удаляет свойство или список свойств из этого объекта.

Примеры:

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

Параметры

string|array $property

Свойство для удаления.

Возвращает

$this

virtualProperties()source public

virtualProperties( null|array $properties null )

Получение/установка виртуальных свойств данного объекта.

Если аргумент properties равен null, будут возвращены текущие виртуальные свойства. В противном случае виртуальные свойства будут установлены.

Устарело

3.4.0 Используйте EntityTrait::getVirtual() и EntityTrait::setVirtual()

Параметры

null|array $properties необязательно null

Массив свойств, которые нужно рассматривать как виртуальные, или null для получения свойств

Возвращает

array|Cake\Datasource\EntityTrait
$this

visibleProperties()source public

visibleProperties( )

Получение списка видимых свойств.

Список видимых свойств включает все стандартные свойства плюс виртуальные свойства минус скрытые свойства.

Возвращает

array

Список свойств, которые 'видимые' во всех представлениях.

['*' => true]

[]

[]

[]

[]

[]

true

[]

[]

[]