Интерфейс 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
Список свойств, которые "видимы" во всех представлениях.