类 Plugin
Plugin 用于加载和定位插件。
它还可以检索插件路径并加载它们的引导文件和路由文件。
属性摘要
-
$plugins protected static
Cake\Core\PluginCollection|null
保存所有已加载插件及其配置的列表
方法摘要
-
classPath() public static
返回包含类文件的插件文件夹的系统路径。
-
configPath() public static
返回包含配置文件的插件文件夹的系统路径。
-
getCollection() public static
获取共享插件集合。
-
isLoaded() public static
如果插件 $plugin 已经加载,则返回 true。
-
loaded() public static
返回已加载插件的列表。
-
path() public static
返回插件的系统路径
-
setCollection() public static
设置共享插件集合。
-
templatePath() public static
返回包含模板文件的插件文件夹的系统路径。
方法详情
classPath() ¶ public static
classPath(string $name): string
返回包含类文件的插件文件夹的系统路径。
参数
-
string
$name 以驼峰式命名法表示的插件名称。
返回值
string
抛出
Cake\Core\Exception\MissingPluginException
如果插件未加载。
configPath() ¶ public static
configPath(string $name): string
返回包含配置文件的插件文件夹的系统路径。
参数
-
string
$name 以驼峰式命名法表示的插件名称。
返回值
string
抛出
Cake\Core\Exception\MissingPluginException
如果插件未加载。
getCollection() ¶ public static
getCollection(): Cake\Core\PluginCollection
获取共享插件集合。
此方法通常不应在应用程序运行时使用,因为插件应该在应用程序启动时设置。
返回值
Cake\Core\PluginCollection
isLoaded() ¶ public static
isLoaded(string $plugin): bool
如果插件 $plugin 已经加载,则返回 true。
参数
-
string
$plugin 插件名称。
返回值
bool
path() ¶ public static
path(string $name): string
返回插件的系统路径
参数
-
string
$name 以驼峰式命名法表示的插件名称
返回值
string
抛出
Cake\Core\Exception\MissingPluginException
如果找不到插件文件夹或插件未加载。
setCollection() ¶ public static
setCollection(Cake\Core\PluginCollection $collection): void
设置共享插件集合。
参数
-
Cake\Core\PluginCollection
$collection
返回值
void
templatePath() ¶ public static
templatePath(string $name): string
返回包含模板文件的插件文件夹的系统路径。
参数
-
string
$name 以驼峰式命名法表示的插件名称。
返回值
string
抛出
Cake\Core\Exception\MissingPluginException
如果插件未加载。