Trait EntityTrait

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

__get()source public

__get( string $property )

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

Параметры

string $property

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

Возвращает

mixed

__isset()source public

__isset( string $property )

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

Параметры

string $property

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

Возвращает

boolean

См. также

\Cake\ORM\Entity::has()

__set()source public

__set( string $property , mixed $value )

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

Параметры

string $property

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

mixed $value

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

__toString()source public

__toString( )

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

Возвращает

string

__unset()source public

__unset( string $property )

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

Параметры

string $property

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

_accessor()source protected static

_accessor( string $property , string $type )

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

Параметры

string $property

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

string $type

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

Возвращает

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

_nestedErrors()source protected

_nestedErrors( string $field )

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

Параметры

string $field

поле в этой сущности для проверки ошибок

Возвращает

array
ошибки во вложенной сущности, если есть

_readError()source protected

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

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

Параметры

array|Cake\Datasource\EntityInterface $object

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

string|null $path опционально null

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

Возвращает

array

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

Параметры

string|array $property

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

boolean|null $set опционально null

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

Возвращает

$this|bool

clean()source public

clean( )

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

dirty()source public deprecated

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

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

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

Устарело

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

Параметры

string|null $property опционально null

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

null|boolean $isDirty опционально null

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

Возвращает

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

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->errors('salary');

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

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

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

Устарело

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

Параметры

string|array|null $field опционально null

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

string|array|null $errors опционально null

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

boolean $overwrite опционально false

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

Возвращает

array|Cake\Datasource\EntityTrait
$this

extract()source public

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

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

Параметры

array $properties

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

boolean $onlyDirty опционально false

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

Возвращает

array

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

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

Возвращает

массив

has()source public

has( string|array $property )

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

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

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

array

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_128%%:

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

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

$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 и guard

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

$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

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

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

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

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

$this

setHidden()source public

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

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

Параметры

массив $properties

Массив свойств для скрытия из экспортов массива.

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

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

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

$this

setInvalid()source public

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

Устанавливает поля как недопустимые и не подлежащие патчингу в сущность.

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

Параметры

массив $fields

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

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

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

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

$this

setInvalidField()source public

setInvalidField( string $field , mixed $value )

Устанавливает поле как недопустимое и не подлежащее патчингу в сущность.

Параметры

строка $field

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

смешанное $value

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

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

$this

setSource()source public

setSource( string $alias )

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

Параметры

string $alias

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

Возвращает

$this

setVirtual()source public

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

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

Параметры

array $properties

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

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

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

Возвращает

$this

source()source public deprecated

source( string|null $alias = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

string|Cake\Datasource\EntityTrait
$this

toArray()source public

toArray( )

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

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

Возвращает

array

unsetProperty()source public

unsetProperty( string|array $property )

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

Примеры:

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

Параметры

string|array $property

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

Возвращает

$this

virtualProperties()source public deprecated

virtualProperties( null|array $properties = null )

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

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

Устарело

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

Параметры

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

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

Возвращает

array|Cake\Datasource\EntityTrait
$this

visibleProperties()source public

visibleProperties( )

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

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

Возвращает

array

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

['*' => true]

[]

[]

[]

[]

[]

true

[]

[]

[]