Zend Framework
Back to top  

Static version of EventManager

Allows attaching to EMs composed by other classes without having an instance first. The assumption is that the SharedEventManager will be injected into EventManager instances, and then queried for additional listeners when triggering an event.

 Methods

Attach a listener to an event

attach(string | array $id, string $event, \Zend\EventManager\callable $callback, int $priority) : \Zend\Stdlib\CallbackHandler | array
Inherited

Allows attaching a callback to an event offered by one or more identifying components. As an example, the following connects to the "getAll" event of both an AbstractResource and EntityResource:

$sharedEventManager = new SharedEventManager();
$sharedEventManager->attach(
    array('My\Resource\AbstractResource', 'My\Resource\EntityResource'),
    'getAll',
    function ($e) use ($cache) {
        if (!$id = $e->getParam('id', false)) {
            return;
        }
        if (!$data = $cache->load(get_class($resource) . '::getOne::' . $id )) {
            return;
        }
        return $data;
    }
);

inherited_from \Zend\EventManager\SharedEventManager::attach()

Parameters

$id

stringarray

Identifier(s) for event emitting component(s)

$event

string

$callback

\Zend\EventManager\callable

PHP Callback

$priority

int

Priority at which listener should execute

Returns

\Zend\Stdlib\CallbackHandlerarrayEither CallbackHandler or array of CallbackHandlers

Attach a listener aggregate

attachAggregate(\Zend\EventManager\SharedListenerAggregateInterface $aggregate, int $priority) : mixed
Inherited

Listener aggregates accept an EventManagerInterface instance, and call attachShared() one or more times, typically to attach to multiple events using local methods.

inherited_from \Zend\EventManager\SharedEventManager::attachAggregate()

Parameters

$aggregate

\Zend\EventManager\SharedListenerAggregateInterface

$priority

int

If provided, a suggested priority for the aggregate to use

Returns

mixedreturn value of {@link ListenerAggregateInterface::attachShared()}

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

clearListeners(string | int $id, null | string $event) : bool
Inherited

inherited_from \Zend\EventManager\SharedEventManager::clearListeners()

Parameters

$id

stringint

$event

nullstring

Returns

bool

Detach a listener from an event offered by a given resource

detach(string | int $id, \Zend\Stdlib\CallbackHandler $listener) : bool
Inherited

inherited_from \Zend\EventManager\SharedEventManager::detach()

Parameters

$id

stringint

$listener

\Zend\Stdlib\CallbackHandler

Returns

boolReturns true if event and listener found, and unsubscribed; returns false if either event or listener not found

Detach a listener aggregate

detachAggregate(\Zend\EventManager\SharedListenerAggregateInterface $aggregate) : mixed
Inherited

Listener aggregates accept a SharedEventManagerInterface instance, and call detachShared() of all previously attached listeners.

inherited_from \Zend\EventManager\SharedEventManager::detachAggregate()

Parameters

$aggregate

\Zend\EventManager\SharedListenerAggregateInterface

Returns

mixedreturn value of {@link SharedListenerAggregateInterface::detachShared()}

Retrieve all registered events for a given resource

getEvents(string | int $id) : array
Inherited

inherited_from \Zend\EventManager\SharedEventManager::getEvents()

Parameters

$id

stringint

Returns

array

Retrieve instance

getInstance() : \Zend\EventManager\StaticEventManager

Returns

\Zend\EventManager\StaticEventManager

Retrieve all listeners for a given identifier and event

getListeners(string | int $id, string | int $event) : false | \Zend\Stdlib\PriorityQueue
Inherited

inherited_from \Zend\EventManager\SharedEventManager::getListeners()

Parameters

$id

stringint

$event

stringint

Returns

false\Zend\Stdlib\PriorityQueue

Is a singleton instance defined?

hasInstance() : bool

Returns

bool

Reset the singleton instance

resetInstance() : void

Set the singleton to a specific SharedEventManagerInterface instance

setInstance(\Zend\EventManager\SharedEventManagerInterface $instance) : void

Parameters

$instance

\Zend\EventManager\SharedEventManagerInterface

Singleton

__construct() 

Singleton

__clone() : void

 Properties

 

Identifiers with event connections

$identifiers : array
Inherited

inherited_from \Zend\EventManager\SharedEventManager::$$identifiers
 

$instance

$instance : \Zend\EventManager\SharedEventManagerInterface