类 DocumentContext
提供 Elasticsearch 文档的上下文提供程序。
常量
-
list<string>VALID_ATTRIBUTES ¶['length', 'precision', 'comment', 'null', 'default']
属性摘要
-
$_context protected
array上下文数据
-
$_isCollection protected
bool布尔值，用于跟踪实体是否是集合。
-
$_request protected
Cake\Http\ServerRequest请求对象。
-
$_rootName protected
string顶层实体/索引对象的名称。
方法摘要
-
__construct() public
构造函数。
-
_prepare() protected
从上下文中准备一些额外的數據。
-
attributes() public
获取字段名称的其他属性的关联数组。
-
entity() protected
获取最靠近 $path 的实体。
-
error() public
获取给定字段的错误。
-
fieldNames() public
获取此上下文中顶层对象的字段名称。
-
getMaxLength() public
从验证获取字段长度。
-
getPrimaryKey() public
获取上下文中用作主键的字段。
-
getProp() protected
读取属性值或遍历数组/迭代器。
-
getRequiredMessage() public
获取字段的默认“必需”错误消息。
-
getValidator() protected
获取当前索引的验证器。
-
hasError() public
检查字段是否附带错误。
-
isCreate() public
返回此表单是否用于创建操作。
-
isPrimaryKey() public
如果传递的字段名称是此上下文的 Primary Key 的一部分，则返回 True。
-
isRequired() public
检查给定字段是否为“必需”。
-
type() public
获取给定字段名称的抽象字段类型。
-
val() public
获取给定字段的当前值。
方法详情
__construct() ¶ public
__construct(Cake\Http\ServerRequest $request, array $context)构造函数。
参数
-
Cake\Http\ServerRequest$request 请求对象。
-
array$context 上下文信息。
_prepare() ¶ protected
_prepare(): void从上下文中准备一些额外的數據。
如果表选项被提供给构造函数并且它是一个字符串，IndexRegistry 将被用于获取正确的表实例。
如果一个对象作为索引选项提供，它将被按原样使用。
如果没有提供索引选项，索引名称将根据命名约定推断出来。这种推断将适用于许多常见对象，如数组、集合对象和结果集。
返回值
void抛出
RuntimeException当无法定位/推断表对象时。
entity() ¶ protected
entity(array $path): Cake\Datasource\EntityInterface|array|false获取最靠近 $path 的实体。
参数
-
array$path 要获取实体的对象。
返回值
Cake\Datasource\EntityInterface|array|false抛出
RuntimeException当找不到实体时。
getMaxLength() ¶ public
getMaxLength(string $field): int|null从验证获取字段长度。
参数
-
string$field 要检查的字段的点分隔路径。
返回值
int|nullgetProp() ¶ protected
getProp(mixed $target, string $field): mixed读取属性值或遍历数组/迭代器。
参数
-
mixed$target 要从中获取 $field 的实体/数组/集合。
-
string$field 要获取的下一个字段。
返回值
mixedgetRequiredMessage() ¶ public
getRequiredMessage(string $field): string|null获取字段的默认“必需”错误消息。
参数
-
string$field
返回值
string|nullgetValidator() ¶ protected
getValidator(): Cake\Validation\Validator获取当前索引的验证器。
返回值
Cake\Validation\ValidatorisPrimaryKey() ¶ public
isPrimaryKey(string $field): bool如果传递的字段名称是此上下文的 Primary Key 的一部分，则返回 True。
参数
-
string$field
返回值
boolisRequired() ¶ public
isRequired(string $field): bool检查给定字段是否为“必需”。
在此上下文类中，这仅仅由 'required' 数组定义。
参数
-
string$field
返回值
boolval() ¶ public
val(string $field, array<string, mixed> $options = []): mixed获取给定字段的当前值。
实现此方法的类可以选择地具有第二个参数 $options。 $options 数组的有效键是
default: 如果在数据或上下文记录中没有找到值，则返回的默认值。schemaDefault: 布尔值，指示是否应该使用上下文模式的默认值（如果它没有被显式提供）。
参数
-
string$field -
array<string, mixed>$options optional
返回值
mixed