接口 EntityInterface

描述任何表示数据存储的类应遵守的方法。

命名空间： Cake\Datasource

属性摘要

$id public @property

混合

常用主键的别名。

方法摘要

clean() public

将整个实体设置为干净，这意味着它将显示为没有字段被修改或添加。这是对初始对象水合的有效调用。
extract() public

返回一个数组，其中包含此实体中存储的请求字段，并按字段名称索引。
extractOriginal() public

返回一个数组，其中包含此实体中存储的请求原始字段，并按字段名称索引。
extractOriginalChanged() public

仅返回此实体中存储的原始字段的数组，并按字段名称索引。
get() public

按名称返回字段的值。
getAccessible() public

此实体的可访问配置。
getDirty() public

获取脏字段。
getError() public

返回字段的验证错误。
getErrors() public

返回所有验证错误。
getHidden() public

获取隐藏的字段。
getOriginal() public

返回字段的原始值。
getOriginalFields() public

返回原始字段的数组。原始字段是实体初始化的字段。
getOriginalValues() public

获取实体的所有原始值。
getSource() public

返回此实体来源的存储库的别名。
getVirtual() public

获取此实体上的虚拟字段。
getVisible() public

获取可见字段列表。
has() public

返回此实体是否包含名为 $field 的字段。
hasErrors() public

返回此实体是否包含错误。
hasOriginal() public

返回字段是否具有原始值。
hasValue() public @method
isAccessible() public

检查字段是否可访问。
isDirty() public

检查实体是否为脏的，或其单个字段是否为脏的。
isNew() public

返回此实体是否已持久化。
isOriginalField() public

返回字段是否为原始字段。原始字段是实体实例化的字段。
requireFieldPresence() 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

将整个实体设置为干净，这意味着它将显示为没有字段被修改或添加。这是对初始对象水合的有效调用。

返回值

void

extract() ¶ public

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

返回一个数组，其中包含此实体中存储的请求字段，并按字段名称索引。

参数

list<string> $fields: 要返回的字段列表
bool $onlyDirty optional: 仅当字段为脏时才返回请求的字段。

返回值

array<string, mixed>

extractOriginal() ¶ public

extractOriginal(list<string> $fields): array<string, mixed>

返回一个数组，其中包含此实体中存储的请求原始字段，并按字段名称索引。

参数

list<string> $fields: 要返回的字段列表

返回值

array<string, mixed>

extractOriginalChanged() ¶ public

extractOriginalChanged(list<string> $fields): array<string, mixed>

仅返回此实体中存储的原始字段的数组，并按字段名称索引。

参数

list<string> $fields: 要返回的字段列表

返回值

array<string, mixed>

get() ¶ public

get(string $field): mixed

按名称返回字段的值。

参数

string $field: 要检索的字段名称

返回值

混合

getAccessible() ¶ public

getAccessible(): array<bool>

此实体的可访问配置。

返回值

array<bool>

getDirty() ¶ public

getDirty(): list<string>

获取脏字段。

返回值

list<string>

getError() ¶ public

getError(string $field): array

返回字段的验证错误。

参数

string $field: 要获取错误的字段名称

返回值

数组

getErrors() ¶ public

getErrors(): array

返回所有验证错误。

返回值

数组

getHidden() ¶ public

getHidden(): list<string>

获取隐藏的字段。

返回值

list<string>

getOriginal() ¶ public

getOriginal(string $field, bool $allowFallback = true): mixed

返回字段的原始值。

参数

string $field: 字段名称。
bool $allowFallback optional: 是否允许在没有原始值的情况下回退到当前字段值。

返回值

混合

getOriginalFields() ¶ public

getOriginalFields(): list<string>

返回原始字段的数组。原始字段是实体初始化的字段。

返回值

list<string>

getOriginalValues() ¶ public

getOriginalValues(): array

获取实体的所有原始值。

返回值

数组

getSource() ¶ public

getSource(): string

返回此实体来源的存储库的别名。

返回值

字符串

getVirtual() ¶ public

getVirtual(): list<string>

获取此实体上的虚拟字段。

返回值

list<string>

getVisible() ¶ public

getVisible(): list<string>

获取可见字段列表。

返回值

list<string>

has() ¶ public

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

返回此实体是否包含名为 $field 的字段。

即使字段设置为 null，该方法也会返回 true。

参数

list<string>|string $field: 要检查的字段。

返回值

布尔值

hasErrors() ¶ public

hasErrors(bool $includeNested = true): bool

返回此实体是否包含错误。

参数

布尔值 $includeNested 可选: true 将检查嵌套实体的 hasErrors()

返回值

布尔值

hasOriginal() ¶ 公共

hasOriginal(string $field): bool

返回字段是否具有原始值。

参数

string $field

返回值

布尔值

hasValue() ¶ 公共 @method

hasValue(string $field): bool

参数

string $field

返回值

布尔值

isAccessible() ¶ 公共

