\JEventDispatcher

Class to handle dispatching of events.

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

Synopsis

class JEventDispatcher extends JObject {

• // members
• protected  $_observers;
• protected  $_state;
• protected  $_methods;
• protected JEventDispatcher  $instance;
• // Inherited members from JObject
• protected  $_errors;
• // methods
• public static JEventDispatcher getInstance()
• public mixed getState()
• public void register()
• public array trigger()
• public void attach()
• public boolean detach()
• // 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

• JObject

Extended by

• JDispatcher
• FOFModelDispatcherBehavior
• FOFTableDispatcherBehavior

Members

protected

• $_errors — array
  An array of error messages or Exception objects.
• $_methods — array
  A multi dimensional array of [function][] = key for observers
• $_observers — array
  An array of Observer objects to notify
• $_state — mixed
  The state of the observable object
• $instance — JEventDispatcher
  Stores the singleton instance of the dispatcher.

Methods

public

• attach() — Attach an observer object
• detach() — Detach an observer object
• getInstance() — Returns the global Event Dispatcher object, only creating it if it doesn't already exist.
• getState() — Get the state of the JEventDispatcher object
• register() — Registers an event handler to the event dispatcher
• trigger() — Triggers an event by dispatching arguments to all observers that handle the event and returning their return values.

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.