1. class
  2. Joomla
  3. CMS
  4. Plugin
  5. CMSPlugin

CMSPlugin

class CMSPlugin extends JEvent

Plugin Class

Properties

Registry $params A Registry object holding the parameters for the plugin

Methods

__construct( object $subject, array $config = array())

Constructor

mixed
update( array $args)

Method to trigger events.

from JEvent
boolean
loadLanguage( string $extension = '', string $basePath = JPATH_ADMINISTRATOR)

Loads the plugin language file

Details

__construct( object $subject, array $config = array())

Constructor

Parameters

object $subject &$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).

mixed update( array $args)

Method to trigger events.

The method first generates the even from the argument array. Then it unsets the argument since the argument has no bearing on the event handler. If the method exists it is called and returns its return value. If it does not exist it returns null.

Parameters

array $args &$args Arguments

Return Value

mixed Routine return value

boolean loadLanguage( string $extension = '', string $basePath = JPATH_ADMINISTRATOR)

Loads the plugin language file

Parameters

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

Return Value

boolean True, if the file has successfully loaded.