类IndexRegistry
用于 Index 对象的工厂/注册表类。
处理确保每个索引只创建一次,并且正确的连接被注入。
提供与 Cake\ORM\TableRegistry 类似的接口。
命名空间: Cake\ElasticSearch
已弃用: 3.4.3 静态可访问注册表已弃用。建议在 CakePHP 中使用 `IndexLocator` 与 `LocatorTrait` 结合使用。
已弃用: 3.4.3 静态可访问注册表已弃用。建议在 CakePHP 中使用 `IndexLocator` 与 `LocatorTrait` 结合使用。
属性摘要
-
$locator protected static
Cake\ElasticSearch\Datasource\IndexLocator
全局注册表所包装的定位器。
方法摘要
-
clear() public
清除注册表中的配置和实例。
-
exists() public
检查注册表中是否存在实例。
-
get() public
从注册表中获取/创建实例。
-
getLocator() protected static
获取包装的定位器。
-
remove() public
从注册表中删除实例。
-
set() public
设置实例。
-
setFallbackClassName() public static
设置回退类名。
方法详细
get() ¶ public
get(string $alias, array<string, mixed> $options = []): Cake\ElasticSearch\Index
从注册表中获取/创建实例。
在获取实例时,如果实例不存在,则使用提供的别名和选项创建一个新实例。
参数
-
string
$alias 要获取的别名的名称。
-
array<string, mixed>
$options 可选 类型构造函数的配置选项。
返回值
Cake\ElasticSearch\Index
getLocator() ¶ protected static
getLocator(): Cake\ElasticSearch\Datasource\IndexLocator
获取包装的定位器。
返回值
Cake\ElasticSearch\Datasource\IndexLocator
set() ¶ public
set(string $alias, Cake\Datasource\RepositoryInterface $repository): Cake\ElasticSearch\Index
设置实例。
参数
-
string
$alias 要设置的别名。
-
Cake\Datasource\RepositoryInterface
$repository 要设置的类型。
返回值
Cake\ElasticSearch\Index
setFallbackClassName() ¶ public static
setFallbackClassName(string $className): void
设置回退类名。
如果在 `get()` 中使用的别名的具体类未找到,则应该用于创建索引实例的类。默认值为 `Cake\ElasticSearch\Index`。
参数
-
string
$className 回退类名
返回值
void