phpDocumentor
Back to top  

sfEventDispatcher implements a dispatcher object.

see \http://developer.apple.com/documentation/Cocoa/Conceptual/Notifications/index.html
package symfony
subpackage event_dispatcher
author Fabien Potencier
version SVN: $Id: sfEventDispatcher.class.php 10631 2008-08-03 16:50:47Z fabien $

 Methods

Connects a listener to a given event name.

connect(string $name, mixed $listener) 

Parameters

$name

string

An event name

$listener

mixed

A PHP callable

Disconnects a listener for a given event name.

disconnect(string $name, mixed $listener) : mixed

Parameters

$name

string

An event name

$listener

mixed

A PHP callable

Returns

mixedfalse if listener does not exist, null otherwise

Filters a value by calling all listeners of a given event.

filter(sfEvent $event, mixed $value) : \sfEvent

Parameters

$event

\sfEvent

A sfEvent instance

$value

mixed

The value to be filtered

Returns

\sfEventThe sfEvent instance

Returns all listeners associated with a given event name.

getListeners(string $name) : array

Parameters

$name

string

The event name

Returns

arrayAn array of listeners

Returns true if the given event name has some listeners.

hasListeners(string $name) : Boolean

Parameters

$name

string

The event name

Returns

Booleantrue if some listeners are connected, false otherwise

Notifies all listeners of a given event.

notify(sfEvent $event) : \sfEvent

Parameters

$event

\sfEvent

A sfEvent instance

Returns

\sfEventThe sfEvent instance

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

notifyUntil(sfEvent $event) : \sfEvent

Parameters

$event

\sfEvent

A sfEvent instance

Returns

\sfEventThe sfEvent instance

 Properties

 

$listeners

$listeners