Trait EntityTrait

__debugInfo()source public

__debugInfo( )

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

Возвращает

массив

__get()source public

__get( string $property )

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

Параметры

строка $property

Имя свойства для доступа

Возвращает

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

__isset()source public

__isset( string $property )

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

Параметры

строка $property

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

Возвращает

логическое значение

См. также

\Cake\ORM\Entity::has()

__set()source public

__set( string $property , mixed $value )

Магический сеттер для добавления или изменения свойства в этом объекте.

Параметры

строка $property

Имя свойства для установки

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

Значение для установки свойства

__toString()source public

__toString( )

Возвращает строковое представление этого объекта в удобочитаемом формате.

Возвращает

строка

__unset()source public

__unset( string $property )

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

Параметры

строка $property

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

_accessor()source protected static

_accessor( string $property , string $type )

Получение имени метода доступа. Методы доступа (доступные или нет) кешируются в $_accessors

Параметры

строка $property

имя поля для получения имени геттера

строка $type

тип доступа ('get' или 'set')

Возвращает

строка
имя метода или пустая строка (метод недоступен)

_nestedErrors()source protected

_nestedErrors( string $field )

Вспомогательный метод для получения ошибок во вложенных объектах.

Параметры

строка $field

поле в этом объекте, для проверки ошибок

Возвращает

массив
ошибки во вложенном объекте, если таковые имеются

_readError()source protected

_readError( array|Cake\Datasource\EntityInterface $object , string|null $path = null )

Чтение ошибки(ок) из одного или нескольких объектов.

Параметры

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

Объект для чтения ошибок.

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

Имя поля для ошибок.

Возвращает

массив

_readHasErrors()source protected

_readHasErrors( mixed $object )

Проверка наличия ошибок для одного или нескольких объектов.

Параметры

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

Объект для проверки ошибок.

Возвращает

логическое значение

accessible()source public deprecated

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

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

Вы также можете вызвать этот метод с массивом свойств, в этом случае каждое из них получит значение доступности, указанное во втором аргументе.

Пример:

$entity->accessible('id', true); // Mark id as not protected
$entity->accessible('author_id', false); // Mark author_id as protected
$entity->accessible(['id', 'user_id'], true); // Mark both properties as accessible
$entity->accessible('*', false); // Mark all properties as protected

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

Пример:

$entity->accessible('id'); // Returns whether it can be set or not

Устарело

3.4.0 Используйте EntityTrait::setAccess() и EntityTrait::isAccessible()

Параметры

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

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

логическое значение|null $set необязательно null

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

Возвращает

$this|логическое значение

clean()source public

clean( )

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

dirty()source public deprecated

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

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

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

Устарело

3.4.0 Используйте EntityTrait::setDirty() и EntityTrait::isDirty()

Параметры

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

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

null|логическое значение $isDirty необязательно null

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

Возвращает

логическое значение
Было ли свойство изменено или нет

errors()source public deprecated

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

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

Пример

// Sets the error messages for a single field
$entity->errors('salary', ['must be numeric', 'must be a positive number']);

// Returns the error messages for a single field
$entity->getErrors('salary');

// Returns all error messages indexed by field name
$entity->getErrors();

