Docs For Class JPlugin

Description

JPlugin Class

author: Johan Janssens <johan.janssens@joomla.org>
abstract:
since: 1.5

Located in /Servers/Apache_2_2/htdocs/Joomla15/libraries/joomla/plugin/plugin.php (line 29)

JObject
   |
   --JObserver
      |
      --JEvent
         |
         --JPlugin

Direct descendents

Class	Description
plgSystemRemember2	Joomla! System Remember Me Plugin
plgSystemBacklink
plgSystemCache	Joomla! Page Cache Plugin
plgSystemDebug	Joomla! Debug plugin
plgSystemLegacy	Joomla! Debug plugin
plgSystemLog	Joomla! System Logging Plugin
plgSystemRemember	Joomla! System Remember Me Plugin
plgSystemSef	Joomla! SEF Plugin

Variable Summary

A $params

sring $_name

string $_type

Method Summary

JPlugin JPlugin ( &$subject, [array $config = array()], object $subject)

JPlugin __construct ( &$subject, [ $config = array()])

boolean loadLanguage ([string $extension = ''], [string $basePath = JPATH_BASE])

Variables

A $params = null (line 38)

A JParameter object holding the parameters for the plugin

var: JParameter object
since: 1.5
access: public

sring $_name = null (line 46)

The name of the plugin

access: protected

string $_type = null (line 54)

The plugin type

access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor JPlugin (line 69)

Constructor

For php4 compatability we must not use the __constructor as a constructor for plugins because func_get_args ( void ) returns a copy of all passed arguments NOT references. This causes problems with cross-referencing necessary for the observer design pattern.

since: 1.5

JPlugin JPlugin ( &$subject, [array $config = array()], object $subject)

object $subject: The object to observe
array $config: An optional associative array of configuration settings. Recognized key values include 'name', 'group', 'params' (this list is not meant to be comprehensive).
&$subject

Constructor __construct (line 76)

Constructor

JPlugin __construct ( &$subject, [ $config = array()])

&$subject
$config

Redefinition of:

JObserver::__construct(): Constructor

loadLanguage (line 108)

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_BASE])

string $extension: The extension for which a language file should be loaded
string $basePath: The basepath to use

Inherited Methods

Inherited From JEvent

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

Inherited From JObserver

JObserver::__construct()
JObserver::update()

Inherited From JObject

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