Интерфейс EntityInterface

accessible()source public deprecated

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

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

Deprecated

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

Параметры

string|array $property

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

boolean|null $set optional null

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

Возвращает

Cake\Datasource\EntityInterface|boolean

clean()source public

clean( )

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

dirty()source public deprecated

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

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

При вызове без аргументов вернет true, если есть измененные свойства, и false, если нет.

Deprecated

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

Параметры

string|null $property optional null

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

null|boolean $isDirty optional null

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

Возвращает

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

errors()source public deprecated

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

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

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

Deprecated

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

Параметры

string|array|null $field optional null

Поле, для которого получать ошибки.

string|array|null $errors optional null

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

boolean $overwrite optional false

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

Возвращает

array|Cake\Datasource\EntityInterface

extract()source public

extract( array $properties , boolean $onlyDirty = false )

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

Параметры

array $properties

список свойств для возврата

boolean $onlyDirty optional false

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

Возвращает

array

get()source public

get( string $property )

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

Параметры

string $property

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

Возвращает

mixed

has()source public

has( string|array $property )

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

Параметры

string|array $property

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

Возвращает

boolean

hiddenProperties()source public

hiddenProperties( null|array $properties = null )

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

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

Параметры

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

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

Возвращает

массив|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 = [] )

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

Параметры

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

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

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

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

массив $options необязательно []

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

Возвращает

Cake\Datasource\EntityInterface

toArray()source public

toArray( )

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

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

Возвращает

массив

unsetProperty()source public

unsetProperty( string|array $property )

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

Параметры

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

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

Возвращает

Cake\Datasource\EntityInterface

virtualProperties()source public

virtualProperties( null|array $properties = null )

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

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

Параметры

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

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

Возвращает

массив|Cake\Datasource\EntityInterface

visibleProperties()source public

visibleProperties( )

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

Возвращает

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

extractOriginal( array $properties )

extractOriginalChanged( array $properties )

getError( $field )

getErrors( )

getHidden( )

getSource( )

getVirtual( )

hasErrors( $includeNested = )

isAccessible( $property )

isDirty( $property = )

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

setErrors( array $fields , $overwrite = )