Интерфейс 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, независимо от того, пусто оно или нет.
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

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

END_OF_DOCUMENT_MARKER

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

clean() public

clean(): void

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

Возвращает

void

extract() public

extract(string[] $fields, bool $onlyDirty = false): array

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

Параметры

string[] $fields: список полей, которые нужно вернуть
bool $onlyDirty optional: Возвращать запрошенное поле только если оно загрязнено

Возвращает

array

extractOriginal() public

extractOriginal(string[] $fields): array

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

Параметры

string[] $fields: список полей, которые нужно вернуть

Возвращает

array

extractOriginalChanged() public

extractOriginalChanged(string[] $fields): array

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

Параметры

string[] $fields: Список полей, которые нужно вернуть

Возвращает

array

get() public

get(string $field): mixed

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

Параметры

string $field: имя поля, которое нужно получить

Возвращает

mixed

getAccessible() public @method

getAccessible(): bool[]

Конфигурация доступа для этой сущности.

Возвращает

bool[]

getDirty() public

getDirty(): string[]

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

Возвращает

string[]

getError() public

getError(string $field): array

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

Параметры

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

Возвращает

array

getErrors() public

getErrors(): array

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

Возвращает

array

getHidden() public

getHidden(): string[]

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

Возвращает

string[]

getOriginal() public

getOriginal(string $field): mixed

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

Параметры

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

Возвращает

mixed

getOriginalValues() public

getOriginalValues(): array

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

Возвращает

array

getSource() public

getSource(): string

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

Возвращает

string

getVirtual() public

getVirtual(): string[]

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

Возвращает

string[]

getVisible() public

getVisible(): string[]

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

Возвращает

string[]

has() public

has(string|string[] $field): bool

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

Параметры

string|string[] $field: Проверяемое поле.

Возвращает

bool

hasErrors() public

hasErrors(bool $includeNested = true): bool

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

Параметры

bool $includeNested optional: true проверяет вложенные сущности на наличие ошибок.

Возвращает

bool

isAccessible() public

isAccessible(string $field): bool

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

Параметры

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

Возвращает

bool

isDirty() public

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

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

Параметры

string|null $field optional: Поле для проверки состояния. Null для всей сущности.

Возвращает

bool

isNew() public

isNew(): bool

Возвращает true, если эта сущность уже сохранялась.

Возвращает

bool

set() public

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

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

Параметры

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

Возвращает

$this

setAccess() public

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

Записывает, можно ли изменить или установить значение поля в этой сущности.

Параметры

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

Возвращает

$this

setDirty() public

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

Устанавливает состояние поля как изменённое.

Параметры

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

Возвращает

$this

setError() public

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

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

Параметры

string $field: Поле, для которого нужно получить ошибки, или массив ошибок для установки.
string|array $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(string[] $fields, bool $merge = false): $this

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

Параметры

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(string[] $fields, bool $merge = false): $this

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

Параметры

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

Возвращает

$this

toArray() public

toArray(): array

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

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

Возвращает

array

unset() public

unset(string|string[] $field): $this

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

Параметры

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.2/interface-Cake.Datasource.EntityInterface.html