Add return types - batch 5/n

Author: nicolas-grekas

Debug/TraceableEventDispatcher.php

@@ -92,15 +92,15 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
     /**
      * {@inheritdoc}
      */
-    public function getListeners(string $eventName = null)
+    public function getListeners(string $eventName = null): array
     {
         return $this->dispatcher->getListeners($eventName);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getListenerPriority(string $eventName, callable|array $listener)
+    public function getListenerPriority(string $eventName, callable|array $listener): ?int
     {
         // we might have wrapped listeners for the event (if called while dispatching)
         // in that case get the priority by wrapper
@@ -118,7 +118,7 @@ public function getListenerPriority(string $eventName, callable|array $listener)
     /**
      * {@inheritdoc}
      */
-    public function hasListeners(string $eventName = null)
+    public function hasListeners(string $eventName = null): bool
     {
         return $this->dispatcher->hasListeners($eventName);
     }
@@ -163,10 +163,7 @@ public function dispatch(object $event, string $eventName = null): object
         return $event;
     }
 
-    /**
-     * @return array
-     */
-    public function getCalledListeners(Request $request = null)
+    public function getCalledListeners(Request $request = null): array
     {
         if (null === $this->callStack) {
             return [];
@@ -184,10 +181,7 @@ public function getCalledListeners(Request $request = null)
         return $called;
     }
 
-    /**
-     * @return array
-     */
-    public function getNotCalledListeners(Request $request = null)
+    public function getNotCalledListeners(Request $request = null): array
     {
         try {
             $allListeners = $this->getListeners();
@@ -255,10 +249,8 @@ public function reset()
      *
      * @param string $method    The method name
      * @param array  $arguments The method arguments
-     *
-     * @return mixed
      */
-    public function __call(string $method, array $arguments)
+    public function __call(string $method, array $arguments): mixed
     {
         return $this->dispatcher->{$method}(...$arguments);
     }

DependencyInjection/RegisterListenersPass.php

@@ -31,7 +31,7 @@ class RegisterListenersPass implements CompilerPassInterface
     /**
      * @return $this
      */
-    public function setHotPathEvents(array $hotPathEvents)
+    public function setHotPathEvents(array $hotPathEvents): static
     {
         $this->hotPathEvents = array_flip($hotPathEvents);
 
@@ -41,7 +41,7 @@ public function setHotPathEvents(array $hotPathEvents)
     /**
      * @return $this
      */
-    public function setNoPreloadEvents(array $noPreloadEvents): self
+    public function setNoPreloadEvents(array $noPreloadEvents): static
     {
         $this->noPreloadEvents = array_flip($noPreloadEvents);
 

EventDispatcher.php

@@ -65,7 +65,7 @@ public function dispatch(object $event, string $eventName = null): object
     /**
      * {@inheritdoc}
      */
-    public function getListeners(string $eventName = null)
+    public function getListeners(string $eventName = null): array
     {
         if (null !== $eventName) {
             if (empty($this->listeners[$eventName])) {
@@ -91,7 +91,7 @@ public function getListeners(string $eventName = null)
     /**
      * {@inheritdoc}
      */
-    public function getListenerPriority(string $eventName, callable|array $listener)
+    public function getListenerPriority(string $eventName, callable|array $listener): ?int
     {
         if (empty($this->listeners[$eventName])) {
             return null;
@@ -120,7 +120,7 @@ public function getListenerPriority(string $eventName, callable|array $listener)
     /**
      * {@inheritdoc}
      */
-    public function hasListeners(string $eventName = null)
+    public function hasListeners(string $eventName = null): bool
     {
         if (null !== $eventName) {
             return !empty($this->listeners[$eventName]);

EventDispatcherInterface.php

@@ -50,7 +50,7 @@ public function removeSubscriber(EventSubscriberInterface $subscriber);
      *
      * @return array The event listeners for the specified event, or all event listeners by event name
      */
-    public function getListeners(string $eventName = null);
+    public function getListeners(string $eventName = null): array;
 
     /**
      * Gets the listener priority for a specific event.
@@ -59,12 +59,12 @@ public function getListeners(string $eventName = null);
      *
      * @return int|null The event listener priority
      */
-    public function getListenerPriority(string $eventName, callable $listener);
+    public function getListenerPriority(string $eventName, callable $listener): ?int;
 
     /**
      * Checks whether an event has any registered listeners.
      *
      * @return bool true if the specified event has any listeners, false otherwise
      */
-    public function hasListeners(string $eventName = null);
+    public function hasListeners(string $eventName = null): bool;
 }

GenericEvent.php

@@ -42,7 +42,7 @@ public function __construct(mixed $subject = null, array $arguments = [])
      *
      * @return mixed The observer subject
      */
-    public function getSubject()
+    public function getSubject(): mixed
     {
         return $this->subject;
     }
@@ -54,7 +54,7 @@ public function getSubject()
      *
      * @throws \InvalidArgumentException if key is not found
      */
-    public function getArgument(string $key)
+    public function getArgument(string $key): mixed
     {
         if ($this->hasArgument($key)) {
             return $this->arguments[$key];
@@ -68,7 +68,7 @@ public function getArgument(string $key)
      *
      * @return $this
      */
-    public function setArgument(string $key, mixed $value)
+    public function setArgument(string $key, mixed $value): static
     {
         $this->arguments[$key] = $value;
 
@@ -77,10 +77,8 @@ public function setArgument(string $key, mixed $value)
 
     /**
      * Getter for all arguments.
-     *
-     * @return array
      */
-    public function getArguments()
+    public function getArguments(): array
     {
         return $this->arguments;
     }
@@ -90,7 +88,7 @@ public function getArguments()
      *
      * @return $this
      */
-    public function setArguments(array $args = [])
+    public function setArguments(array $args = []): static
     {
         $this->arguments = $args;
 
@@ -99,10 +97,8 @@ public function setArguments(array $args = [])
 
     /**
      * Has argument.
-     *
-     * @return bool
      */
-    public function hasArgument(string $key)
+    public function hasArgument(string $key): bool
     {
         return \array_key_exists($key, $this->arguments);
     }

ImmutableEventDispatcher.php

@@ -68,23 +68,23 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
     /**
      * {@inheritdoc}
      */
-    public function getListeners(string $eventName = null)
+    public function getListeners(string $eventName = null): array
     {
         return $this->dispatcher->getListeners($eventName);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getListenerPriority(string $eventName, callable|array $listener)
+    public function getListenerPriority(string $eventName, callable|array $listener): ?int
     {
         return $this->dispatcher->getListenerPriority($eventName, $listener);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function hasListeners(string $eventName = null)
+    public function hasListeners(string $eventName = null): bool
     {
         return $this->dispatcher->hasListeners($eventName);
     }