Трейт EntityTrait

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $property )

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

Параметры

строка $property

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

Возвращает

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

__issetsource public

__isset( string $property )

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

Параметры

строка $property

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

Возвращает

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

См. также

Cake\ORM\Entity::has()

__setsource public

__set( string $property , mixed $value )

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

Параметры

строка $property

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

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

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

__toStringsource public

__toString( )

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

Возвращает

string
строка

__unsetsource public

__unset( string $property )

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

Параметры

строка $property

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

_methodExistssource protected

_methodExists( string $method )

Определяет, существует ли метод в этом классе

Параметры

строка $method

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

Возвращает

boolean
true, если метод существует

_nestedErrorssource protected

_nestedErrors( string $field )

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

Параметры

строка $field

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

Возвращает

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

_readErrorsource protected

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

Считывает ошибку(и) из одного или нескольких объектов.

Параметры

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

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

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

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

Возвращает

array
массив

accessiblesource public

accessible( string|array $property , boolean $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

Параметры

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

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

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

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

Возвращает

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

cleansource public

clean( )

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

dirtysource public

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

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

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

Параметры

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

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

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

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

Возвращает

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

errorssource 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']);

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

Параметры

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

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

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

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

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

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

Возвращает

array|$this
$this

extractsource public

extract( array $properties , boolean $onlyDirty false )

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

Параметры

массив $properties

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

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

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

Возвращает

array
массив

extractOriginalsource public

extractOriginal( array $properties )

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

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

Параметры

массив $properties

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

Возвращает

array
массив

extractOriginalChangedsource public

extractOriginalChanged( array $properties )

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

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

Параметры

массив $properties

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

Возвращает

array
массив

getsource public

get( string $property )

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

Параметры

строка $property

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

Возвращает

mixed
смешанное

Исключения

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

getOriginalsource public

getOriginal( string $property )

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

Параметры

строка $property

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

Возвращает

mixed
смешанное

Исключения

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

hassource 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

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

Параметры

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

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

Возвращает

boolean
логическое

hiddenPropertiessource public

hiddenProperties( null|array $properties null )

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

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

Параметры

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

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

Возвращает

array|$this
$this

isNewsource public

isNew( boolean|null $new null )

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

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

Параметры

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

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

Возвращает

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

jsonSerializesource public

jsonSerialize( )

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

Возвращает

array
массив

offsetExistssource public

offsetExists( mixed $offset )

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

Параметры

смешанное $offset

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

Возвращает

boolean
Успех

offsetGetsource public

offsetGet( mixed $offset )

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

Параметры

смешанное $offset

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

Возвращает

mixed
смешанное

offsetSetsource public

offsetSet( mixed $offset , mixed $value )

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

Параметры

смешанное $offset

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

смешанное $value

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

offsetUnsetsource public

offsetUnset( mixed $offset )

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

Параметры

смешанное $offset

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

setsource 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');

Параметры

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

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

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

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

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

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

Возвращает

mixed
$this

Исключения

InvalidArgumentException
\InvalidArgumentException

sourcesource public

source( string $alias null )

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

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

Параметры

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

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

Возвращает

string|$this
$this

toArraysource public

toArray( )

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

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

Возвращает

array
массив

unsetPropertysource public

unsetProperty( string|array $property )

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

Примеры:

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

Параметры

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

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

Возвращает

mixed
$this

virtualPropertiessource public

virtualProperties( null|array $properties null )

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

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

Параметры

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

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

Возвращает

array|$this
$this

visiblePropertiessource public

visibleProperties( )

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

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

Возвращает

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

['*' => true]

[]

[]

[]

[]

true

[]

[]

[]