类 Embedded
表示一个嵌入式文档。
为各种嵌入式文档类型子类化。
属性摘要
-
$alias protected
字符串此关联使用的别名。
-
$entityClass protected
字符串用于嵌入文档的类。
-
$indexClass protected
字符串此嵌入链接到的索引类
-
$property protected
字符串嵌入文档所在的属性。
方法摘要
-
__construct() public
构造函数
-
entityClass() public deprecated
获取/设置用于此嵌入的实体/文档类。
-
getAlias() public
获取此嵌入的别名。
-
getEntityClass() public
获取用于此嵌入的实体/文档类。
-
getIndexClass() public
获取用于此嵌入的索引类。
-
getProperty() public
获取此嵌入附加到的属性。
-
hydrate() abstract public
从父文档数据中提取实例。
-
indexClass() public deprecated
获取/设置用于此嵌入的索引类。
-
property() public deprecated
获取/设置此嵌入附加到的属性。
-
setEntityClass() public
设置用于此嵌入的实体/文档类。
-
setIndexClass() public
设置用于此嵌入的索引类。
-
setProperty() public
设置此嵌入附加到的属性。
-
type() abstract public
获取此关联的类型。
方法详细说明
__construct() ¶ public
__construct(string $alias, array $options = [])构造函数
参数
-
字符串$alias 嵌入文档的别名/名称。
-
数组$options 可选 嵌入文档的选项。
entityClass() ¶ public
entityClass(string|null $name = null): string获取/设置用于此嵌入的实体/文档类。
参数
-
字符串|空值$name 可选 要设置的类名。
返回值
字符串hydrate() ¶ abstract public
hydrate(array $data, array $options): Cake\ElasticSearch\Document|array从父文档数据中提取实例。
参数
-
数组$data 用于嵌入文档的数据。
-
数组$options 在新建文档中使用的选项。
返回值
Cake\ElasticSearch\Document|数组indexClass() ¶ public
indexClass(Cake\ElasticSearch\Index|string|null $name = null): string获取/设置用于此嵌入的索引类。
参数
-
Cake\ElasticSearch\Index|字符串|空值$name 可选 要设置的类名。
返回值
字符串property() ¶ public
property(string|null $name = null): string获取/设置此嵌入附加到的属性。
参数
-
字符串|空值$name 可选 要设置的属性名。
返回值
字符串setEntityClass() ¶ public
setEntityClass(string $name): $this设置用于此嵌入的实体/文档类。
参数
-
字符串$name 要使用的类的名称
返回值
thissetIndexClass() ¶ public
setIndexClass(Cake\ElasticSearch\Index|string|null $name): $this设置用于此嵌入的索引类。
参数
-
Cake\ElasticSearch\Index|字符串|空值$name 要设置的类名。
返回值
thissetProperty() ¶ public
setProperty(string|null $name = null): $this设置此嵌入附加到的属性。
参数
-
字符串|空值$name 可选 要设置的属性名。
返回值
this