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

_readHasErrors()source protected

_readHasErrors( mixed $object )

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

Параметры

mixed $object

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

Возвращает

boolean

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

Параметры

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 )

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

Параметры

массив $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( )

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

Возвращает

массив

has()source public

has( string|array $property )

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

Пример:

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

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

Параметры

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

Параметры

string $property

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

Возвращает

boolean

isDirty()source public

isDirty( string|null $property = null )

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

Параметры

string|null $property optional null

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

Возвращает

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

isEmpty()source public

isEmpty( string $property )

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

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

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

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

Параметры

string $property

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

Возвращает

boolean

isNew()source public

isNew( boolean|null $new = null )

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

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

Параметры

boolean|null $new optional null

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

Возвращает

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

jsonSerialize()source public

jsonSerialize( )

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

Возвращает

array

offsetExists()source public

offsetExists( mixed $offset )

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

Параметры

mixed $offset

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

Возвращает

boolean
Успех

offsetGet()source public

offsetGet( mixed $offset )

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

Параметры

mixed $offset

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

Возвращает

mixed

offsetSet()source public

offsetSet( mixed $offset , mixed $value )

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

Параметры

mixed $offset

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

mixed $value

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

offsetUnset()source public

offsetUnset( mixed $offset )

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

Параметры

mixed $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, используя параметр $options:

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

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

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

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

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

Параметры

string|array $property

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

mixed $value optional null

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

array $options optional []

опции для установки свойства. Допустимые ключи опций — 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

Параметры

string|array $property

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

boolean $set

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

Возвращает

$this

setDirty()source public

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

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

Параметры

string $property

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

boolean $isDirty optional 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']);

Параметры

string $field

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

string|array $errors

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

boolean $overwrite optional 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']]);

Параметры

array $fields

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

boolean $overwrite optional false

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

Возвращает

$this

setHidden()source public

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

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

Параметры

array $properties

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

boolean $merge optional 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 )

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

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

Устарело

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

Параметры

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

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

Возвращает

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

visibleProperties()source public

visibleProperties( )

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

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

Возвращает

массив

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

['*' => true]

[]

[]

[]

[]

[]

true

[]

[]

[]