[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/libraries/joomla/plugin/ -> helper.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 250 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 5 functions

  getPlugin()
  isEnabled()
  importPlugin()
  _import()
  _load()

Functions
Functions that are not part of a class:

getPlugin($type, $plugin = null)   X-Ref
Get the plugin data of a specific type if no specific plugin is specified
otherwise only the specific plugin data is returned.

param: string  $type    The plugin type, relates to the sub-directory in the plugins directory.
param: string  $plugin  The plugin name.
return: mixed  An array of plugin data objects, or a plugin data object.

isEnabled($type, $plugin = null)   X-Ref
Checks if a plugin is enabled.

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

importPlugin($type, $plugin = null, $autocreate = true, $dispatcher = null)   X-Ref
Loads all the plugin files for a particular type if no specific plugin is specified
otherwise only the specific plugin is loaded.

param: string       $type        The plugin type, relates to the sub-directory in the plugins directory.
param: string       $plugin      The plugin name.
param: boolean      $autocreate  Autocreate the plugin.
param: JDispatcher  $dispatcher  Optionally allows the plugin to use a different dispatcher.
return: boolean  True on success.

_import(&$plugin, $autocreate = true, $dispatcher = null)   X-Ref
Loads the plugin file.

param: JPlugin      &$plugin     The plugin.
param: boolean      $autocreate  True to autocreate.
param: JDispatcher  $dispatcher  Optionally allows the plugin to use a different dispatcher.
return: boolean  True on success.

_load()   X-Ref
Loads the published plugins.

return: array  An array of published plugins



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1