Docs For Class JPluginHelper

Description

abstract:

Located in /libraries/cms/plugin/helper.php (line 19)

Variable Summary

static array $plugins

Method Summary

static string getLayoutPath (string $type, string $name, [string $layout = 'default'])

static mixed getPlugin (string $type, [string $plugin = null])

static void import (object $plugin, [boolean $autocreate = true], [JEventDispatcher $dispatcher = null])

static boolean importPlugin (string $type, [string $plugin = null], [boolean $autocreate = true], [JEventDispatcher $dispatcher = null])

static boolean isEnabled (string $type, [string $plugin = null])

static array load ()

static void _import (object $plugin, [boolean $autocreate = true], [JEventDispatcher $dispatcher = null])

static array _load ()

Variables

static array $plugins = null (line 27)

A persistent cache of the loaded plugins.

since: 1.7
access: protected

Methods

static getLayoutPath (line 40)

Get the path to a layout from a Plugin

return: Layout path
since: 3.0
access: public

static string getLayoutPath (string $type, string $name, [string $layout = 'default'])

string $type: Plugin type
string $name: Plugin name
string $layout: Layout name

static getPlugin (line 85)

Get the plugin data of a specific type if no specific plugin is specified otherwise only the specific plugin data is returned.

return: An array of plugin data objects, or a plugin data object.
since: 1.5
access: public

static mixed getPlugin (string $type, [string $plugin = null])

string $type: The plugin type, relates to the sub-directory in the plugins directory.
string $plugin: The plugin name.

static import (line 217)

Loads the plugin file.

since: 3.2
access: protected

static void import (object $plugin, [boolean $autocreate = true], [JEventDispatcher $dispatcher = null])

object $plugin: The plugin.
boolean $autocreate: True to autocreate.
JEventDispatcher $dispatcher: Optionally allows the plugin to use a different dispatcher.

static importPlugin (line 148)

Loads all the plugin files for a particular type if no specific plugin is specified otherwise only the specific plugin is loaded.

return: True on success.
since: 1.5
access: public

static boolean importPlugin (string $type, [string $plugin = null], [boolean $autocreate = true], [JEventDispatcher $dispatcher = null])

string $type: The plugin type, relates to the sub-directory in the plugins directory.
string $plugin: The plugin name.
boolean $autocreate: Autocreate the plugin.
JEventDispatcher $dispatcher: Optionally allows the plugin to use a different dispatcher.

static isEnabled (line 128)

Checks if a plugin is enabled.

since: 1.5
access: public

static boolean isEnabled (string $type, [string $plugin = null])

string $type: The plugin type, relates to the sub-directory in the plugins directory.
string $plugin: The plugin name.

static load (line 288)

Loads the published plugins.

return: An array of published plugins
since: 3.2
access: protected

static array load ()

static _import (line 201)

Loads the plugin file.

deprecated: 4.0 Use JPluginHelper::import() instead
since: 1.5
access: protected

static void _import (object $plugin, [boolean $autocreate = true], [JEventDispatcher $dispatcher = null])

object $plugin: The plugin.
boolean $autocreate: True to autocreate.
JEventDispatcher $dispatcher: Optionally allows the plugin to use a different dispatcher.

static _load (line 276)

Loads the published plugins.

return: An array of published plugins
deprecated: 4.0 Use JPluginHelper::load() instead
since: 1.5
access: protected

static array _load ()