Zend Framework  3.0
Public Member Functions | List of all members
SharedEventManagerInterface Interface Reference

Interface for shared event listener collections. More...

Public Member Functions

 attach ($identifier, $eventName, callable $listener, $priority=1)
 Attach a listener to an event emitted by components with specific identifiers.
 
 detach (callable $listener, $identifier=null, $eventName=null)
 Detach a shared listener.
 
 getListeners (array $identifiers, $eventName)
 Retrieve all listeners for given identifiers.
 
 clearListeners ($identifier, $eventName=null)
 Clear all listeners for a given identifier, optionally for a specific event.
 

Detailed Description

Interface for shared event listener collections.

Member Function Documentation

attach (   $identifier,
  $eventName,
callable  $listener,
  $priority = 1 
)

Attach a listener to an event emitted by components with specific identifiers.

Parameters
string$identifierIdentifier for event emitting component
string$eventName
callable$listenerListener that will handle the event.
int$priorityPriority at which listener should execute

Implemented in SharedEventManager.

clearListeners (   $identifier,
  $eventName = null 
)

Clear all listeners for a given identifier, optionally for a specific event.

Parameters
string$identifier
null | string$eventName

Implemented in SharedEventManager.

detach ( callable  $listener,
  $identifier = null,
  $eventName = null 
)

Detach a shared listener.

Allows detaching a listener from one or more events to which it may be attached.

Parameters
callable$listenerListener to detach.
null | string$identifierIdentifier from which to detach; null indicates all registered identifiers.
null | string$eventNameEvent from which to detach; null indicates all registered events.
Exceptions
Exception\InvalidArgumentExceptionfor invalid identifier arguments.
Exception\InvalidArgumentExceptionfor invalid event arguments.
getListeners ( array  $identifiers,
  $eventName 
)

Retrieve all listeners for given identifiers.

Parameters
array$identifiers
string$eventName
Returns
array

Implemented in SharedEventManager.