Class JPluginHelper

Description

Plugin helper class

  • abstract:
  • since: 11.1

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


	
			
Variable Summary
static array $plugins
Method Summary
static mixed getPlugin (string $type, [string $plugin = null])
static boolean importPlugin (string $type, [string $plugin = null], [boolean $autocreate = true], [JDispatcher $dispatcher = null])
static boolean isEnabled (string $type, [string $plugin = null])
static boolean _import (JPlugin &$plugin, [boolean $autocreate = true], [JDispatcher $dispatcher = null])
static array _load ()
Variables
static array $plugins = null (line 27)

A persistent cache of the loaded plugins.

  • since: 11.3
  • access: protected
Methods
static method getPlugin (line 40)

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: 11.1
  • 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 method importPlugin (line 102)

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: 11.1
  • access: public
static boolean importPlugin (string $type, [string $plugin = null], [boolean $autocreate = true], [JDispatcher $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.
  • JDispatcher $dispatcher: Optionally allows the plugin to use a different dispatcher.
static method isEnabled (line 83)

Checks if a plugin is enabled.

  • since: 11.1
  • 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 method _import (line 152)

Loads the plugin file.

  • return: True on success.
  • since: 11.1
  • access: protected
static boolean _import (JPlugin &$plugin, [boolean $autocreate = true], [JDispatcher $dispatcher = null])
  • JPlugin &$plugin: The plugin.
  • boolean $autocreate: True to autocreate.
  • JDispatcher $dispatcher: Optionally allows the plugin to use a different dispatcher.
static method _load (line 212)

Loads the published plugins.

  • return: An array of published plugins
  • since: 11.1
  • access: protected
static array _load ()

Documentation generated on Mon, 25 Jun 2012 13:55:27 -0500 by phpDocumentor 1.4.4