// Sets the error messages for multiple fields at once
$entity->getErrors(['salary' => ['message'], 'name' => ['another message']);

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

Устарело

3.4.0 Используйте EntityTrait::setError(), EntityTrait::setErrors(), EntityTrait::getError() и EntityTrait::getErrors()

Параметры

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

поле для получения ошибок или массив ошибок для установки.

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

ошибки для установки для $field

логическое значение $overwrite необязательно false

перезаписывать ли существующие ошибки для $field

Возвращает

массив|Cake\Datasource\EntityTrait
$this

extract()source public

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

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

Параметры

массив $properties

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

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

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

Возвращает

массив

extractOriginal()source public

extractOriginal( array $properties )

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

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

Параметры

массив $properties

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

Возвращает

массив

extractOriginalChanged()source public

extractOriginalChanged( array $properties )

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

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

Параметры

массив $properties

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

Возвращает

массив

get()source public

get( string $property )

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

Параметры

строка $property

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

Возвращает

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

Исключения

InvalidArgumentException
если имя свойства пустое

getDirty()source public

getDirty( )

Получает измененные свойства.

Возвращает

строковый_массив

getError()source public

getError( string $field )

Возвращает ошибки валидации поля

Параметры

строка $field

Имя поля, для которого необходимо получить ошибки

Возвращает

массив

getErrors()source public

getErrors( )

Возвращает все ошибки валидации.

Возвращает

массив

getHidden()source public

getHidden( )

Получает скрытые свойства.

Возвращает

массив

getInvalid()source public

getInvalid( )

Получает список недопустимых полей и их данных для ошибок при валидации/замене

Возвращает

массив

getInvalidField()source public

getInvalidField( string $field )

Получает единственное значение недопустимого поля. Возвращает null, если не задано.

Параметры

строка $field

Имя поля.

Возвращает

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

getOriginal()source public

getOriginal( string $property )

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

Параметры

строка $property

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

Возвращает

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

Исключения

InvalidArgumentException
если имя свойства пустое.

getOriginalValues()source public

getOriginalValues( )

Получает все исходные значения объекта.

Возвращает

массив

getSource()source public

getSource( )

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

Возвращает

строка

getVirtual()source public

getVirtual( )

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

Возвращает

массив

getVisible()source public

getVisible( )

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

Список видимых свойств — это все стандартные свойства плюс виртуальные свойства минус скрытые свойства.

Возвращает

массив

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

has()source public

has( string|array $property )

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

Пример:

$entity = new Entity(['id' => 1, 'name' => null]);
$entity->has('id'); // true
$entity->has('name'); // false
$entity->has('last_name'); // false

Можно проверить несколько свойств, передав массив:

$entity->has(['name', 'last_name']);

Все свойства не должны быть null, чтобы получить истинное значение.

При проверке нескольких свойств. Все свойства не должны быть null, чтобы вернуть true.

Параметры

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

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

Возвращает

boolean

hasErrors()source public

hasErrors( boolean $includeNested = true )

Возвращает true, если у объекта есть ошибки.

Параметры

boolean $includeNested необязательно true

true проверит вложенные объекты на наличие ошибок (hasErrors())

Возвращает

boolean

hasValue()source public

hasValue( string $property )

Проверяет, имеет ли свойство значение.

Этот метод вернёт true для:

• Непустых строк
• Непустых массивов
• Любого объекта
• Целых чисел, даже 0
• Вещественных чисел, даже 0.0

и false во всех других случаях.

Параметры

строка $property

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

Возвращает

boolean

hiddenProperties()source public deprecated

hiddenProperties( null|array $properties = null )

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

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

Устарело

3.4.0 Используйте EntityTrait::setHidden() и EntityTrait::getHidden()

Параметры

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

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

Возвращает

массив|Cake\Datasource\EntityTrait
$this

invalid()source public deprecated

invalid( string|array|null $field = null , mixed|null $value = null , boolean $overwrite = false )

Устанавливает поле как невалидное и не подлежащее исправлению в сущности.

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

Устаревшее

3.5 Используйте getInvalid()/getInvalidField()/setInvalid() вместо этого.

Параметры

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

Поле для получения невалидного значения или значение для установки.

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

Невалидное значение, которое будет установлено для $field.

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

Заменять ли существующие значения для $field.

Возвращает

$this|смешанный

isAccessible()source public

isAccessible( string $property )

Проверяет, доступно ли свойство

Пример:

$entity->isAccessible('id'); // Returns whether it can be set or not

Параметры

строка $property

Имя свойства для проверки

Возвращает

boolean

isDirty()source public

isDirty( string|null $property = null )

Проверяет, является ли сущность грязной или грязным ли является отдельное свойство.

Параметры

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

Поле для проверки состояния. Null для всей сущности.

Возвращает

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

isEmpty()source public

isEmpty( string $property )

Проверяет, что свойство пустое

Это не работает так же, как функция PHP empty(). Метод вернет true для:

• '' (пустая строка)
• null
• []

и false во всех остальных случаях.

Параметры

строка $property

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

Возвращает

boolean

isNew()source public

isNew( boolean|null $new = null )

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

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

Параметры

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

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

Возвращает

boolean
Была ли сущность сохранена.

jsonSerialize()source public

jsonSerialize( )

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

Возвращает

массив

offsetExists()source public

offsetExists( mixed $offset )

Реализует isset($entity);

Параметры

смешанный $offset

Смещение для проверки.

Возвращает

boolean
Успешно

offsetGet()source public

offsetGet( mixed $offset )

Реализует $entity[$offset];

Параметры

смешанный $offset

Смещение для получения.

Возвращает

смешанный

offsetSet()source public

offsetSet( mixed $offset , mixed $value )

Реализует $entity[$offset] = $value;

Параметры

смешанный $offset

Смещение для установки.

смешанный $value

Значение для установки.

offsetUnset()source public

offsetUnset( mixed $offset )

Реализует unset($result[$offset]);

Параметры

смешанный $offset

Смещение для удаления.

set()source public

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

Устанавливает отдельное свойство в этой сущности.

Пример:

$entity->set('name', 'Andrew');

Также можно массово назначить несколько свойств этой сущности одним вызовом, передав массив в виде пар свойство => значение

Пример:

$entity->set(['name' => 'andrew', 'id' => 1]);
echo $entity->name // prints andrew
echo $entity->id // prints 1

Иногда удобно обойти функции-сеттеры в этой сущности при назначении свойств. Этого можно добиться, отключив опцию setter с помощью параметра %%%CODE_BLOCK_133%%:

$entity->set('name', 'Andrew', ['setter' => false]);
$entity->set(['name' => 'Andrew', 'id' => 1], ['setter' => false]);

Массовое назначение следует использовать с осторожностью при приёме пользовательских данных; по умолчанию сущности будут защищать все поля при массовом назначении свойств. Можно отключить защиту для одного вызова set с опцией %%%CODE_BLOCK_135%%:

$entity->set(['name' => 'Andrew', 'id' => 1], ['guard' => true]);

Не нужно использовать опцию защиты при назначении свойств по отдельности:

// No need to use the guard option.
$entity->set('name', 'Andrew');

Параметры

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

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

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

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

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

опции, используемые для установки свойства. Допустимые ключи опций — setter и %%%CODE_BLOCK_142%%

Возвращает

$this

Выбрасывает

InvalidArgumentException

setAccess()source public

setAccess( string|array $property , boolean $set )

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

Также можно вызвать этот метод с массивом свойств, в этом случае каждому из них будет присвоено значение доступности, указанное во втором аргументе.

Пример:

$entity->setAccess('id', true); // Mark id as not protected
$entity->setAccess('author_id', false); // Mark author_id as protected
$entity->setAccess(['id', 'user_id'], true); // Mark both properties as accessible
$entity->setAccess('*', false); // Mark all properties as protected

Параметры

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

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

boolean $set

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

Возвращает

$this

setDirty()source public

setDirty( string $property , boolean $isDirty = true )

Устанавливает состояние грязности отдельного свойства.

Параметры

строка $property

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

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

true означает, что свойство было изменено, false — что не было изменено. По умолчанию — true.

Возвращает

$this

setError()source public

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

Устанавливает ошибки для отдельного поля

Пример

// Sets the error messages for a single field
$entity->setError('salary', ['must be numeric', 'must be a positive number']);

Параметры

строка $field

Поле для получения ошибок или массив ошибок для установки.

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

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

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

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

Возвращает

$this

setErrors()source public

setErrors( array $fields , boolean $overwrite = false )

Устанавливает сообщения об ошибках для сущности

Пример

// Sets the error messages for multiple fields at once
$entity->setErrors(['salary' => ['message'], 'name' => ['another message']]);

Параметры

массив $fields

Массив ошибок для установки.

логическое $overwrite необязательный false

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

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

$this

setHidden()source public

setHidden( array $properties , boolean $merge = false )

Устанавливает скрытые свойства.

Параметры

массив $properties

Массив свойств, которые нужно скрыть от экспорта в виде массива.

логическое $merge необязательный false

Объединить новые свойства с существующими. По умолчанию false.

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

$this

setInvalid()source public

setInvalid( array $fields , boolean $overwrite = false )

Устанавливает поля как невалидные и не подлежащие исправлению в сущности.

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

Параметры

массив $fields

Значения для установки.

логическое $overwrite необязательный false

Заменять ли существующие значения для $field.

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

$this

setInvalidField()source public

setInvalidField( string $field , mixed $value )

Устанавливает поле как невалидное и не подлежащее исправлению в сущности.

Параметры

строка $field

Значение для установки.

смешанное $value

Невалидное значение для установки для $field.

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

$this

setSource()source public

setSource( string $alias )

Устанавливает псевдоним источника

Параметры

строка $alias

псевдоним репозитория

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

$this

setVirtual()source public

setVirtual( array $properties , boolean $merge = false )

Устанавливает виртуальные свойства в этой сущности.

Параметры

массив $properties

Массив свойств, которые следует рассматривать как виртуальные.

логическое $merge необязательный false

Объединить новые свойства с существующими. По умолчанию false.

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

$this

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

source( string|null $alias = null )

Возвращает псевдоним репозитория, из которого пришла эта сущность.

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

Устарело

3.4.0 Используйте EntityTrait::getSource() и EntityTrait::setSource()

Параметры

строка|null $alias необязательный null

псевдоним репозитория

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

строка|Cake\Datasource\EntityTrait
$this

toArray()source public

toArray( )

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

Этот метод также рекурсивно преобразует сущности, назначенные свойствам, в массивы.

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

массив

unsetProperty()source public

unsetProperty( string|array $property )

Удаляет свойство или список свойств из этой сущности

Примеры:

$entity->unsetProperty('name');
$entity->unsetProperty(['name', 'last_name']);

Параметры

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

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

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

$this

virtualProperties()source public устаревший

virtualProperties( null|array $properties = null )

Получить/установить виртуальные свойства этой сущности.

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

Устарело

3.4.0 Используйте EntityTrait::getVirtual() и EntityTrait::setVirtual()

Параметры

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

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

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

массив|Cake\Datasource\EntityTrait
$this

visibleProperties()source public устаревший

visibleProperties( )

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

Список видимых свойств — это все стандартные свойства плюс виртуальные свойства минус скрытые свойства.

Устарело

3.8.0 Используйте getVisible() вместо этого.

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

массив

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

['*' => true]

[]

[]

[]

[]

[]

true

[]

[]

[]