Joomla! 1.5 API

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2011 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Abstract Class JPlugin

Description

JPlugin Class

  • abstract:
  • since: 1.5

Located in /joomla/plugin/plugin.php (line 28)

Class JObject   (Subpackage Base)

Abstract class JObserver   (Subpackage Base)
   
   Abstract class JEvent   (Subpackage Event)
      
      Abstract class JPlugin   (Subpackage Plugin)
Variable Summary
Variable sring $_name
Variable string $_type
Method Summary
Constructor JPlugin JPlugin ( &$subject, [array $config = array()], object $subject)
Constructor JPlugin __construct ( &$subject, [ $config = array()])
Method boolean loadLanguage ([string $extension = ''], [string $basePath = JPATH_BASE])
Variables
A $params = null (line 37)

A JParameter object holding the parameters for the plugin

  • var: JParameter object
  • since: 1.5
  • access: public
sring $_name = null (line 45)

The name of the plugin

  • access: protected
string $_type = null (line 53)

The plugin type

  • access: protected

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Constructor JPlugin (line 68)

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

Constructor

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

Redefinition of:
JObserver::__construct()
Constructor
loadLanguage (line 107)

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()
Support Joomla!