[Components] Convert to native return types

Author: wouterj

Debug/TraceableEventDispatcher.php

@@ -51,26 +51,17 @@ public function __construct(EventDispatcherInterface $dispatcher, Stopwatch $sto
         $this->requestStack = $requestStack;
     }
 
-    /**
-     * @return void
-     */
-    public function addListener(string $eventName, callable|array $listener, int $priority = 0)
+    public function addListener(string $eventName, callable|array $listener, int $priority = 0): void
     {
         $this->dispatcher->addListener($eventName, $listener, $priority);
     }
 
-    /**
-     * @return void
-     */
-    public function addSubscriber(EventSubscriberInterface $subscriber)
+    public function addSubscriber(EventSubscriberInterface $subscriber): void
     {
         $this->dispatcher->addSubscriber($subscriber);
     }
 
-    /**
-     * @return void
-     */
-    public function removeListener(string $eventName, callable|array $listener)
+    public function removeListener(string $eventName, callable|array $listener): void
     {
         if (isset($this->wrappedListeners[$eventName])) {
             foreach ($this->wrappedListeners[$eventName] as $index => $wrappedListener) {
@@ -85,10 +76,7 @@ public function removeListener(string $eventName, callable|array $listener)
         $this->dispatcher->removeListener($eventName, $listener);
     }
 
-    /**
-     * @return void
-     */
-    public function removeSubscriber(EventSubscriberInterface $subscriber)
+    public function removeSubscriber(EventSubscriberInterface $subscriber): void
     {
         $this->dispatcher->removeSubscriber($subscriber);
     }
@@ -226,10 +214,7 @@ public function getOrphanedEvents(Request $request = null): array
         return array_merge(...array_values($this->orphanedEvents));
     }
 
-    /**
-     * @return void
-     */
-    public function reset()
+    public function reset(): void
     {
         $this->callStack = null;
         $this->orphanedEvents = [];
@@ -249,19 +234,15 @@ public function __call(string $method, array $arguments): mixed
 
     /**
      * Called before dispatching the event.
-     *
-     * @return void
      */
-    protected function beforeDispatch(string $eventName, object $event)
+    protected function beforeDispatch(string $eventName, object $event): void
     {
     }
 
     /**
      * Called after dispatching the event.
-     *
-     * @return void
      */
-    protected function afterDispatch(string $eventName, object $event)
+    protected function afterDispatch(string $eventName, object $event): void
     {
     }
 

DependencyInjection/RegisterListenersPass.php

@@ -48,10 +48,7 @@ public function setNoPreloadEvents(array $noPreloadEvents): static
         return $this;
     }
 
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('event_dispatcher') && !$container->hasAlias('event_dispatcher')) {
             return;

EventDispatcher.php

@@ -123,19 +123,13 @@ public function hasListeners(string $eventName = null): bool
         return false;
     }
 
-    /**
-     * @return void
-     */
-    public function addListener(string $eventName, callable|array $listener, int $priority = 0)
+    public function addListener(string $eventName, callable|array $listener, int $priority = 0): void
     {
         $this->listeners[$eventName][$priority][] = $listener;
         unset($this->sorted[$eventName], $this->optimized[$eventName]);
     }
 
-    /**
-     * @return void
-     */
-    public function removeListener(string $eventName, callable|array $listener)
+    public function removeListener(string $eventName, callable|array $listener): void
     {
         if (empty($this->listeners[$eventName])) {
             return;
@@ -163,10 +157,7 @@ public function removeListener(string $eventName, callable|array $listener)
         }
     }
 
-    /**
-     * @return void
-     */
-    public function addSubscriber(EventSubscriberInterface $subscriber)
+    public function addSubscriber(EventSubscriberInterface $subscriber): void
     {
         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
             if (\is_string($params)) {
@@ -181,10 +172,7 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
         }
     }
 
-    /**
-     * @return void
-     */
-    public function removeSubscriber(EventSubscriberInterface $subscriber)
+    public function removeSubscriber(EventSubscriberInterface $subscriber): void
     {
         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
             if (\is_array($params) && \is_array($params[0])) {
@@ -206,10 +194,8 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
      * @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
-     *
-     * @return void
      */
-    protected function callListeners(iterable $listeners, string $eventName, object $event)
+    protected function callListeners(iterable $listeners, string $eventName, object $event): void
     {
         $stoppable = $event instanceof StoppableEventInterface;
 

EventDispatcherInterface.php

@@ -27,32 +27,23 @@ interface EventDispatcherInterface extends ContractsEventDispatcherInterface
      *
      * @param int $priority The higher this value, the earlier an event
      *                      listener will be triggered in the chain (defaults to 0)
-     *
-     * @return void
      */
-    public function addListener(string $eventName, callable $listener, int $priority = 0);
+    public function addListener(string $eventName, callable $listener, int $priority = 0): void;
 
     /**
      * Adds an event subscriber.
      *
      * The subscriber is asked for all the events it is
      * interested in and added as a listener for these events.
-     *
-     * @return void
      */
-    public function addSubscriber(EventSubscriberInterface $subscriber);
+    public function addSubscriber(EventSubscriberInterface $subscriber): void;
 
     /**
      * Removes an event listener from the specified events.
-     *
-     * @return void
      */
-    public function removeListener(string $eventName, callable $listener);
+    public function removeListener(string $eventName, callable $listener): void;
 
-    /**
-     * @return void
-     */
-    public function removeSubscriber(EventSubscriberInterface $subscriber);
+    public function removeSubscriber(EventSubscriberInterface $subscriber): void;
 
     /**
      * Gets the listeners of a specific event or all listeners sorted by descending priority.

EventSubscriberInterface.php

@@ -45,5 +45,5 @@ interface EventSubscriberInterface
      *
      * @return array<string, string|array{0: string, 1: int}|list<array{0: string, 1?: int}>>
      */
-    public static function getSubscribedEvents();
+    public static function getSubscribedEvents(): array;
 }

ImmutableEventDispatcher.php

@@ -30,34 +30,22 @@ public function dispatch(object $event, string $eventName = null): object
         return $this->dispatcher->dispatch($event, $eventName);
     }
 
-    /**
-     * @return never
-     */
-    public function addListener(string $eventName, callable|array $listener, int $priority = 0)
+    public function addListener(string $eventName, callable|array $listener, int $priority = 0): never
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }
 
-    /**
-     * @return never
-     */
-    public function addSubscriber(EventSubscriberInterface $subscriber)
+    public function addSubscriber(EventSubscriberInterface $subscriber): never
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }
 
-    /**
-     * @return never
-     */
-    public function removeListener(string $eventName, callable|array $listener)
+    public function removeListener(string $eventName, callable|array $listener): never
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }
 
-    /**
-     * @return never
-     */
-    public function removeSubscriber(EventSubscriberInterface $subscriber)
+    public function removeSubscriber(EventSubscriberInterface $subscriber): never
     {
         throw new \BadMethodCallException('Unmodifiable event dispatchers must not be modified.');
     }