\JPlugin

JPlugin Class

Synopsis

class JPlugin extends JEvent {

// members
public JRegistry $params;
protected $_name;
protected $_type;
protected $autoloadLanguage;

// Inherited members from JEvent
protected $_subject;

// Inherited members from JObject
protected $_errors;

// methods
public void __construct()
public boolean loadLanguage()

// Inherited methods from JEvent
public void __construct()
public mixed update()

// Inherited methods from JObject
public void __construct()
public string __toString()
public mixed def()
public mixed get()
public array getProperties()
public string getError()
public array getErrors()
public mixed set()
public boolean setProperties()
public void setError()

}

Hierarchy

Extends

JEvent

Extended by

Members

protected

$_errors — array
An array of error messages or Exception objects.
$_name — string
The name of the plugin
$_subject —
Event object to observe.

$_type — string
The plugin type

$autoloadLanguage — boolean
Affects constructor behavior. If true, language files will be loaded automatically.

public

$params — JRegistry
A JRegistry object holding the parameters for the plugin

Methods

public

__construct() — Constructor
loadLanguage() — Loads the plugin language file

Inherited from JEvent

public

update() — Method to trigger events.

Inherited from JObject

public

__toString() — Magic method to convert the object to a string gracefully.
def() — Sets a default value if not alreay assigned
get() — Returns a property of the object or the default value if the property is not set.
getError() — Get the most recent error message.
getErrors() — Return all errors, if any.
getProperties() — Returns an associative array of object properties.
set() — Modifies a property of the object, creating it if it does not already exist.
setError() — Add an error message.
setProperties() — Set the object properties based on a named array/hash.