Интерфейс EntityInterface

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

Пространство имен: Cake\Datasource

Краткое описание свойств

$id public @property

mixed

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

Краткое описание методов

clean() public

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

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

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

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

Возвращает значение поля по имени.
getAccessible() public @method

Конфигурация доступа для данного объекта.
getDirty() public

Получает измененные поля.
getError() public

Возвращает ошибки валидации поля.
getErrors() public

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

Получает скрытые поля.
getOriginal() public

Возвращает исходное значение поля.
getOriginalValues() public

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

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

Получает виртуальные поля данного объекта.
getVisible() public

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

Возвращает, содержит ли этот объект поле с именем $field и не установлено ли оно в null.
hasErrors() public

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

Проверяет, доступно ли поле.
isDirty() public

Проверяет, является ли объект изменённым или является ли изменённым отдельное поле.
isNew() public

Возвращает, был ли этот объект уже сохранён.
set() public

Устанавливает одно или несколько полей до указанного значения.
setAccess() public

Сохраняет, можно ли изменить или установить значение поля в этом объекте.
setDirty() public

Устанавливает статус изменения отдельного поля.
setError() public

Устанавливает ошибки для отдельного поля.
setErrors() public

Устанавливает сообщения об ошибках для объекта.
setHidden() public

Устанавливает скрытые поля.
setNew() public

Устанавливает статус объекта.
setSource() public

Устанавливает псевдоним источника.
setVirtual() public

Устанавливает виртуальные поля данного объекта.
toArray() public

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

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

Подробное описание методов

clean() public

clean(): void

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

Returns

void

extract() public

extract(array<string> $fields, bool $onlyDirty = false): array

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

Parameters

array<string> $fields: список полей, которые необходимо вернуть
bool $onlyDirty optional: Возвращает запрошенное поле только в том случае, если оно изменено

Returns

array

extractOriginal() public

extractOriginal(array<string> $fields): array

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

Parameters

array<string> $fields: Список полей, которые необходимо вернуть

Returns

array

extractOriginalChanged() public

extractOriginalChanged(array<string> $fields): array

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

Parameters

array<string> $fields: Список полей, которые необходимо вернуть

Returns

array

get() public

get(string $field): mixed

Возвращает значение поля по имени

Parameters

string $field: имя поля для получения

Returns

mixed

getAccessible() public @method

getAccessible(): bool[]

Доступная конфигурация для этого объекта.

Returns

bool[]

getDirty() public

getDirty(): array<string>

Получает измененные поля.

Returns

array<string>

getError() public

getError(string $field): array

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

Parameters

string $field: Имя поля, для которого нужно получить ошибки

Returns

array

getErrors() public

getErrors(): array

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

Returns

array

getHidden() public

getHidden(): array<string>

Получает скрытые поля.

Returns

array<string>

getOriginal() public

getOriginal(string $field): mixed

Возвращает исходное значение поля.

Parameters

string $field: Имя поля.

Returns

mixed

getOriginalValues() public

getOriginalValues(): array

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

Returns

array

getSource() public

getSource(): string

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

Returns

string

getVirtual() public

getVirtual(): array<string>

Получает виртуальные поля в этом объекте.

Returns

array<string>

getVisible() public

getVisible(): array<string>

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

Returns

array<string>

has() public

has(array<string>|string $field): bool

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

Parameters

array<string>|string $field: Поле для проверки.

Returns

bool

hasErrors() public

hasErrors(bool $includeNested = true): bool

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

Parameters

bool $includeNested optional: true будет проверять вложенные объекты на наличие hasErrors()

Returns

bool

isAccessible() public

isAccessible(string $field): bool

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

Parameters

string $field: Имя поля для проверки

Returns

bool

isDirty() public

isDirty(string|null $field = null): bool

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

Parameters

string|null $field optional: Поле, для которого нужно проверить статус. Null для всего объекта.

Returns

bool

isNew() public

isNew(): bool

Возвращает, был ли уже сохранен этот объект.

Returns

bool

set() public

set(array<string, mixed>|string $field, mixed $value = null, array<string, mixed> $options = []): $this

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

Parameters

array<string, mixed>|string $field: имя поля для установки или список полей с их соответствующими значениями
mixed $value optional: Значение для установки в поле или массив, если первый аргумент также является массивом, в этом случае он будет рассматриваться как $options
array<string, mixed> $options optional: Параметры, которые будут использоваться для установки поля. Допустимые ключи параметров: setter и guard

Returns

$this

setAccess() public

setAccess(array<string>|string $field, bool $set): $this

Хранит, можно ли изменить или установить значение поля в этом объекте.

Parameters

array<string>|string $field: одно или несколько полей для изменения их доступности
bool $set: true помечает поле как доступное, false пометит его как защищенное.

Returns

$this

setDirty() public

setDirty(string $field, bool $isDirty = true): $this

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

Parameters

string $field: поле для установки или проверки статуса
bool $isDirty optional: true означает, что поле было изменено, false означает, что оно не было изменено. По умолчанию true.

Returns

$this

setError() public

setError(string $field, array|string $errors, bool $overwrite = false): $this

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

Параметры

string $field: Поле, для которого нужно получить ошибки, или массив ошибок для установки.
array|string $errors: Ошибки, которые необходимо установить для поля $field
bool $overwrite optional: Заменить ли существующие ошибки для поля $field

Возвращает

$this

setErrors() public

setErrors(array $errors, bool $overwrite = false): $this

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

Параметры

array $errors: Массив ошибок для установки.
bool $overwrite optional: Заменить ли существующие ошибки для полей $fields

Возвращает

$this

setHidden() public

setHidden(array<string> $fields, bool $merge = false): $this

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

Параметры

array<string> $fields: Массив полей, которые нужно скрыть при экспорте в массив.
bool $merge optional: Объединить новые поля с существующими. По умолчанию false.

Возвращает

$this

setNew() public

setNew(bool $new): $this

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

Использование true означает, что сущность не была сохранена в базе данных, false указывает, что сущность была сохранена.

Параметры

bool $new: Указывает, была ли эта сущность сохранена.

Возвращает

$this

setSource() public

setSource(string $alias): $this

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

Параметры

string $alias: Псевдоним репозитория

Возвращает

$this

setVirtual() public

setVirtual(array<string> $fields, bool $merge = false): $this

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

Параметры

array<string> $fields: Массив полей, которые нужно рассматривать как виртуальные.
bool $merge optional: Объединить новые поля с существующими. По умолчанию false.

Возвращает

$this

toArray() public

toArray(): array

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

Примечание скрытые поля не видны и не будут выведены методом toArray().

Возвращает

array

unset() public

unset(array<string>|string $field): $this

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

Параметры

array<string>|string $field: Поле, которое нужно удалить.

Возвращает

$this

Подробное описание свойств

`$id` public @property

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

Тип

mixed

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/interface-Cake.Datasource.EntityInterface.html