EventManager Class Reference

Public Member Functions
	register ($eventType, &$listener)
	unregister ($eventType, $id)
	eventOccurs ($event)
	listRegisteredEvents ()
	listRegisteredListeners ()
Static Public Member Functions
static	getInstance ()
static	notify ($event, $args=null)
static	addListener ($eventType, &$listener)
static	removeListener ($eventType, $id)
Private Member Functions
	__construct ()
Private Attributes
	$_registry = array()
Static Private Attributes
static	$instance = false

---

Detailed Description

Class to manage events and dispatch them to event listeners public

Definition at line 75 of file event.lib.php.

---

Constructor & Destructor Documentation

__construct

(

)

[private]

Constructor public

Definition at line 86 of file event.lib.php.

---

Member Function Documentation

static addListener	(	$	eventType,
		&$	listener
	)			[static]

register new event listener for a given event public

Parameters:

	string	eventType event type
	EventListener	listener reference to the event listener

Returns:

string event listener ID

Definition at line 228 of file event.lib.php.

eventOccurs

(

$

event

)

notify occurence of an event to the event manager package private

Parameters:

string

event type of occured event

Returns:

int number of listeners notified or boolean false

Definition at line 144 of file event.lib.php.

static getInstance

(

)

[static]

get event manager singleton instance public

Returns:

EventManager instance

Definition at line 183 of file event.lib.php.

listRegisteredEvents

(

)

list all registered events and the number of listeners for each public

Definition at line 254 of file event.lib.php.

listRegisteredListeners

(

)

list all registered listeners and their ID public

Definition at line 278 of file event.lib.php.

static notify	(	$	event,
		$	args = null
	)			[static]

notify occurence of an event to the event manager. Usage :

• EventManager::notify( $event );
• EventManager::notify( $eventType, $args ); public

  Parameters:

  	string	event type of occured event, or event object
  	array	args optional event arguments (only if event type given as first argument)

Definition at line 203 of file event.lib.php.

register	(	$	eventType,
		&$	listener
	)

register new event listener for a given event public

Parameters:

	string	eventType event type
	EventListener	listener reference to the event listener

Returns:

string event listener ID

Definition at line 97 of file event.lib.php.

static removeListener	(	$	eventType,
		$	id
	)			[static]

unregister event listener public

Parameters:

	string	eventype type of event watching by the listener
	string	id listener ID

Returns:

boolean

Definition at line 242 of file event.lib.php.

unregister	(	$	eventType,
		$	id
	)

unregister event listener public

Parameters:

	string	eventype type of event watching by the listener
	string	id listener ID

Returns:

bool

Definition at line 117 of file event.lib.php.

---

Field Documentation

$_registry = array() [private]

Definition at line 78 of file event.lib.php.

$instance = false [static, private]

Definition at line 80 of file event.lib.php.

---

The documentation for this class was generated from the following file:

• claroline/claroline/inc/lib/core/event.lib.php