The above allows users to access the EventManager instance, or reset it with a new instance; if one does not
exist, it will be lazily instantiated on-demand.

An EventManager is really only interesting if it triggers some events. Basic triggering takes three arguments:
the event name, which is usually the current function/method name; the “context”, which is usually the current
object instance; and the arguments, which are usually the arguments provided to the current function/method.

In turn, triggering events is only interesting if something is listening for the event. Listeners attach to the
EventManager, specifying a named event and the callback to notify. The callback receives an Event object,
which has accessors for retrieving the event name, context, and parameters. Let’s add a listener, and trigger the
event.

Note that the second argument to attach() is any valid callback; an anonymous function is shown in the example
in order to keep the example self-contained. However, you could also utilize a valid function name, a functor, a
string referencing a static method, or an array callback with a named static method or instance method. Again, any
PHP callback is valid.

Sometimes you may want to specify listeners without yet having an object instance of the class composing an
EventManager. Zend Framework enables this through the concept of a SharedEventCollection. Simply put, you
can inject individual EventManager instances with a well-known SharedEventCollection, and the
EventManager instance will query it for additional listeners. Listeners attach to a SharedEventCollection
in roughly the same way the do normal event managers; the call to attach is identical to the EventManager,
but expects an additional parameter at the beginning: a named instance. Remember the example of composing an
EventManager, how we passed it __CLASS__? That value, or any strings you provide in an array to the
constructor, may be used to identify an instance when using a SharedEventCollection. As an example, assuming we
have a SharedEventManager instance that we know has been injected in our EventManager instances (for
instance, via dependency injection), we could change the above example to attach via the shared collection:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

useZend\Log\FactoryasLogFactory;// Assume $events is a Zend\EventManager\SharedEventManager instance$log=LogFactory($someConfig);$events->attach('Foo','bar',function($e)use($log){$event=$e->getName();$target=get_class($e->getTarget());$params=json_encode($e->getParams());$log->info(sprintf('%s called on %s, using params %s',$event,$target,$params));});// Later, instantiate Foo:$foo=newFoo();$foo->getEventManager()->setSharedEventCollection($events);// And we can still trigger the above event:$foo->bar('baz','bat');// results in log message:// bar called on Foo, using params {"baz" : "baz", "bat" : "bat"}"

Note

StaticEventManager

As of 2.0.0beta3, you can use the StaticEventManager singleton as a SharedEventCollection. As such, you
do not need to worry about where and how to get access to the SharedEventCollection; it’s globally available
by simply calling StaticEventManager::getInstance().

Be aware, however, that its usage is deprecated within the framework, and starting with 2.0.0beta4, you will
instead configure a SharedEventManager instance that will be injected by the framework into individual
EventManager instances.

The EventManager also provides the ability to detach listeners, short-circuit execution of an event either from
within a listener or by testing return values of listeners, test and loop through the results returned by
listeners, prioritize listeners, and more. Many of these features are detailed in the examples.

Sometimes you’ll want to attach the same listener to many events or to all events of a given instance – or
potentially, with a shared event collection, many contexts, and many events. The EventManager component allows
for this.

Note that if you specify a priority, that priority will be used for all events specified.

Attaching using the wildcard

1
2

$events=newEventManager();$events->attach('*',$callback);

Note that if you specify a priority, that priority will be used for this listener for any event triggered.

What the above specifies is that any event triggered will result in notification of this particular listener.

Attaching to many events at once via a SharedEventManager

1
2
3
4
5
6

$events=newSharedEventManager();// Attach to many events on the context "foo"$events->attach('foo',array('these','are','event','names'),$callback);// Attach to many events on the contexts "foo" and "bar"$events->attach(array('foo','bar'),array('these','are','event','names'),$callback);

Note that if you specify a priority, that priority will be used for all events specified.

Attaching to many events at once via a SharedEventManager

1
2
3
4
5
6

$events=newSharedEventManager();// Attach to all events on the context "foo"$events->attach('foo','*',$callback);// Attach to all events on the contexts "foo" and "bar"$events->attach(array('foo','bar'),'*',$callback);

Note that if you specify a priority, that priority will be used for all events specified.

The above is specifying that for the contexts “foo” and “bar”, the specified listener should be notified for any
event they trigger.

Constructs a new EventManager instance, using the given identifier, if provided, for purposes of shared
collections.

setEventClass

setEventClass(string$class)

