Интерфейс EntityInterface

accessiblesource public

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

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

Параметры

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

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

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

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

Возвращаемое значение

Cake\Datasource\EntityInterface|boolean
\Cake\Datasource\EntityInterface|bool

cleansource public

clean( )

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

dirtysource public

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

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

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

Параметры

строка $property необязательно null

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

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

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

Возвращаемое значение

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

errorssource public

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

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

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

Параметры

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

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

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

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

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

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

Возвращаемое значение

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

extractsource public

extract( array $properties , boolean $onlyDirty false )

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

Параметры

массив $properties

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

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

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

Возвращаемое значение

array
массив

getsource public

get( string $property )

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

Параметры

строка $property

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

Возвращаемое значение

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

hassource public

has( string $property )

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

Параметры

строка $property

Свойство для проверки.

Возвращаемое значение

boolean
булево

hiddenPropertiessource public

hiddenProperties( null|array $properties null )

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

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

Параметры

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

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

Возвращаемое значение

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

isNewsource public

isNew( boolean|null $new null )

Возвращает, был ли этот объект уже сохранён. Этот метод может возвращать null в случае отсутствия предыдущей информации о состоянии этого объекта.

Если вызов осуществляется с булевым значением, этот метод установит состояние этого экземпляра. Использование true означает, что экземпляр не был сохранён в базе данных, false что он уже сохранён.

Параметры

булево|null $new необязательно null

Указывает, был ли этот экземпляр сохранён.

Возвращаемое значение

boolean
Если известно, был ли объект уже сохранён, null в противном случае

setsource public

set( string|array $property , mixed $value null , array $options [] )

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

Параметры

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

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

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

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

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

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

Возвращаемое значение

Cake\Datasource\EntityInterface
\Cake\Datasource\EntityInterface

toArraysource public

toArray( )

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

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

Возвращаемое значение

array
массив

unsetPropertysource public

unsetProperty( string|array $property )

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

Параметры

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

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

Возвращаемое значение

Cake\ORM\
\Cake\ORM\

virtualPropertiessource public

virtualProperties( null|array $properties null )

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

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

Параметры

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

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

Возвращаемое значение

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

visiblePropertiessource public

visibleProperties( )

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

Возвращает

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