Трейт 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\EntityTrait $object , string|null $path null )

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

Параметры

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

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

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

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

Возвращает

массив

accessible()source public

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|bool

clean()source public

clean( )

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

dirty()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

extract()source public

extract( array $properties , boolean $onlyDirty false )

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

Параметры

массив $properties

список свойств, которые должны быть возвращены

логическое $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

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

Возвращает

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

hiddenProperties()source public

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

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.

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

Признак перезаписи уже существующих значений для $field.

Возвращает

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

isAccessible()source public

isAccessible( string $property )

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

Пример:

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

Параметры

строка $property

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

Возвращает

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

isDirty()source public

isDirty( string|null $property null )

Проверяет, является ли объект грязным или грязным ли конкретное свойство.

Параметры

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

Поле для проверки статуса. Null для всего объекта.

Возвращает

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

isNew()source public

isNew( boolean|null $new null )

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

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

Параметры

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

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

Возвращает

логическое значение
Был ли объект сохранён.

jsonSerialize()source public

jsonSerialize( )

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

Возвращает

массив

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 )

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

Параметры

string $property

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

boolean $isDirty

true означает, что свойство было изменено, false - что оно не было изменено

Возвращает

$this

setError()source public

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

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

Пример

// Sets the error messages for a single field
$entity->errors('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->errors(['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 для целей отладки или для возможности его регистрации.

Параметры

array $fields

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

boolean $overwrite optional false

Перезаписывать ли существующие значения для $field.

Возвращает

$this

setInvalidField()source public

setInvalidField( string $field , mixed $value )

Помечает поле как недопустимое и не подлежащее исправлениям в объекте.

Параметры

string $field

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

mixed $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 optional false

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

Возвращает

$this

source()source public

source( string|null $alias null )

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

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

Устарело

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

Параметры

string|null $alias optional 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

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

[]

[]

[]