class ImmutableEventDispatcher in Zircon Profile 8

A read-only proxy for an event dispatcher.

@author Bernhard Schussek <[e-mail]>

Hierarchy

• class \Symfony\Component\EventDispatcher\ImmutableEventDispatcher implements EventDispatcherInterface

1 file declares its use of ImmutableEventDispatcher

ImmutableEventDispatcherTest.php in vendor/symfony/event-dispatcher/Tests/ImmutableEventDispatcherTest.php

File

vendor/symfony/event-dispatcher/ImmutableEventDispatcher.php, line 19

Namespace

Symfony\Component\EventDispatcher

class ImmutableEventDispatcher implements EventDispatcherInterface {

  /**
   * The proxied dispatcher.
   *
   * @var EventDispatcherInterface
   */
  private $dispatcher;

  /**
   * Creates an unmodifiable proxy for an event dispatcher.
   *
   * @param EventDispatcherInterface $dispatcher The proxied event 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 hasListeners($eventName = null) {
    return $this->dispatcher
      ->hasListeners($eventName);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ImmutableEventDispatcher::$dispatcher	private	property	The proxied dispatcher.
ImmutableEventDispatcher::addListener	public	function	Adds an event listener that listens on the specified events. Overrides EventDispatcherInterface::addListener
ImmutableEventDispatcher::addSubscriber	public	function	Adds an event subscriber. Overrides EventDispatcherInterface::addSubscriber
ImmutableEventDispatcher::dispatch	public	function	Dispatches an event to all registered listeners. Overrides EventDispatcherInterface::dispatch
ImmutableEventDispatcher::getListeners	public	function	Gets the listeners of a specific event or all listeners sorted by descending priority. Overrides EventDispatcherInterface::getListeners
ImmutableEventDispatcher::hasListeners	public	function	Checks whether an event has any registered listeners. Overrides EventDispatcherInterface::hasListeners
ImmutableEventDispatcher::removeListener	public	function	Removes an event listener from the specified events. Overrides EventDispatcherInterface::removeListener
ImmutableEventDispatcher::removeSubscriber	public	function	Removes an event subscriber. Overrides EventDispatcherInterface::removeSubscriber
ImmutableEventDispatcher::__construct	public	function	Creates an unmodifiable proxy for an event dispatcher.