CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.2 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.2
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
    • Collection
    • Console
    • Controller
    • Core
      • Configure
      • Exception
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

Class Plugin

Plugin is used to load and locate plugins.

It also can retrieve plugin paths and load their bootstrap and routes files.

Namespace: Cake\Core
Link: http://book.cakephp.org/3.0/en/plugins.html

Property Summary

  • $_loader protected static
    Cake\Core\ClassLoader

    Class loader instance

  • $_plugins protected static
    array

    Holds a list of all loaded plugins and their configuration

Method Summary

  • _includeFile() protected static

    Include file, ignoring include error if needed if file is missing

  • _loadConfig() protected static

    Load the plugin path configuration file.

  • bootstrap() public static

    Loads the bootstrapping files for a plugin, or calls the initialization setup in the configuration

  • classPath() public static

    Returns the filesystem path for plugin's folder containing class folders.

  • configPath() public static

    Returns the filesystem path for plugin's folder containing config files.

  • load() public static

    Loads a plugin and optionally loads bootstrapping, routing files or runs an initialization function.

  • loadAll() public static

    Will load all the plugins located in the default plugin folder.

  • loaded() public static

    Returns true if the plugin $plugin is already loaded If plugin is null, it will return a list of all loaded plugins

  • path() public static

    Returns the filesystem path for a plugin

  • routes() public static

    Loads the routes file for a plugin, or all plugins configured to load their respective routes file

  • unload() public static

    Forgets a loaded plugin or all of them if first parameter is null

Method Detail

_includeFile() ¶ protected static

_includeFile(string $file, bool $ignoreMissing = false): mixed

Include file, ignoring include error if needed if file is missing

Parameters
string $file

File to include

bool $ignoreMissing optional

Whether to ignore include error for missing files

Returns
mixed

_loadConfig() ¶ protected static

_loadConfig(): void

Load the plugin path configuration file.

Returns
void

bootstrap() ¶ public static

bootstrap(string $plugin): mixed

Loads the bootstrapping files for a plugin, or calls the initialization setup in the configuration

Parameters
string $plugin

name of the plugin

Returns
mixed
See Also
\Cake\Core\Plugin::load() for examples of bootstrap configuration

classPath() ¶ public static

classPath(string $plugin): string

Returns the filesystem path for plugin's folder containing class folders.

Parameters
string $plugin

name of the plugin in CamelCase format.

Returns
string
Throws
Cake\Core\Exception\MissingPluginException
If plugin has not been loaded.

configPath() ¶ public static

configPath(string $plugin): string

Returns the filesystem path for plugin's folder containing config files.

Parameters
string $plugin

name of the plugin in CamelCase format.

Returns
string
Throws
Cake\Core\Exception\MissingPluginException
If plugin has not been loaded.

load() ¶ public static

load(string|array $plugin, array $config = []): void

Loads a plugin and optionally loads bootstrapping, routing files or runs an initialization function.

Plugins only need to be loaded if you want bootstrapping/routes/cli commands to be exposed. If your plugin does not expose any of these features you do not need to load them.

This method does not configure any autoloaders. That must be done separately either through composer, or your own code during config/bootstrap.php.

Examples:

Plugin::load('DebugKit')

Will load the DebugKit plugin and will not load any bootstrap nor route files. However, the plugin will be part of the framework default routes, and have its CLI tools (if any) available for use.

Plugin::load('DebugKit', ['bootstrap' => true, 'routes' => true])

Will load the bootstrap.php and routes.php files.

Plugin::load('DebugKit', ['bootstrap' => false, 'routes' => true])

Will load routes.php file but not bootstrap.php

Plugin::load('FOC/Authenticate')

Will load plugin from plugins/FOC/Authenticate.

It is also possible to load multiple plugins at once. Examples:

Plugin::load(['DebugKit', 'ApiGenerator'])

Will load the DebugKit and ApiGenerator plugins.

Plugin::load(['DebugKit', 'ApiGenerator'], ['bootstrap' => true])

Will load bootstrap file for both plugins

  Plugin::load([
    'DebugKit' => ['routes' => true],
    'ApiGenerator'
    ],
    ['bootstrap' => true])

Will only load the bootstrap for ApiGenerator and only the routes for DebugKit

Configuration options

  • bootstrap - array - Whether or not you want the $plugin/config/bootstrap.php file loaded.
  • routes - boolean - Whether or not you want to load the $plugin/config/routes.php file.
  • ignoreMissing - boolean - Set to true to ignore missing bootstrap/routes files.
  • path - string - The path the plugin can be found on. If empty the default plugin path (App.pluginPaths) will be used.
  • classBase - The path relative to path which contains the folders with class files. Defaults to "src".
  • autoload - boolean - Whether or not you want an autoloader registered. This defaults to false. The framework assumes you have configured autoloaders using composer. However, if your application source tree is made up of plugins, this can be a useful option.
Parameters
string|array $plugin

name of the plugin to be loaded in CamelCase format or array or plugins to load

array $config optional

configuration options for the plugin

Returns
void
Throws
Cake\Core\Exception\MissingPluginException
if the folder for the plugin to be loaded is not found

loadAll() ¶ public static

loadAll(array $options = []): void

Will load all the plugins located in the default plugin folder.

If passed an options array, it will be used as a common default for all plugins to be loaded It is possible to set specific defaults for each plugins in the options array. Examples:

 Plugin::loadAll([
     ['bootstrap' => true],
     'DebugKit' => ['routes' => true],
 ]);

The above example will load the bootstrap file for all plugins, but for DebugKit it will only load the routes file and will not look for any bootstrap script.

If a plugin has been loaded already, it will not be reloaded by loadAll().

Parameters
array $options optional

Options.

Returns
void

loaded() ¶ public static

loaded(string|null $plugin = null): bool|array

Returns true if the plugin $plugin is already loaded If plugin is null, it will return a list of all loaded plugins

Parameters
string|null $plugin optional

Plugin name.

Returns
bool|array

path() ¶ public static

path(string $plugin): string

Returns the filesystem path for a plugin

Parameters
string $plugin

name of the plugin in CamelCase format

Returns
string
Throws
Cake\Core\Exception\MissingPluginException
if the folder for plugin was not found or plugin has not been loaded

routes() ¶ public static

routes(string|null $plugin = null): bool

Loads the routes file for a plugin, or all plugins configured to load their respective routes file

Parameters
string|null $plugin optional

name of the plugin, if null will operate on all plugins having enabled the loading of routes files

Returns
bool

unload() ¶ public static

unload(string|null $plugin = null): void

Forgets a loaded plugin or all of them if first parameter is null

Parameters
string|null $plugin optional

name of the plugin to forget

Returns
void

Property Detail

$_loader ¶ protected static

Class loader instance

Type
Cake\Core\ClassLoader

$_plugins ¶ protected static

Holds a list of all loaded plugins and their configuration

Type
array
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs