类 EmbedOne

表示一个仅包含一个实例的嵌入文档。

命名空间: Cake\ElasticSearch\Association

常量

字符串

ONE_TO_MANY ¶
```
'oneToMany'
```
多个嵌入文档的类型名称。
字符串

ONE_TO_ONE ¶
```
'oneToOne'
```
单个嵌入文档的类型名称。

属性摘要

$alias protected

字符串

此关联使用的别名。
$entityClass protected

字符串

用于嵌入文档的类。
$indexClass protected

字符串

此嵌入链接到的索引类
$property protected

字符串

嵌入文档所在的属性。

方法摘要

__construct() public

构造函数
entityClass() public deprecated

获取/设置此嵌入使用的实体/文档类。
getAlias() public

获取此嵌入的别名。
getEntityClass() public

获取此嵌入使用的实体/文档类。
getIndexClass() public

获取此嵌入使用的索引类。
getProperty() public

获取此嵌入附加到的属性。
hydrate() public

从父文档数据中提取实例。
indexClass() public deprecated

获取/设置此嵌入使用的索引类。
property() public deprecated

获取/设置此嵌入附加到的属性。
setEntityClass() public

设置此嵌入使用的实体/文档类。
setIndexClass() public

设置此嵌入使用的索引类。
setProperty() public

设置此嵌入附加到的属性。
type() public

获取此关联的类型。

方法详细

__construct() ¶ public

__construct(string $alias, array $options = [])

构造函数

参数

字符串 $alias: 嵌入文档的别名/名称。
数组 $options 可选: 嵌入文档的选项。

entityClass() ¶ public

entityClass(string|null $name = null): string

获取/设置此嵌入使用的实体/文档类。

参数

字符串|空 $name 可选: 要设置的类名。

字符串

getAlias() ¶ public

getAlias(): string

获取此嵌入的别名。

字符串

getEntityClass() ¶ public

getEntityClass(): string

获取此嵌入使用的实体/文档类。

字符串

getIndexClass() ¶ public

getIndexClass(): string

获取此嵌入使用的索引类。

字符串

getProperty() ¶ public

getProperty(): string

获取此嵌入附加到的属性。

字符串

hydrate() ¶ public

hydrate(array $data, array $options): Cake\ElasticSearch\Document

从父文档数据中提取实例。

参数

数组 $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: 要使用的类的名称

$this

setIndexClass() ¶ public

setIndexClass(Cake\ElasticSearch\Index|string|null $name): $this

设置此嵌入使用的索引类。

参数

Cake\ElasticSearch\Index|字符串|空 $name: 要设置的类名。

$this

setProperty() ¶ public

setProperty(string|null $name = null): $this

设置此嵌入附加到的属性。

参数

字符串|空 $name 可选: 要设置的属性名称。

$this

type() ¶ public

type(): string

获取此关联的类型。

返回关联类型常量之一。

字符串

属性详细

`$alias` ¶ protected

此关联使用的别名。

类型

字符串

`$entityClass` ¶ protected

用于嵌入文档的类。

类型

字符串

`$indexClass` ¶ protected

此嵌入链接到的索引类

类型

字符串

`$property` ¶ protected

嵌入文档所在的属性。

类型

字符串

命名空间

类 EmbedOne

常量

属性摘要

方法摘要

__construct() public

entityClass() public deprecated

getAlias() public

getEntityClass() public

getIndexClass() public

getProperty() public

hydrate() public

indexClass() public deprecated

property() public deprecated

setEntityClass() public

setIndexClass() public

setProperty() public

type() public

方法详细

__construct() ¶ public

参数

entityClass() ¶ public

参数

返回

getAlias() ¶ public

返回

getEntityClass() ¶ public

返回

getIndexClass() ¶ public

返回

getProperty() ¶ public

返回

hydrate() ¶ public

参数

返回

indexClass() ¶ public

参数

返回

property() ¶ public

参数

返回

setEntityClass() ¶ public

参数

返回

setIndexClass() ¶ public

参数

返回

setProperty() ¶ public

参数

返回

type() ¶ public

返回

属性详细

$alias ¶ protected

类型

$entityClass ¶ protected

类型

$indexClass ¶ protected

类型

$property ¶ protected

类型

`$alias` ¶ protected

`$entityClass` ¶ protected

`$indexClass` ¶ protected

`$property` ¶ protected