adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-15 03:18:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update doc blocks for CakePlugin::load().

Browse source 
Refs #5665
This commit is contained in:
mark_story 2015-06-11 22:17:18 -04:00
parent 6d60e6a4db
commit 56143c663e
1 changed files with 25 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
lib/Cake/Core/CakePlugin.php
View file

@ -37,14 +37,29 @@ class CakePlugin {
* *
* Examples: * Examples:
* *
* `CakePlugin::load('DebugKit')` will load the DebugKit plugin and will not load any bootstrap nor route files * `CakePlugin::load('DebugKit')`
* `CakePlugin::load('DebugKit', array('bootstrap' => true, 'routes' => true))` will load the bootstrap.php and routes.php files
* `CakePlugin::load('DebugKit', array('bootstrap' => false, 'routes' => true))` will load routes.php file but not bootstrap.php
* `CakePlugin::load('DebugKit', array('bootstrap' => array('config1', 'config2')))` will load config1.php and config2.php files
* `CakePlugin::load('DebugKit', array('bootstrap' => 'aCallableMethod'))` will run the aCallableMethod function to initialize it
* *
* Bootstrap initialization functions can be expressed as a PHP callback type, including closures. Callbacks will receive two * Will load the DebugKit plugin and will not load any bootstrap nor route files
* parameters (plugin name, plugin configuration) *
* `CakePlugin::load('DebugKit', array('bootstrap' => true, 'routes' => true))`
*
* will load the bootstrap.php and routes.php files
*
* `CakePlugin::load('DebugKit', array('bootstrap' => false, 'routes' => true))`
*
* will load routes.php file but not bootstrap.php
*
* `CakePlugin::load('DebugKit', array('bootstrap' => array('config1', 'config2')))`
*
* will load config1.php and config2.php files
*
* `CakePlugin::load('DebugKit', array('bootstrap' => 'aCallableMethod'))`
*
* will run the aCallableMethod function to initialize it
*
* Bootstrap initialization functions can be expressed as a PHP callback type,
* including closures. Callbacks will receive two parameters
* (plugin name, plugin configuration)
* *
* It is also possible to load multiple plugins at once. Examples: * It is also possible to load multiple plugins at once. Examples:
* *
@ -63,7 +78,9 @@ class CakePlugin {
* ), array('bootstrap' => true)) * ), array('bootstrap' => true))
* ``` * ```
* *
* Will only load the bootstrap for ApiGenerator and only the routes for DebugKit * Will only load the bootstrap for ApiGenerator and only the routes for DebugKit.
* By using the `path` option you can specify an absolute path to the plugin. Make
* sure that the path is slash terminated or your plugin will not be located properly.
* *
* @param string|array $plugin name of the plugin to be loaded in CamelCase format or array or plugins to load * @param string|array $plugin name of the plugin to be loaded in CamelCase format or array or plugins to load
* @param array $config configuration options for the plugin * @param array $config configuration options for the plugin