Class to handle dispatching of events.

This is the Observable part of the Observer design pattern for the event architecture.

• author: Louis Landry <louis.landry@joomla.org>
• link: http://dev.joomla.org/component/option,com_jd-wiki/Itemid,31/id,tutorials:plugins/ Plugins tutorial, com_jd-wiki/Itemid, 31/id, tutorials:plugins/
• see: JPlugin
• since: 1.5

Located in /joomla/event/dispatcher.php (line 32)

 JObject   (Subpackage Base)

 JObservable   (Subpackage Base)
   
    JDispatcher   (Subpackage Event)

Inherited Variables

Inherited from JObject

JObject::$_errors

Constructor __construct (line 39)

Constructor

• access: protected

JDispatcher __construct ()

---

Redefinition of:

JObservable::__construct()

Constructor

getInstance (line 55)

Returns a reference to the global Event Dispatcher object, only creating it if it doesn't already exist.

This method must be invoked as:

  $dispatcher = &JDispatcher::getInstance();

• return: The EventDispatcher object.
• since: 1.5
• access: public

JDispatcher &getInstance ()

register (line 75)

Registers an event handler to the event dispatcher

• since: 1.5
• access: public

void register (string $event, string $handler)

• string $event: Name of the event to register handler for
• string $handler: Name of the event handler

trigger (line 106)

Triggers an event by dispatching arguments to all observers that handle the event and returning their return values.

• return: An array of results from each function call
• since: 1.5
• access: public

array trigger (string $event, [array $args = null], [boolean $doUnpublished = false])

• string $event: The event name
• array $args: An array of arguments
• boolean $doUnpublished: [DEPRECATED]

Inherited Methods

Inherited From JObservable

JObservable::__construct()
JObservable::attach()
JObservable::detach()
JObservable::getState()
JObservable::notify()

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