Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

 Class JPluginHelper

Description

Plugin helper class

  • since: 1.5

Located in /joomla/plugin/helper.php (line 26)

Class JPluginHelper   (Subpackage Plugin)
Method Summary
Method mixed &getPlugin (string $type, [string $plugin = null])
Method boolean importPlugin (string $type, [string $plugin = null], [ $autocreate = true], [ $dispatcher = null])
Method boolean isEnabled (string $type, [string $plugin = null])
Methods
getPlugin (line 37)

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
  • access: public
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
importPlugin (line 88)

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

  • return: True if success
  • access: public
boolean importPlugin (string $type, [string $plugin = null], [ $autocreate = true], [ $dispatcher = null])
  • string $type: The plugin type, relates to the sub-directory in the plugins directory
  • string $plugin: The plugin name
  • $autocreate
  • $dispatcher
isEnabled (line 73)

Checks if a plugin is enabled

  • access: public
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
Support Joomla!