类 EagerLoadable

表示要为特定查询急切加载的关联树中的单个级别。这包含从关联及其所有子级级别从数据库中获取结果所需的所有信息。

命名空间： Cake\ORM

属性摘要

$_aliasPath protected

string

一个点分隔的字符串，表示要遵循的关联路径以获取此级别。
$_associations protected

arrayCake\ORM\EagerLoadable>

要从此级别加载的其他关联的列表。
$_canBeJoined protected

bool

此级别是否可以使用联接获取。
$_config protected

array<string, mixed>

要传递给关联对象以加载记录的选项列表。
$_forMatching protected

bool|null

此级别是否用于“匹配”获取操作
$_instance protected

Cake\ORM\Association|null

用于加载记录的关联类实例。
$_name protected

string

要加载的关联的名称。
$_propertyPath protected

string|null

一个点分隔的字符串，表示应将此级别结果放置在其中的实体属性路径。
$_targetProperty protected

string|null

关联结果应嵌套在其中的属性名称。

方法摘要

__clone() public

处理克隆急切加载。
__construct() public

构造函数。$config 参数接受以下数组键
addAssociation() public

添加要从此级别加载的新关联。
aliasPath() public

获取一个点分隔的字符串，表示要遵循的关联路径以获取此级别。
asContainArray() public

返回此对象的表示形式，可以将其传递给 Cake\ORM\EagerLoader::contain()
associations() public

返回用于加载记录的关联类实例。
canBeJoined() public

获取此级别是否可以使用联接获取。
forMatching() public

获取此级别是否用于“匹配”获取操作。
getConfig() public

获取要传递给关联对象以加载记录的选项列表。
instance() public

获取用于加载记录的关联类实例。
propertyPath() public

获取一个点分隔的字符串，表示应将此级别结果放置在其中的实体属性路径。
setCanBeJoined() public

设置此级别是否可以使用联接获取。
setConfig() public

设置要传递给关联对象以加载记录的选项列表。
targetProperty() public

关联结果应嵌套在其中的属性名称。

方法详细信息

__clone() ¶ public

__clone(): void

处理克隆急切加载。

void

__construct() ¶ public

__construct(string $name, array<string, mixed> $config = [])

构造函数。$config 参数接受以下数组键

associations
instance
config
canBeJoined
aliasPath
propertyPath
forMatching
targetProperty

键映射到此类中的可设置属性。

参数

string $name: 关联名称。
array<string, mixed> $config optional: 要设置的属性列表。

addAssociation() ¶ public

addAssociation(string $name, Cake\ORM\EagerLoadable $association): void

添加要从此级别加载的新关联。

参数

string $name: 关联名称。
Cake\ORM\EagerLoadable $association: 要加载的关联。

void

aliasPath() ¶ public

aliasPath(): string

获取一个点分隔的字符串，表示要遵循的关联路径以获取此级别。

string

asContainArray() ¶ public

asContainArray(): array<string, array>

返回此对象的表示形式，可以将其传递给 Cake\ORM\EagerLoader::contain()

array<string, array>

associations() ¶ public

associations(): arrayCake\ORM\EagerLoadable>

返回用于加载记录的关联类实例。

arrayCake\ORM\EagerLoadable>

canBeJoined() ¶ public

canBeJoined(): bool

获取此级别是否可以使用联接获取。

bool

forMatching() ¶ public

forMatching(): bool|null

获取此级别是否用于“匹配”获取操作。

bool|null

getConfig() ¶ public

getConfig(): array<string, mixed>

获取要传递给关联对象以加载记录的选项列表。

array<string, mixed>

instance() ¶ public

instance(): Cake\ORM\Association

获取用于加载记录的关联类实例。

Cake\ORM\Association

抛出

Cake\Database\Exception\DatabaseException

propertyPath() ¶ public

propertyPath(): string|null

获取一个点分隔的字符串，表示应将此级别结果放置在其中的实体属性路径。

例如，在以下嵌套属性中

 $article->author->company->country

country 的属性路径将是 author.company

string|null

setCanBeJoined() ¶ public

setCanBeJoined(bool $possible): $this

设置此级别是否可以使用联接获取。

参数

bool $possible: 要设置的值。

$this

setConfig() ¶ public

setConfig(array<string, mixed> $config): $this

设置要传递给关联对象以加载记录的选项列表。

参数

array<string, mixed> $config: 要设置的值。

$this

targetProperty() ¶ public

targetProperty(): string|null

关联结果应嵌套在其中的属性名称。

例如，在以下嵌套属性中

 $article->author->company->country

country 的目标属性将仅仅是 country

string|null

属性详细信息

`$_aliasPath` ¶ protected

一个点分隔的字符串，表示要遵循的关联路径以获取此级别。

类型

string

`$_associations` ¶ protected

要从此级别加载的其他关联的列表。

类型

arrayCake\ORM\EagerLoadable>

`$_canBeJoined` ¶ protected

此级别是否可以使用联接获取。

类型

bool

`$_config` ¶ protected

要传递给关联对象以加载记录的选项列表。

类型

array<string, mixed>

`$_forMatching` ¶ protected

此级别是否用于“匹配”获取操作

类型

bool|null

`$_instance` ¶ protected

用于加载记录的关联类实例。

类型

Cake\ORM\Association|null

`$_name` ¶ protected

要加载的关联的名称。

类型

string

`$_propertyPath` ¶ protected

一个点分隔的字符串，表示应将此级别结果放置在其中的实体属性路径。

例如，在以下嵌套属性中

 $article->author->company->country

country 的属性路径将是 author.company

类型

string|null

`$_targetProperty` ¶ 受保护

关联结果应嵌套在其中的属性名称。

例如，在以下嵌套属性中

 $article->author->company->country

country 的目标属性将仅仅是 country

类型

string|null

命名空间

类 EagerLoadable

属性摘要

方法摘要

__clone() public

__construct() public

addAssociation() public

aliasPath() public

asContainArray() public

associations() public

canBeJoined() public

forMatching() public

getConfig() public

instance() public

propertyPath() public

setCanBeJoined() public

setConfig() public

targetProperty() public

方法详细信息

__clone() ¶ public

返回

__construct() ¶ public

参数

addAssociation() ¶ public

参数

返回

aliasPath() ¶ public

返回

asContainArray() ¶ public

返回

associations() ¶ public

返回

canBeJoined() ¶ public

返回

forMatching() ¶ public

返回

getConfig() ¶ public

返回

instance() ¶ public

返回

抛出

propertyPath() ¶ public

返回

setCanBeJoined() ¶ public

参数

返回

setConfig() ¶ public

参数

返回

targetProperty() ¶ public

返回

属性详细信息

$_aliasPath ¶ protected

类型

$_associations ¶ protected

类型

$_canBeJoined ¶ protected

类型

$_config ¶ protected

类型

$_forMatching ¶ protected

类型

$_instance ¶ protected

类型

$_name ¶ protected

类型

$_propertyPath ¶ protected

类型

$_targetProperty ¶ 受保护

类型

`$_aliasPath` ¶ protected

`$_associations` ¶ protected

`$_canBeJoined` ¶ protected

`$_config` ¶ protected

`$_forMatching` ¶ protected

`$_instance` ¶ protected

`$_name` ¶ protected

`$_propertyPath` ¶ protected

`$_targetProperty` ¶ 受保护