Интерфейс EntityInterface

accessible()source public deprecated

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

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

Устарело

3.4.0 Используйте setAccess() и isAccessible() вместо этого.

Параметры

string|array $property

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

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

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

Возвращает

Cake\Datasource\EntityInterface|boolean

clean()source public

clean( )

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

dirty()source public deprecated

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

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

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

Устарело

3.4.0 Используйте setDirty() и isDirty() вместо этого.

Параметры

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

поле, для которого нужно установить или проверить состояние

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

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

Возвращает

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

errors()source public deprecated

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

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

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

Устарело

3.4.0 Используйте setErrors() и getErrors() вместо этого.

Параметры

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|array $property )

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

Параметры

string|array $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\Datasource\EntityInterface

virtualProperties()source public

virtualProperties( null|array $properties = null )

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

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

Параметры

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

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

Возвращает

array|Cake\Datasource\EntityInterface

visibleProperties()source public

visibleProperties( )

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

Возвращает

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

extractOriginal( array $properties )

extractOriginalChanged( array $properties )

getError( $field )

getErrors( )

getHidden( )

getSource( )

getVirtual( )

getVisible( )

hasErrors( $includeNested = )

isAccessible( $property )

isDirty( $property = )

setError( $field , $errors , $overwrite = )

setErrors( array $fields , $overwrite = )