接口 PluginInterface
插件接口
命名空间: Cake\Core
常量
-
list<string>VALID_HOOKS ¶['bootstrap', 'console', 'middleware', 'routes', 'services', 'events']有效钩子列表。
方法摘要
-
bootstrap() public
加载所有应用程序配置和引导逻辑。
-
console() public
为插件添加控制台命令。
-
disable() public
禁用指定的钩子
-
enable() public
启用指定的钩子
-
getClassPath() public
获取此插件的配置的文件系统路径
-
getConfigPath() public
获取此插件的配置的文件系统路径
-
getName() public
获取此插件的名称。
-
getPath() public
获取此插件的文件系统路径
-
getTemplatePath() public
获取此插件的模板的文件系统路径
-
isEnabled() public
检查指定的钩子是否启用
-
middleware() public
为插件添加中间件。
-
routes() public
为插件添加路由。
-
services() public
向应用程序的容器注册插件服务
方法详情
bootstrap() ¶ public
bootstrap(Cake\Core\PluginApplicationInterface $app): void加载所有应用程序配置和引导逻辑。
此方法的默认实现将包含插件中的config/bootstrap.php（如果存在）。您可以覆盖此方法以替换该行为。
主机应用程序作为参数提供。这允许您加载额外的插件依赖项或附加事件。
参数
-
Cake\Core\PluginApplicationInterface$app 主机应用程序
返回值
voidconsole() ¶ public
console(Cake\Console\CommandCollection $commands): Cake\Console\CommandCollection为插件添加控制台命令。
参数
-
Cake\Console\CommandCollection$commands 要更新的命令集合
返回值
Cake\Console\CommandCollectionmiddleware() ¶ public
middleware(Cake\Http\MiddlewareQueue $middlewareQueue): Cake\Http\MiddlewareQueue为插件添加中间件。
参数
-
Cake\Http\MiddlewareQueue$middlewareQueue 要更新的中间件队列。
返回值
Cake\Http\MiddlewareQueueroutes() ¶ public
routes(Cake\Routing\RouteBuilder $routes): void为插件添加路由。
此方法的默认实现将包含插件中的config/routes.php（如果存在）。您可以覆盖此方法以替换该行为。
参数
-
Cake\Routing\RouteBuilder$routes 要更新的路由构建器。
返回值
voidservices() ¶ public
services(Cake\Core\ContainerInterface $container): void向应用程序的容器注册插件服务
参数
-
Cake\Core\ContainerInterface$container 容器实例。
返回值
void