Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5. Some parts of this website may be subject to other licenses.

Class JPluginHelper

Description
Description | Methods (details)

Plugin helper class

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

Class JPluginHelper   (Subpackage Plugin)
Method Summary
Description | Methods (details)
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
Description | Methods (details)
getPlugin (line 38)

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 89)

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 74)

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
Documentation generated on Tue, 29 Jan 2008 18:47:19 +0000 by phpDocumentor 1.3.1