Интерфейс EntityInterface

accessible()source public устаревшее

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

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

Устаревшее

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

Параметры

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

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

логическое|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 )

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

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

Устаревшее

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

Параметры

строка|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 )

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

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

Устаревшее

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

Параметры

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

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

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

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

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

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

Возвращает

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

extract()source public

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

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

Параметры

массив $properties

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

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

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

Возвращает

массив

get()source public

get( string $property )

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

Параметры

строка $property

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

Возвращает

смешанный тип

has()source public

has( string|array $property )

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

Параметры

строка|массив $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, если нет предыдущей информации о статусе сущности.

Если вызывается с boolean значением, этот метод установит статус экземпляра. Использование 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( )

isAccessible( $property )

isDirty( $property = )

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

setErrors( array $fields , $overwrite = )