PEIP_Object_Map_Dispatcher Class Reference

Inheritance diagram for PEIP_Object_Map_Dispatcher:

List of all members.

Public Member Functions
	connect ($name, $object, PEIP_INF_Handler $listener)
	disconnect ($name, $object, PEIP_INF_Handler $listener)
	hasListeners ($name, $object)
	hadListeners ($name, $object)
	getEventNames ($object)
	notify ($name, $object)
	notifyUntil ($name, $subject)
	getListeners ($name, $object)
Protected Member Functions
	doGetListeners ()
Static Protected Member Functions
static	doNotify (array $listeners, $subject)
static	doNotifyUntil (array $listeners, $subject)
Protected Attributes
	$listeners = NULL

---

Detailed Description

Definition at line 21 of file PEIP_Object_Map_Dispatcher.php.

---

Member Function Documentation

PEIP_Object_Map_Dispatcher::connect	(	$	name,
		$	object,
		PEIP_INF_Handler $	listener
	)

connects a Handler to an event on an object

public

Parameters:

	string	$name the event-name
	object	$object arbitrary object to connect to
	PEIP_INF_Handler	$listener event-handler

Returns:

boolean

Implements PEIP_INF_Object_Map_Dispatcher.

Definition at line 37 of file PEIP_Object_Map_Dispatcher.php.

References doGetListeners().

PEIP_Object_Map_Dispatcher::disconnect	(	$	name,
		$	object,
		PEIP_INF_Handler $	listener
	)

disconnects a Handler from an event on an object

public

Parameters:

	string	$name the event-name
	object	$object arbitrary object to disconnect from
	PEIP_INF_Handler	$listener event-handler

Returns:

boolean

Implements PEIP_INF_Object_Map_Dispatcher.

Definition at line 58 of file PEIP_Object_Map_Dispatcher.php.

References doGetListeners().

PEIP_Object_Map_Dispatcher::hasListeners	(	$	name,
		$	object
	)

Checks wether an object has a listener for an event

public

Parameters:

	string	$name the event-name
	object	$object object to check for listeners

Returns:

boolean

Implements PEIP_INF_Object_Map_Dispatcher.

Definition at line 81 of file PEIP_Object_Map_Dispatcher.php.

References doGetListeners(), getListeners(), and hadListeners().

Referenced by PEIP_Object_Event_Dispatcher::buildAndNotify(), notify(), PEIP_Object_Event_Dispatcher::notify(), and notifyUntil().

PEIP_Object_Map_Dispatcher::hadListeners	(	$	name,
		$	object
	)

Checks wether an object has or had a listener for an event

public

Parameters:

	string	$name the event-name
	object	$object object to check for listeners

Returns:

boolean

Definition at line 99 of file PEIP_Object_Map_Dispatcher.php.

References doGetListeners().

Referenced by getListeners(), and hasListeners().

PEIP_Object_Map_Dispatcher::getEventNames

(

$

object

)

public

Parameters:

object

$object object to get event-names for

Returns:

string[] array of event-names

Implements PEIP_INF_Object_Map_Dispatcher.

Definition at line 109 of file PEIP_Object_Map_Dispatcher.php.

References $listeners, and doGetListeners().

PEIP_Object_Map_Dispatcher::notify	(	$	name,
		$	object
	)

Notifies all listeners of a given event on an object.

public

Parameters:

	$name
	$object

Returns:

boolean

Implements PEIP_INF_Object_Map_Dispatcher.

Definition at line 125 of file PEIP_Object_Map_Dispatcher.php.

References getListeners(), and hasListeners().

PEIP_Object_Map_Dispatcher::notifyUntil	(	$	name,
		$	subject
	)

Notifies all listeners of a given event on an object until one returns a non null value.

public

Parameters:

	$name
	$subject

Returns:

mixed

Definition at line 141 of file PEIP_Object_Map_Dispatcher.php.

References getListeners(), and hasListeners().

PEIP_Object_Map_Dispatcher::getListeners	(	$	name,
		$	object
	)

returns all listeners of a given event on an object

public

Parameters:

	string	$name the event-name
	object	$object object to check for listeners

Returns:

array array of listeners

Implements PEIP_INF_Object_Map_Dispatcher.

Definition at line 156 of file PEIP_Object_Map_Dispatcher.php.

References hadListeners().

Referenced by hasListeners(), notify(), PEIP_Object_Event_Dispatcher::notify(), and notifyUntil().

PEIP_Object_Map_Dispatcher::doGetListeners

(

)

[protected]

returns SplObjectStorage object to store objects to lositen to in. creates SplObjectStorage if not exists.

protected

Returns:

SplObjectStorage

Definition at line 170 of file PEIP_Object_Map_Dispatcher.php.

Referenced by connect(), disconnect(), getEventNames(), hadListeners(), and hasListeners().

static PEIP_Object_Map_Dispatcher::doNotify	(	array $	listeners,
		$	subject
	)			[static, protected]

Definition at line 174 of file PEIP_Object_Map_Dispatcher.php.

static PEIP_Object_Map_Dispatcher::doNotifyUntil	(	array $	listeners,
		$	subject
	)			[static, protected]

Definition at line 180 of file PEIP_Object_Map_Dispatcher.php.

---

Member Data Documentation

PEIP_Object_Map_Dispatcher::$listeners = NULL [protected]

Definition at line 25 of file PEIP_Object_Map_Dispatcher.php.

Referenced by getEventNames().

---

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

• PEIP_Object_Map_Dispatcher.php

---