Interface for messengers

category Zend
package Zend_EventManager
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Attach a listener to an event

attach(string $event, callback $callback = null, integer $priority = 1) : \Zend_Stdlib_CallbackHandler

Parameters

$event

string

$callback

callback

$priority

integer

Priority at which to register listener

Returns

\Zend_Stdlib_CallbackHandler

Clear all listeners for a given event

clearListeners(string $event) : void

Parameters

$event

string

Detach an event listener

detach(\Zend_Stdlib_CallbackHandler|\Zend_EventManager_ListenerAggregate $listener) : void

Parameters

$listener

\Zend_Stdlib_CallbackHandler\Zend_EventManager_ListenerAggregate

Get a list of events for which this collection has listeners

getEvents() : array

Returns

array

Retrieve a list of listeners registered to a given event

getListeners(string $event) : array | object

Parameters

$event

string

Returns

arrayobject

Trigger an event

trigger(string $event, object|string $target = null, array|object $argv = array(), null|callback $callback = null) : \Zend_EventManager_ResponseCollection

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

$event

string

$target

objectstring

$argv

arrayobject

$callback

nullcallback

Returns

\Zend_EventManager_ResponseCollection

Trigger an event until the given callback returns a boolean false

triggerUntil(string $event, object|string $target, array|object $argv = null, callback $callback = null) : \Zend_EventManager_ResponseCollection

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

$event

string

$target

objectstring

$argv

arrayobject

$callback

callback

Returns

\Zend_EventManager_ResponseCollection