class EventDispatcher
Same name in this branch
- 11.1.x vendor/composer/composer/src/Composer/EventDispatcher/EventDispatcher.php \Composer\EventDispatcher\EventDispatcher
The EventDispatcherInterface is the central point of Symfony's event listener system.
Listeners are registered on the manager and events are dispatched through the manager.
@author Guilherme Blanco <guilhermeblanco@hotmail.com> @author Jonathan Wage <jonwage@gmail.com> @author Roman Borschel <roman@code-factory.org> @author Bernhard Schussek <bschussek@gmail.com> @author Fabien Potencier <fabien@symfony.com> @author Jordi Boggiano <j.boggiano@seld.be> @author Jordan Alliot <jordan.alliot@gmail.com> @author Nicolas Grekas <p@tchwork.com>
Hierarchy
- class \Symfony\Component\EventDispatcher\EventDispatcher implements \Symfony\Component\EventDispatcher\EventDispatcherInterface
Expanded class hierarchy of EventDispatcher
2 files declare their use of EventDispatcher
- RegisterListenersPass.php in vendor/
symfony/ event-dispatcher/ DependencyInjection/ RegisterListenersPass.php - TraceableEventDispatcher.php in vendor/
symfony/ event-dispatcher/ Debug/ TraceableEventDispatcher.php
File
-
vendor/
symfony/ event-dispatcher/ EventDispatcher.php, line 32
Namespace
Symfony\Component\EventDispatcherView source
class EventDispatcher implements EventDispatcherInterface {
private array $listeners = [];
private array $sorted = [];
private array $optimized;
public function __construct() {
if (__CLASS__ === static::class) {
$this->optimized = [];
}
}
public function dispatch(object $event, ?string $eventName = null) : object {
$eventName ??= $event::class;
if (isset($this->optimized)) {
$listeners = $this->optimized[$eventName] ?? (empty($this->listeners[$eventName]) ? [] : $this->optimizeListeners($eventName));
}
else {
$listeners = $this->getListeners($eventName);
}
if ($listeners) {
$this->callListeners($listeners, $eventName, $event);
}
return $event;
}
public function getListeners(?string $eventName = null) : array {
if (null !== $eventName) {
if (empty($this->listeners[$eventName])) {
return [];
}
if (!isset($this->sorted[$eventName])) {
$this->sortListeners($eventName);
}
return $this->sorted[$eventName];
}
foreach ($this->listeners as $eventName => $eventListeners) {
if (!isset($this->sorted[$eventName])) {
$this->sortListeners($eventName);
}
}
return array_filter($this->sorted);
}
public function getListenerPriority(string $eventName, callable|array $listener) : ?int {
if (empty($this->listeners[$eventName])) {
return null;
}
if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
$listener[0] = $listener[0]();
$listener[1] ??= '__invoke';
}
foreach ($this->listeners[$eventName] as $priority => &$listeners) {
foreach ($listeners as &$v) {
if ($v !== $listener && \is_array($v) && isset($v[0]) && $v[0] instanceof \Closure && 2 >= \count($v)) {
$v[0] = $v[0]();
$v[1] ??= '__invoke';
}
if ($v === $listener || $listener instanceof \Closure && $v == $listener) {
return $priority;
}
}
}
return null;
}
public function hasListeners(?string $eventName = null) : bool {
if (null !== $eventName) {
return !empty($this->listeners[$eventName]);
}
foreach ($this->listeners as $eventListeners) {
if ($eventListeners) {
return true;
}
}
return false;
}
public function addListener(string $eventName, callable|array $listener, int $priority = 0) : void {
$this->listeners[$eventName][$priority][] = $listener;
unset($this->sorted[$eventName], $this->optimized[$eventName]);
}
public function removeListener(string $eventName, callable|array $listener) : void {
if (empty($this->listeners[$eventName])) {
return;
}
if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
$listener[0] = $listener[0]();
$listener[1] ??= '__invoke';
}
foreach ($this->listeners[$eventName] as $priority => &$listeners) {
foreach ($listeners as $k => &$v) {
if ($v !== $listener && \is_array($v) && isset($v[0]) && $v[0] instanceof \Closure && 2 >= \count($v)) {
$v[0] = $v[0]();
$v[1] ??= '__invoke';
}
if ($v === $listener || $listener instanceof \Closure && $v == $listener) {
unset($listeners[$k], $this->sorted[$eventName], $this->optimized[$eventName]);
}
}
if (!$listeners) {
unset($this->listeners[$eventName][$priority]);
}
}
}
public function addSubscriber(EventSubscriberInterface $subscriber) : void {
foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
if (\is_string($params)) {
$this->addListener($eventName, [
$subscriber,
$params,
]);
}
elseif (\is_string($params[0])) {
$this->addListener($eventName, [
$subscriber,
$params[0],
], $params[1] ?? 0);
}
else {
foreach ($params as $listener) {
$this->addListener($eventName, [
$subscriber,
$listener[0],
], $listener[1] ?? 0);
}
}
}
}
public function removeSubscriber(EventSubscriberInterface $subscriber) : void {
foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
if (\is_array($params) && \is_array($params[0])) {
foreach ($params as $listener) {
$this->removeListener($eventName, [
$subscriber,
$listener[0],
]);
}
}
else {
$this->removeListener($eventName, [
$subscriber,
\is_string($params) ? $params : $params[0],
]);
}
}
}
/**
* Triggers the listeners of an event.
*
* This method can be overridden to add functionality that is executed
* for each listener.
*
* @param callable[] $listeners The event listeners
* @param string $eventName The name of the event to dispatch
* @param object $event The event object to pass to the event handlers/listeners
*/
protected function callListeners(iterable $listeners, string $eventName, object $event) : void {
$stoppable = $event instanceof StoppableEventInterface;
foreach ($listeners as $listener) {
if ($stoppable && $event->isPropagationStopped()) {
break;
}
$listener($event, $eventName, $this);
}
}
/**
* Sorts the internal list of listeners for the given event by priority.
*/
private function sortListeners(string $eventName) : void {
krsort($this->listeners[$eventName]);
$this->sorted[$eventName] = [];
foreach ($this->listeners[$eventName] as &$listeners) {
foreach ($listeners as &$listener) {
if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
$listener[0] = $listener[0]();
$listener[1] ??= '__invoke';
}
$this->sorted[$eventName][] = $listener;
}
}
}
/**
* Optimizes the internal list of listeners for the given event by priority.
*/
private function optimizeListeners(string $eventName) : array {
krsort($this->listeners[$eventName]);
$this->optimized[$eventName] = [];
foreach ($this->listeners[$eventName] as &$listeners) {
foreach ($listeners as &$listener) {
$closure =& $this->optimized[$eventName][];
if (\is_array($listener) && isset($listener[0]) && $listener[0] instanceof \Closure && 2 >= \count($listener)) {
$closure = static function (...$args) use (&$listener, &$closure) {
if ($listener[0] instanceof \Closure) {
$listener[0] = $listener[0]();
$listener[1] ??= '__invoke';
}
($closure = $listener(...))(...$args);
};
}
else {
$closure = $listener instanceof WrappedListener ? $listener : $listener(...);
}
}
}
return $this->optimized[$eventName];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
EventDispatcher::$listeners | private | property | 1 | ||
EventDispatcher::$optimized | private | property | |||
EventDispatcher::$sorted | private | property | |||
EventDispatcher::addListener | public | function | Adds an event listener that listens on the specified events. | Overrides EventDispatcherInterface::addListener | 1 |
EventDispatcher::addSubscriber | public | function | Adds an event subscriber. | Overrides EventDispatcherInterface::addSubscriber | |
EventDispatcher::callListeners | protected | function | Triggers the listeners of an event. | ||
EventDispatcher::dispatch | public | function | Dispatches an event to all registered listeners. | Overrides EventDispatcherInterface::dispatch | |
EventDispatcher::getListenerPriority | public | function | Gets the listener priority for a specific event. | Overrides EventDispatcherInterface::getListenerPriority | |
EventDispatcher::getListeners | public | function | Gets the listeners of a specific event or all listeners sorted by descending priority. | Overrides EventDispatcherInterface::getListeners | |
EventDispatcher::hasListeners | public | function | Checks whether an event has any registered listeners. | Overrides EventDispatcherInterface::hasListeners | |
EventDispatcher::optimizeListeners | private | function | Optimizes the internal list of listeners for the given event by priority. | ||
EventDispatcher::removeListener | public | function | Removes an event listener from the specified events. | Overrides EventDispatcherInterface::removeListener | |
EventDispatcher::removeSubscriber | public | function | Overrides EventDispatcherInterface::removeSubscriber | ||
EventDispatcher::sortListeners | private | function | Sorts the internal list of listeners for the given event by priority. | ||
EventDispatcher::__construct | public | function |