Abstract Class JPlugin

Description
Description | Descendents | Vars (details) | Methods (details)

JPlugin Class

  • abstract:
  • since: 1.5

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

JObject
   |
   --JEvent
      |
      --JPlugin
Direct descendents
Description | Descendents | Vars (details) | Methods (details)
Class Description
Abstract class FinderIndexerAdapter Prototype adapter class for the Finder indexer package.
class PlgAuthenticationCookie Joomla Authentication plugin
class PlgAuthenticationGMail GMail Authentication Plugin
class PlgAuthenticationJoomla Joomla Authentication plugin
class PlgAuthenticationLdap LDAP Authentication Plugin
class PlgCaptchaRecaptcha Recaptcha Plugin.
class PlgContentEmailcloak Email cloack plugin class.
class PlgContentFinder Finder Content Plugin
class PlgContentJoomla Example Content Plugin
class PlgContentLoadmodule Plug-in to enable loading modules into content (e.g. articles) This uses the {loadmodule} syntax
class PlgContentPagebreak Page break plugin
class PlgContentPagenavigation Pagenavigation plugin class.
class PlgContentVote Vote plugin.
class PlgButtonArticle Editor Article buton
class PlgButtonImage Editor Image buton
class PlgButtonPagebreak Editor Pagebreak buton
class PlgButtonReadmore Editor Readmore buton
class PlgEditorCodemirror CodeMirror Editor Plugin.
class PlgEditorNone Plain Textarea Editor Plugin
class PlgEditorTinymce TinyMCE Editor Plugin
class PlgExtensionJoomla Joomla! master extension plugin.
class PlgQuickiconExtensionupdate Joomla! udpate notification plugin
class PlgQuickiconJoomlaupdate Joomla! udpate notification plugin
class PlgSearchCategories Categories Search plugin
class PlgSearchContacts Contacts Search plugin
class PlgSearchContent Content Search plugin
class PlgSearchNewsfeeds Newsfeeds Search plugin
class PlgSearchWeblinks Weblinks Search plugin
class PlgSystemCache Joomla! Page Cache Plugin
class PlgSystemDebug Joomla! Debug plugin
class PlgSystemHighlight System plugin to highlight terms.
class PlgSystemLanguagecode Language Code plugin class.
class PlgSystemLanguageFilter Joomla! Language Filter Plugin
class PlgSystemLog Joomla! System Logging Plugin
class PlgSystemLogout Plugin class for logout redirect handling.
class PlgSystemP3p Joomla! P3P Header Plugin
class PlgSystemRedirect Plugin class for redirect handling.
class PlgSystemRemember Joomla! System Remember Me Plugin
class PlgSystemSef Joomla! SEF Plugin
class PlgTwofactorauthTotp Joomla! Two Factor Authentication using Google Authenticator TOTP Plugin
class PlgTwofactorauthYubikey Joomla! Two Factor Authentication using Yubikey Plugin
class PlgUserContactCreator Class for Contact Creator
class PlgUserJoomla Joomla User plugin
class PlgUserProfile An example custom profile plugin.
Variable Summary
Description | Descendants | Vars (details) | Methods (details)
boolean $autoloadLanguage
JRegistry $params
string $_name
string $_type
Method Summary
Description | Descendants | Vars (details) | Methods (details)
JPlugin __construct (object &$subject, [array $config = array()])
boolean loadLanguage ([string $extension = ''], [string $basePath = JPATH_ADMINISTRATOR])
Variables
Description | Descendents | Vars (details) | Methods (details)
boolean $autoloadLanguage = false (line 51)

Affects constructor behavior. If true, language files will be loaded automatically.

  • since: 3.1
  • access: protected
Redefined in descendants as:
JRegistry $params = null (line 27)

A JRegistry object holding the parameters for the plugin

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

The name of the plugin

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

The plugin type

  • since: 1.5
  • access: protected

Inherited Variables

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
Description | Descendents | Vars (details) Methods (details)
Constructor __construct (line 63)

Constructor

  • since: 1.5
  • 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 132)

Loads the plugin language file

  • return: True, if the file has successfully loaded.
  • since: 1.5
  • 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()

Documentation generated on Tue, 19 Nov 2013 15:10:43 +0100 by phpDocumentor 1.4.3