$dispatcher
$dispatcher :
A read-only proxy for an event dispatcher.
__construct(\Symfony\Component\EventDispatcher\EventDispatcherInterface $dispatcher)
| \Symfony\Component\EventDispatcher\EventDispatcherInterface | $dispatcher |
dispatch(string $eventName, \Symfony\Component\EventDispatcher\Event $event = null) : \Symfony\Component\EventDispatcher\Event
Dispatches an event to all registered listeners.
| string | $eventName | The name of the event to dispatch. The name of the event is the name of the method that is invoked on listeners. |
| \Symfony\Component\EventDispatcher\Event | $event | The event to pass to the event handlers/listeners If not supplied, an empty Event instance is created |
addListener(string $eventName, callable $listener, integer $priority)
Adds an event listener that listens on the specified events.
| string | $eventName | The event to listen on |
| callable | $listener | The listener |
| integer | $priority | The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0) |
addSubscriber(\Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber)
Adds an event subscriber.
The subscriber is asked for all the events he is interested in and added as a listener for these events.
| \Symfony\Component\EventDispatcher\EventSubscriberInterface | $subscriber |
removeSubscriber(\Symfony\Component\EventDispatcher\EventSubscriberInterface $subscriber)
| \Symfony\Component\EventDispatcher\EventSubscriberInterface | $subscriber |
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\EventDispatcher;
/**
* A read-only proxy for an event dispatcher.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class ImmutableEventDispatcher implements EventDispatcherInterface
{
private $dispatcher;
public function __construct(EventDispatcherInterface $dispatcher)
{
$this->dispatcher = $dispatcher;
}
/**
* {@inheritdoc}
*/
public function dispatch($eventName, Event $event = null)
{
return $this->dispatcher->dispatch($eventName, $event);
}
/**
* {@inheritdoc}
*/
public function addListener($eventName, $listener, $priority = 0)
{
throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
}
/**
* {@inheritdoc}
*/
public function addSubscriber(EventSubscriberInterface $subscriber)
{
throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
}
/**
* {@inheritdoc}
*/
public function removeListener($eventName, $listener)
{
throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
}
/**
* {@inheritdoc}
*/
public function removeSubscriber(EventSubscriberInterface $subscriber)
{
throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
}
/**
* {@inheritdoc}
*/
public function getListeners($eventName = null)
{
return $this->dispatcher->getListeners($eventName);
}
/**
* {@inheritdoc}
*/
public function getListenerPriority($eventName, $listener)
{
return $this->dispatcher->getListenerPriority($eventName, $listener);
}
/**
* {@inheritdoc}
*/
public function hasListeners($eventName = null)
{
return $this->dispatcher->hasListeners($eventName);
}
}