Zend Framework  3.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
EventManager Class Reference

Event manager: notification system. More...

Public Member Functions

 __construct (SharedEventManagerInterface $sharedEventManager=null, array $identifiers=[])
 Constructor.
 
 setEventPrototype (EventInterface $prototype)
 
 
 getSharedManager ()
 Retrieve the shared event manager, if composed.
 
 getIdentifiers ()
 
 
 setIdentifiers (array $identifiers)
 
 
 addIdentifiers (array $identifiers)
 
 
 trigger ($eventName, $target=null, $argv=[])
 
 
 triggerUntil (callable $callback, $eventName, $target=null, $argv=[])
 
 
 triggerEvent (EventInterface $event)
 
 
 triggerEventUntil (callable $callback, EventInterface $event)
 
 
 attach ($eventName, callable $listener, $priority=1)
 
 
 detach (callable $listener, $eventName=null, $force=false)
 
 
 clearListeners ($event)
 
 
 prepareArgs (array $args)
 Prepare arguments.
 
- Public Member Functions inherited from EventManagerInterface
 detach (callable $listener, $eventName=null)
 Detach a listener.
 

Protected Member Functions

 triggerListeners (EventInterface $event, callable $callback=null)
 Trigger listeners.
 

Protected Attributes

 $events = []
 
 $eventPrototype
 
 $identifiers = []
 
 $sharedManager = null
 

Detailed Description

Event manager: notification system.

Use the EventManager when you want to create a per-instance notification system for your objects.

Constructor & Destructor Documentation

__construct ( SharedEventManagerInterface  $sharedEventManager = null,
array  $identifiers = [] 
)

Constructor.

Allows optionally specifying identifier(s) to use to pull signals from a SharedEventManagerInterface.

Parameters
SharedEventManagerInterface$sharedEventManager
array$identifiers

Member Function Documentation

addIdentifiers ( array  $identifiers)

Implements EventManagerInterface.

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

Implements EventManagerInterface.

clearListeners (   $event)

Implements EventManagerInterface.

detach ( callable  $listener,
  $eventName = null,
  $force = false 
)

Exceptions
Exception\InvalidArgumentExceptionfor invalid event types.
getIdentifiers ( )

Implements EventManagerInterface.

getSharedManager ( )

Retrieve the shared event manager, if composed.

Returns
null|SharedEventManagerInterface $sharedEventManager

Implements SharedEventsCapableInterface.

prepareArgs ( array  $args)

Prepare arguments.

Use this method if you want to be able to modify arguments from within a listener. It returns an ArrayObject of the arguments, which may then be passed to trigger().

Parameters
array$args
Returns
ArrayObject
setEventPrototype ( EventInterface  $prototype)

Implements EventManagerInterface.

setIdentifiers ( array  $identifiers)

Implements EventManagerInterface.

EventInterface Prototype to use when creating an event at trigger (   $eventName,
  $target = null,
  $argv = [] 
)

Implements EventManagerInterface.

triggerEvent ( EventInterface  $event)

Implements EventManagerInterface.

triggerEventUntil ( callable  $callback,
EventInterface  $event 
)

Implements EventManagerInterface.

triggerListeners ( EventInterface  $event,
callable  $callback = null 
)
protected

Trigger listeners.

Actual functionality for triggering listeners, to which trigger() delegate.

Parameters
EventInterface$event
null | callable$callback
Returns
ResponseCollection
triggerUntil ( callable  $callback,
  $eventName,
  $target = null,
  $argv = [] 
)

Implements EventManagerInterface.

Member Data Documentation

$eventPrototype
protected
$events = []
protected
$identifiers = []
protected
$sharedManager = null
protected