isAccessible(string $field): bool

检查字段是否可访问。

参数

string $field: 要检查的字段名称

返回值

布尔值

isDirty() ¶ 公共

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

检查实体是否为脏的，或其单个字段是否为脏的。

参数

字符串|空值 $field 可选: 要检查状态的字段。整个实体为空。

返回值

布尔值

isNew() ¶ 公共

isNew(): bool

返回此实体是否已持久化。

返回值

布尔值

isOriginalField() ¶ 公共

isOriginalField(string $name): bool

返回字段是否为原始字段。原始字段是实体实例化的字段。

参数

字符串 $name

返回值

布尔值

requireFieldPresence() ¶ 公共

requireFieldPresence(bool $value = true): void

访问属性时启用/禁用字段存在检查。

如果启用，当尝试访问不存在的属性时会抛出异常。

参数

布尔值 $value 可选: true 启用，false 禁用。

返回值

void

set() ¶ 公共

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

将一个或多个字段设置为指定的值。

参数

数组<字符串, 混合>|字符串 $field: 要设置的字段名称或包含字段名称及其对应值的列表
混合 $value 可选: 要设置的值，或数组，如果第一个参数也是数组，则将其视为 $options
数组<字符串, 混合> $options 可选: 用于设置字段的选项。允许的选项键为 setter 和 guard

返回值

$this

setAccess() ¶ 公共

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

存储此实体中字段值是否可以更改或设置。

参数

list<string>|string $field: 单个或多个字段，更改其可访问性
布尔值 $set: true 将字段标记为可访问，false 将将其标记为受保护。

返回值

$this

setDirty() ¶ 公共

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

设置单个字段的脏状态。

参数

string $field: 要设置或检查状态的字段
布尔值 $isDirty 可选: true 表示字段已更改，false 表示未更改。默认值 true。

返回值

$this

setError() ¶ 公共

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

为单个字段设置错误。

参数

string $field: 要获取错误的字段，或要设置的错误数组。
数组|字符串 $errors: 要为 $field 设置的错误
布尔值 $overwrite 可选: 是否覆盖 $field 的现有错误

返回值

$this

setErrors() ¶ 公共

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

将错误消息设置到实体。

参数

数组 $errors: 要设置的错误数组。
布尔值 $overwrite 可选: 是否覆盖 $fields 的现有错误

返回值

$this

setHidden() ¶ 公共

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

设置隐藏字段。

参数

list<string> $fields: 要从数组导出中隐藏的字段数组。
布尔值 $merge 可选: 将新字段与现有字段合并。默认值为 false。

返回值

$this

setNew() ¶ 公共

setNew(bool $new): $this

设置此实体的状态。

使用 true 表示实体未持久化到数据库，false 表示实体已持久化。

参数

布尔值 $new: 指示此实体是否已持久化。

返回值

$this

setSource() ¶ 公共

setSource(string $alias): $this

设置源别名。

参数

字符串 $alias: 存储库的别名

返回值

$this

setVirtual() ¶ 公共

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

设置此实体上的虚拟字段。

参数

list<string> $fields: 要视为虚拟字段的字段数组。
布尔值 $merge 可选: 将新字段与现有字段合并。默认值为 false。

返回值

$this

toArray() ¶ 公共

toArray(): array<string, mixed>

返回一个包含此实体中设置的所有可见字段的数组。

注意隐藏的字段不可见，并且不会通过 toArray() 输出。

返回值

array<string, mixed>

unset() ¶ 公共

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

从此实体中删除字段或字段列表。

参数

list<string>|string $field: 要取消设置的字段。

返回值

$this

属性详情

`$id` ¶ 公共 @property

常用主键的别名。

类型

混合

命名空间

接口 EntityInterface

属性摘要

方法摘要

clean() public

extract() public

extractOriginal() public

extractOriginalChanged() public

get() public

getAccessible() public

getDirty() public

getError() public

getErrors() public

getHidden() public

getOriginal() public

getOriginalFields() public

getOriginalValues() public

getSource() public

getVirtual() public

getVisible() public

has() public

hasErrors() public

hasOriginal() public

hasValue() public @method

isAccessible() public

isDirty() public

isNew() public

isOriginalField() public

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

返回值

extract() ¶ public

参数

返回值

extractOriginal() ¶ public

参数

返回值

extractOriginalChanged() ¶ public

参数

返回值

get() ¶ public

参数

返回值

getAccessible() ¶ public

返回值

getDirty() ¶ public

返回值

getError() ¶ public

参数

返回值

getErrors() ¶ public

返回值

getHidden() ¶ public

返回值

getOriginal() ¶ public

参数

返回值

getOriginalFields() ¶ public

返回值

getOriginalValues() ¶ public

返回值

getSource() ¶ public

返回值

getVirtual() ¶ public

返回值

getVisible() ¶ public

返回值

has() ¶ public

`$id` ¶ 公共 @property