Provide the name of an alternate Event class to use when creating events to pass to triggered listeners.

setSharedCollections

setSharedCollections(SharedEventCollection$collections=null)

An instance of a SharedEventCollection instance to use when triggering events.

getSharedCollections

getSharedCollections()

Returns the currently attached SharedEventCollection instance. Returns either a null if no collection is
attached, or a SharedEventCollection instance otherwise.

trigger

trigger(string$event,mixed$target,mixed$argv,callback$callback)

Triggers all listeners to a named event. The recommendation is to use the current function/method name for
$event, appending it with values such as ”.pre”, ”.post”, etc. as needed. $context should be the current
object instance, or the name of the function if not triggering within an object. $params should typically be
an associative array or ArrayAccess instance; we recommend using the parameters passed to the
function/method (compact() is often useful here). This method can also take a callback and behave in the
same way as triggerUntil().

The method returns an instance of ResponseCollection, which may be used to introspect return values of the
various listeners, test for short-circuiting, and more.

triggerUntil

triggerUntil(string$event,mixed$context,mixed$argv,callback$callback)

Triggers all listeners to a named event, just like trigger(), with the addition that it passes the return value from each
listener to $callback; if $callback returns a boolean true value, execution of the listeners is
interrupted. You can test for this using $result->stopped().

attach

attach(string$event,callback$callback,int$priority)

Attaches $callback to the EventManager instance, listening for the event $event. If a $priority
is provided, the listener will be inserted into the internal listener stack using that priority; higher values
execute earliest. (Default priority is “1”, and negative priorities are allowed.)

The method returns an instance of Zend\Stdlib\CallbackHandler; this value can later be passed to
detach() if desired.

attachAggregate

attachAggregate(string|ListenerAggregate$aggregate)

If a string is passed for $aggregate, instantiates that class. The $aggregate is then passed the
EventManager instance to its attach() method so that it may register listeners.

The ListenerAggregate instance is returned.

detach

detach(CallbackHandler$listener)

Scans all listeners, and detaches any that match $listener so that they will no longer be triggered.

Returns a boolean true if any listeners have been identified and unsubscribed, and a boolean false
otherwise.

detachAggregate

detachAggregate(ListenerAggregate$aggregate)

Loops through all listeners of all events to identify listeners that are represented by the aggregate; for all
matches, the listeners will be removed.

Returns a boolean true if any listeners have been identified and unsubscribed, and a boolean false
otherwise.

getEvents

getEvents()

Returns an array of all event names that have listeners attached.

getListeners

getListeners(string$event)

Returns a Zend\Stdlib\PriorityQueue instance of all listeners attached to $event.

clearListeners

clearListeners(string$event)

Removes all listeners attached to $event.

prepareArgs

prepareArgs(array$args)

Creates an ArrayObject from the provided $args. This can be useful if you want yours listeners to be
able to modify arguments such that later listeners or the triggering method can see the changes.

One common use case for events is to trigger listeners until either one indicates no further processing should be
done, or until a return value meets specific criteria. As examples, if an event creates a Response object, it may
want execution to stop.

1
2
3
4
5
6
7

$listener=function($e){// do some work// Stop propagation and return a response$e->stopPropagation(true);return$response;};

Alternately, we could do the check from the method triggering the event.

Typically, you may want to return a value that stopped execution, or use it some way. Both trigger() and
triggerUntil() return a ResponseCollection instance; call its stopped() method to test if execution was
stopped, and last() method to retrieve the return value from the last executed listener:

One use case for the EventManager is for implementing caching systems. As such, you often want to check the
cache early, and save to it late.

The third argument to attach() is a priority value. The higher this number, the earlier that listener will
execute; the lower it is, the later it executes. The value defaults to 1, and values will trigger in the order
registered within a given priority.

So, to implement a caching system, our method will need to trigger an event at method start as well as at method
end. At method start, we want an event that will trigger early; at method end, an event should trigger late.

Here is the class in which we want caching:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

classSomeValueObject{// assume it composes an event managerpublicfunctionget($id){$params=compact('id');$results=$this->getEventManager()->trigger('get.pre',$this,$params);// If an event stopped propagation, return the valueif($results->stopped()){return$results->last();}// do some work...$params['__RESULT__']=$someComputedContent;$this->getEventManager()->trigger('get.post',$this,$params);}}

Now, let’s create a ListenerAggregateInterface that can handle caching for us: