Class JPlugin

Description

JPlugin Class

  • abstract:
  • since: 11.1

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

JObject
   |
   --JEvent
      |
      --JPlugin
Direct descendents
Class Description
FinderIndexerAdapter Prototype adapter class for the Finder indexer package.
plgSystemLogout Plugin class for logout redirect handling.
PlgSystemHighlight System plugin to highlight terms.
plgSystemP3p Joomla! P3P Header Plugin
plgSystemLanguageFilter Joomla! Language Filter Plugin
plgSystemCache Joomla! Page Cache Plugin
plgSystemLanguagecode Language Code plugin class.
plgSystemRemember Joomla! System Remember Me Plugin
plgSystemDebug Joomla! Debug plugin
plgSystemLog Joomla! System Logging Plugin
plgSystemSef Joomla! SEF Plugin
plgSystemRedirect Plugin class for redirect handling.
plgCaptchaRecaptcha Recaptcha Plugin.
plgContentGeshi
plgContentPagenavigation Pagenavigation plugin class.
plgContentJoomla Example Content Plugin
plgContentFinder Finder Content Plugin
plgContentEmailcloak Email cloack plugin class.
plgContentPagebreak Page break plugin
plgContentVote Vote plugin.
plgContentLoadmodule
plgQuickiconExtensionupdate Joomla! udpate notification plugin
plgQuickiconJoomlaupdate Joomla! udpate notification plugin
plgExtensionJoomla Joomla! master extension plugin.
plgUserProfile An example custom profile plugin.
plgUserJoomla Joomla User plugin
plgUserContactCreator Class for Contact Creator
plgAuthenticationGMail GMail Authentication Plugin
plgAuthenticationJoomla Joomla Authentication plugin
plgAuthenticationLdap LDAP Authentication Plugin
plgEditorNone Plain Textarea Editor Plugin
plgEditorCodemirror CodeMirror Editor Plugin.
plgEditorTinymce TinyMCE Editor Plugin
plgButtonArticle Editor Article buton
plgButtonPagebreak Editor Pagebreak buton
plgButtonReadmore Editor Readmore buton
plgButtonImage Editor Image buton
plgSearchWeblinks Weblinks Search plugin
plgSearchContacts Contacts Search plugin
plgSearchContent Content Search plugin
plgSearchNewsfeeds Newsfeeds Search plugin
plgSearchCategories Categories Search plugin
Variable Summary
string $_name
string $_type
Method Summary
JPlugin __construct (object &$subject, [array $config = array()])
boolean loadLanguage ([string $extension = ''], [string $basePath = JPATH_ADMINISTRATOR])
Variables
JRegistry $params = null (line 27)

A JRegistry object holding the parameters for the plugin

  • since: 11.1
  • access: public
string $_name = null (line 35)

The name of the plugin

  • since: 11.1
  • access: protected
string $_type = null (line 43)

The plugin type

  • since: 11.1
  • access: protected

Inherited Variables

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 55)

Constructor

  • since: 11.1
  • access: public
JPlugin __construct (object &$subject, [array $config = array()])
  • object &$subject: The object to observe
  • array $config: An optional associative array of configuration settings. Recognized key values include 'name', 'group', 'params', 'language' (this list is not meant to be comprehensive).

Redefinition of:
JEvent::__construct()
Constructor

Redefined in descendants as:
loadLanguage (line 96)

Loads the plugin language file

  • return: True, if the file has successfully loaded.
  • since: 11.1
  • access: public
boolean loadLanguage ([string $extension = ''], [string $basePath = JPATH_ADMINISTRATOR])
  • string $extension: The extension for which a language file should be loaded
  • string $basePath: The basepath to use

Inherited Methods

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:58:46 -0500 by phpDocumentor 1.4.4