Zend Framework  1.12
Public Member Functions | List of all members
Zend_EventManager_EventCollection Interface Reference

Public Member Functions

 trigger ($event, $target=null, $argv=array(), $callback=null)
 Trigger an event.
 
 triggerUntil ($event, $target, $argv=null, $callback=null)
 Trigger an event until the given callback returns a boolean false.
 
 attach ($event, $callback=null, $priority=1)
 Attach a listener to an event.
 
 detach ($listener)
 Detach an event listener.
 
 getEvents ()
 Get a list of events for which this collection has listeners.
 
 getListeners ($event)
 Retrieve a list of listeners registered to a given event.
 
 clearListeners ($event)
 Clear all listeners for a given event.
 

Member Function Documentation

attach (   $event,
  $callback = null,
  $priority = 1 
)

Attach a listener to an event.

Parameters
string$event
callback$callback
int$priorityPriority at which to register listener
Returns
Zend_Stdlib_CallbackHandler

Implemented in Zend_EventManager_EventManager.

clearListeners (   $event)

Clear all listeners for a given event.

Parameters
string$event
Returns
void

Implemented in Zend_EventManager_EventManager.

detach (   $listener)

Detach an event listener.

Parameters
Zend_Stdlib_CallbackHandler | Zend_EventManager_ListenerAggregate$listener
Returns
void

Implemented in Zend_EventManager_EventManager.

getEvents ( )

Get a list of events for which this collection has listeners.

Returns
array

Implemented in Zend_EventManager_EventManager.

getListeners (   $event)

Retrieve a list of listeners registered to a given event.

Parameters
string$event
Returns
array|object

Implemented in Zend_EventManager_EventManager.

trigger (   $event,
  $target = null,
  $argv = array(),
  $callback = null 
)

Trigger an event.

Should allow handling the following scenarios:

  • Passing Event object only
  • Passing event name and Event object only
  • Passing event name, target, and Event object
  • Passing event name, target, and array|ArrayAccess of arguments

Can emulate triggerUntil() if the last argument provided is a callback.

Parameters
string$event
object | string$target
array | object$argv
null | callback$callback
Returns
Zend_EventManager_ResponseCollection

Implemented in Zend_EventManager_EventManager.

triggerUntil (   $event,
  $target,
  $argv = null,
  $callback = null 
)

Trigger an event until the given callback returns a boolean false.

Should allow handling the following scenarios:

  • Passing Event object and callback only
  • Passing event name, Event object, and callback only
  • Passing event name, target, Event object, and callback
  • Passing event name, target, array|ArrayAccess of arguments, and callback
Parameters
string$event
object | string$target
array | object$argv
callback$callback
Returns
Zend_EventManager_ResponseCollection

Implemented in Zend_EventManager_EventManager.