Интерфейс EntityInterface

accessible()source public

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

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

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 )

Возвращает true, если в объекте есть свойство с именем $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

Если известно, была ли сущность ранее сохранённой, возвращает true или false. В противном случае 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 )