Интерфейс EntityInterface

accessible()source public

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

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

Параметры

string|array $property

Либо отдельное, либо список свойств, чтобы изменить их доступность.

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

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

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

Cake\Datasource\EntityInterface|boolean

clean()source public

clean( )

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

dirty()source public

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

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

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

Параметры

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 )

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

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

Параметры

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

Поле для получения ошибок.

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

Ошибки для установки для $field

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

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

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

array|Cake\Datasource\EntityInterface

extract()source public

extract( array $properties , boolean $onlyDirty false )

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

Параметры

array $properties

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

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

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

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

array

get()source public

get( string $property )

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

Параметры

string $property

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

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

mixed

has()source public

has( string $property )

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

Параметры

string $property

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

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

boolean

hiddenProperties()source public

hiddenProperties( null|array $properties null )

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

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

Параметры

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

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

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

array|Cake\Datasource\EntityInterface

isNew()source public

isNew( boolean|null $new null )

Возвращает, была ли сущность уже сохранённой. Данный метод может возвращать null в случае отсутствия предыдущей информации о статусе сущности.

Если вызван с булевым значением, этот метод установит статус данного экземпляра. Использование true означает, что экземпляр не был сохранён в базе данных, false что он уже был сохранён.

Параметры

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

Указывает, был ли этот экземпляр сохранён.

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

boolean

Если известно, была ли сущность уже сохранена, null в противном случае

set()source public

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

Устанавливает одно или несколько свойств указанному значению

Параметры

string|array $property

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

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

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

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

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

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

Cake\Datasource\EntityInterface

toArray()source public

toArray( )

Возвращает массив со всеми видимыми свойствами, установленными в этой сущности.

Примечание скрытые свойства не видны и не будут выведены методом toArray().

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

array

unsetProperty()source public

unsetProperty( string|array $property )

Удаляет свойство или список свойств из этой сущности

Параметры

string|array $property

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

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

Cake\ORM\

virtualProperties()source public

virtualProperties( null|array $properties null )

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

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

Параметры

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

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

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

array|Cake\Datasource\EntityInterface

visibleProperties()source public

visibleProperties( )

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

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

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