/
PluginInterface.php
109 lines (97 loc) · 2.57 KB
/
PluginInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright 2005-2011, Cake Software Foundation, Inc. (https://cakefoundation.org)
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.6.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Core;
/**
* Plugin Interface
*/
interface PluginInterface
{
/**
* The list of valid hooks
*/
const VALID_HOOKS = ['routes', 'bootstrap', 'console', 'middleware'];
/**
* Get the name of this plugin.
*
* @return void
*/
public function getName();
/**
* Get the filesystem path to this plugin
*
* @return void
*/
public function getPath();
/**
* Get the filesystem path to configuration for this plugin
*
* @return void
*/
public function getConfigPath();
/**
* Get the filesystem path to configuration for this plugin
*
* @return void
*/
public function getClassPath();
/**
* Load all the application configuration and bootstrap logic.
*
* Override this method to add additional bootstrap logic for your application.
*
* @return void
*/
public function bootstrap();
/**
* Add a plugins console commands
*
* @param \Cake\Console\CommandCollection $commands The command collection to update
* @return \Cake\Console\CommandCollection
*/
public function console($commands);
/**
* Add a plugins middleware
*
* @param \Cake\Http\MiddlewareQueue $middleware The middleware queue to update.
* @return \Cake\Http\MiddlewareQueue
*/
public function middleware($middleware);
/**
* Add a routes
*
* @param \Cake\Routing\RouteBuilder $route The route builder to update.
* @return \Cake\Routing\RouteBuilder
*/
public function routes($routes);
/**
* Disables the named hook
*
* @param string $hook The hook to disable
* @return $this
*/
public function disable($hook);
/**
* Enables the named hook
*
* @param string $hook The hook to disable
* @return $this
*/
public function enable($hook);
/**
* Check if the named hook is enabled
*
* @param string $hook The hook to check
* @return bool
*/
public function isEnabled($hook);
}