类 IndexLocator
与 Datasource FactoryLocator 兼容的定位器实现。
属性摘要
-
布尔值如果找不到索引类，是否应使用回退类。
-
字符串要使用的回退类
-
$instances 受保护
array<string,Cake\Datasource\RepositoryInterface>属于注册表的实例。
-
$options 受保护
array<string, array>包含传递给 get() 方法的选项列表。
方法摘要
-
allowFallbackClass() 公共
设置是否应使用回退类。
-
clear() 公共
清除注册表中的配置和实例。
-
createInstance() 受保护
创建给定类名的实例。
-
exists() 公共
检查注册表中是否存在实例。
-
get() 公共
从注册表中获取存储库实例。
-
remove() 公共
从注册表中删除存储库实例。
-
set() 公共
设置存储库实例。
-
setFallbackClassName() 公共
设置回退类名。
方法详情
allowFallbackClass() ¶ 公共
allowFallbackClass(bool $allow): $this设置是否应使用回退类。
控制是否应使用回退类来创建索引实例，如果在get()中使用的别名的具体类未找到。
参数
-
布尔值$allow 启用或禁用回退的标志
返回值
$thiscreateInstance() ¶ 受保护
createInstance(string $alias, array<string, mixed> $options): Cake\Datasource\RepositoryInterface创建给定类名的实例。
参数
-
字符串$alias -
array<string, mixed>$options
返回值
Cake\Datasource\RepositoryInterfaceget() ¶ 公共
get(string $alias, array<string, mixed> $options = []): Cake\Datasource\RepositoryInterface从注册表中获取存储库实例。
参数
-
字符串$alias 您要获取的别名。
-
array<string, mixed>$options 可选 要使用这些选项构建表。
返回值
Cake\Datasource\RepositoryInterface抛出
Cake\Core\Exception\CakeException尝试获取其实例已使用不同选项创建的别名时。
set() ¶ 公共
set(string $alias, Cake\Datasource\RepositoryInterface $repository): Cake\Datasource\RepositoryInterface设置存储库实例。
参数
-
字符串$alias -
Cake\Datasource\RepositoryInterface$repository
返回值
Cake\Datasource\RepositoryInterfacesetFallbackClassName() ¶ 公共
setFallbackClassName(string $className): $this设置回退类名。
如果在get()中使用的别名的具体类未找到，则应用来创建表实例的类。默认为Cake\Elasticsearch\Index。
参数
-
字符串$className 回退类名
返回值
$this