Интерфейс EntityInterface

Описывает методы, которым должен соответствовать любой класс, представляющий хранилище данных.

В версии 4.x следующие методы будут официально добавлены в интерфейс:

Cake\Datasource\EntityInterface реализует ArrayAccess, JsonSerializable

Прямые реализаторы

• Cake\ORM\Entity

Краткое описание магических свойств

• $id public
  mixed
  Псевдоним для часто используемого первичного ключа.

Краткое описание методов

• accessible() public

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

• clean() public

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

• dirty() public

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

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

  Устарело

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

  Параметры

  string|null $property необязательно null

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

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

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

  Возвращает

  boolean
  было ли свойство изменено или нет
  
• errors() public

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

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

  Устарело

  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() public

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

  Параметры

  array $properties

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

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

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

  Возвращает

  array
  
• get() public

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

  Параметры

  string $property

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

  Возвращает

  mixed
  
• has() public

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

  Параметры

  string $property

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

  Возвращает

  boolean
  
• hiddenProperties() public

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

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

  Параметры

  null|array $properties необязательно null

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

  Возвращает

  array|Cake\Datasource\EntityInterface
  
• isNew() public

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

• set() public

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

• toArray() public

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

• unsetProperty() public

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

• virtualProperties() public

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

• visibleProperties() public

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

Подробное описание методов

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

clean( )

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

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

extract( array $properties , boolean $onlyDirty false )

get( string $property )

has( string $property )

hiddenProperties( null|array $properties null )

isNew( boolean|null $new null )

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

toArray( )

unsetProperty( string|array $property )

virtualProperties( null|array $properties null )

visibleProperties( )

Краткое описание магических методов

extractOriginal()source public

extractOriginal( array $properties )

Параметры

array $properties

Возвращает

extractOriginalChanged()source public

extractOriginalChanged( array $properties )

Параметры

array $properties

Возвращает

getError()source public

getError( $field )

Параметры

$field

Возвращает

getErrors()source public

getErrors( )

Возвращает

getHidden()source public

getHidden( )

Возвращает

getSource()source public

getSource( )

Возвращает

getVirtual()source public

getVirtual( )

Возвращает

isAccessible()source public

isAccessible( $property )

Параметры

$property

Возвращает

isDirty()source public

isDirty( $property )

Параметры

$property необязательный

Возвращает

setError()source public

setError( $field , $errors , $overwrite )

Параметры

$field

$errors

$overwrite необязательный

Возвращает

setErrors()source public

setErrors( array $fields , $overwrite )

Параметры

array $fields

$overwrite необязательный

Возвращает

Подробное описание магических свойств