Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ImmutableEventDispatcher.php

class ImmutableEventDispatcher

A read-only proxy for an event dispatcher.

@author Bernhard Schussek <bschussek@gmail.com>

Hierarchy

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

Expanded class hierarchy of ImmutableEventDispatcher

File

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

Namespace

Symfony\Component\EventDispatcher
View source
class ImmutableEventDispatcher implements EventDispatcherInterface {
    public function __construct(EventDispatcherInterface $dispatcher) {
    }
    public function dispatch(object $event, ?string $eventName = null) : object {
        return $this->dispatcher
            ->dispatch($event, $eventName);
    }
    public function addListener(string $eventName, callable|array $listener, int $priority = 0) : never {
        throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
    }
    public function addSubscriber(EventSubscriberInterface $subscriber) : never {
        throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
    }
    public function removeListener(string $eventName, callable|array $listener) : never {
        throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
    }
    public function removeSubscriber(EventSubscriberInterface $subscriber) : never {
        throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
    }
    public function getListeners(?string $eventName = null) : array {
        return $this->dispatcher
            ->getListeners($eventName);
    }
    public function getListenerPriority(string $eventName, callable|array $listener) : ?int {
        return $this->dispatcher
            ->getListenerPriority($eventName, $listener);
    }
    public function hasListeners(?string $eventName = null) : bool {
        return $this->dispatcher
            ->hasListeners($eventName);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
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::getListenerPriority public function Gets the listener priority for a specific event. Overrides EventDispatcherInterface::getListenerPriority
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 Overrides EventDispatcherInterface::removeSubscriber
ImmutableEventDispatcher::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal