Docs For Class JEvent

Description

JEvent Class

abstract:
since: 11.1

Located in /libraries/joomla/event/event.php (line 19)

JObject
   |
   --JEvent

Direct descendents

Class	Description
JPlugin	JPlugin Class
FOFModelBehavior	FrameworkOnFramework model behavior class. It defines the events which are called by a Model.
FOFTableBehavior	FrameworkOnFramework table behavior class. It defines the events which are called by a Table.

Variable Summary

object $_subject

Method Summary

JEvent __construct (object &$subject)

mixed update (array &$args)

Variables

object $_subject = null (line 27)

Event object to observe.

since: 11.3
access: protected

Inherited Variables

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 36)

Constructor

since: 11.3
access: public

JEvent __construct (object &$subject)

object &$subject: The object to observe.

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

Redefined in descendants as:

JPlugin::__construct() : Constructor
FinderIndexerAdapter::__construct() : Method to instantiate the indexer adapter.
PlgSystemCache::__construct() : Constructor
PlgSystemDebug::__construct() : Constructor.
PlgSystemLanguageFilter::__construct()
PlgSystemLogout::__construct() : Object Constructor.
PlgSystemRedirect::__construct() : Object Constructor.
PlgSystemRemember::__construct() : Constructor. We use it to set the app and db properties.
PlgTwofactorauthTotp::__construct() : Constructor
PlgTwofactorauthYubikey::__construct() : Constructor
PlgUserJoomla::__construct() : Constructor. We use it to set the app and db properties.
PlgUserProfile::__construct() : Constructor

update (line 58)

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.

return: Routine return value
since: 11.1
access: public

mixed update (array &$args)

array &$args: Arguments

Inherited Methods

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()