CMSPlugin

Extends \JEvent

Plugin Class

abstract
since

1.5

Methods

__construct

Constructor

__construct( &$subject) 
inherited
since

2.5

Arguments

$subject

loadLanguage

Loads the plugin language file

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

1.5

Arguments

$extension

stringThe extension for which a language file should be loaded

$basePath

stringThe basepath to use

Response

booleanTrue, if the file has successfully loaded.

update

Method to trigger events.

update( &$args) : mixed
inherited

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.

since

1.5

Arguments

$args

Response

mixedRoutine return value

Properties

params

A Registry object holding the parameters for the plugin

since

1.5

Type(s)

\Joomla\Registry\Registry

_name

The name of the plugin

since

1.5

Type(s)

string

_type

The plugin type

since

1.5

Type(s)

string

autoloadLanguage

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

since

3.1

Type(s)

boolean

_subject

Event object to observe.

inherited
since

2.5

Type(s)

object