Merge pull request #562 from FriendsOfSymfony/strict-typing

strict typing
FriendsOfSymfony · Mar 25, 2024 · 63a2641 · 63a2641
2 parents cc75403 + df0ee36
commit 63a2641
Show file tree

Hide file tree

Showing 70 changed files with 446 additions and 903 deletions.
diff --git a/.phpstan/classAliases.php b/.phpstan/classAliases.php
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -2,8 +2,6 @@ parameters:
     level: 1
     paths:
         - src
-    bootstrapFiles:
-        - .phpstan/classAliases.php
     excludePaths:
         analyseAndScan:
             # contains code to support legacy phpunit versions

diff --git a/phpstan.tests.neon.dist b/phpstan.tests.neon.dist
@@ -1,6 +1,4 @@
 parameters:
     level: 1
-    bootstrapFiles:
-        - .phpstan/classAliases.php
     paths:
         - tests
diff --git a/src/CacheInvalidator.php b/src/CacheInvalidator.php
@@ -61,21 +61,10 @@ class CacheInvalidator
      */
     public const CLEAR = 'clear';
 
-    /**
-     * @var ProxyClient
-     */
-    private $cache;
+    private ProxyClient $cache;
 
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $eventDispatcher;
+    private EventDispatcherInterface $eventDispatcher;
 
-    /**
-     * Constructor.
-     *
-     * @param ProxyClient $cache HTTP cache
-     */
     public function __construct(ProxyClient $cache)
     {
         $this->cache = $cache;
@@ -91,11 +80,9 @@ public function __construct(ProxyClient $cache)
      *
      * @param string $operation one of the class constants
      *
-     * @return bool
-     *
      * @throws InvalidArgumentException
      */
-    public function supports(string $operation)
+    public function supports(string $operation): bool
     {
         switch ($operation) {
             case self::PATH:
@@ -125,7 +112,7 @@ public function supports(string $operation)
      */
     public function setEventDispatcher(EventDispatcherInterface $eventDispatcher): void
     {
-        if ($this->eventDispatcher) {
+        if (isset($this->eventDispatcher)) {
             // if you want to set a custom event dispatcher, do so right after instantiating
             // the invalidator.
             throw new \Exception('You may not change the event dispatcher once it is set.');
@@ -135,12 +122,10 @@ public function setEventDispatcher(EventDispatcherInterface $eventDispatcher): v
 
     /**
      * Get the event dispatcher used by the cache invalidator.
-     *
-     * @return EventDispatcherInterface
      */
-    public function getEventDispatcher()
+    public function getEventDispatcher(): EventDispatcherInterface
     {
-        if (!$this->eventDispatcher) {
+        if (!isset($this->eventDispatcher)) {
             $this->eventDispatcher = new EventDispatcher();
         }
 
@@ -150,14 +135,12 @@ public function getEventDispatcher()
     /**
      * Invalidate a path or URL.
      *
-     * @param string $path    Path or URL
-     * @param array  $headers HTTP headers (optional)
-     *
-     * @return $this
+     * @param string                $path    Path or URL
+     * @param array<string, string> $headers HTTP headers (optional)
      *
      * @throws UnsupportedProxyOperationException
      */
-    public function invalidatePath($path, array $headers = []): static
+    public function invalidatePath(string $path, array $headers = []): static
     {
         if (!$this->cache instanceof PurgeCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('PURGE');
@@ -171,16 +154,14 @@ public function invalidatePath($path, array $headers = []): static
     /**
      * Refresh a path or URL.
      *
-     * @param string $path    Path or URL
-     * @param array  $headers HTTP headers (optional)
+     * @param string                $path    Path or URL
+     * @param array<string, string> $headers HTTP headers (optional)
      *
      * @see RefreshCapable::refresh()
      *
-     * @return $this
-     *
      * @throws UnsupportedProxyOperationException
      */
-    public function refreshPath($path, array $headers = []): static
+    public function refreshPath(string $path, array $headers = []): static
     {
         if (!$this->cache instanceof RefreshCapable) {
             throw UnsupportedProxyOperationException::cacheDoesNotImplement('REFRESH');
@@ -199,9 +180,7 @@ public function refreshPath($path, array $headers = []): static
      *
      * @see BanCapable::ban()
      *
-     * @param array $headers HTTP headers that path must match to be banned
-     *
-     * @return $this
+     * @param array<string, string> $headers HTTP headers that path must match to be banned
      *
      * @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
      */
@@ -221,9 +200,7 @@ public function invalidate(array $headers): static
      *
      * @see TagCapable::tags()
      *
-     * @param array $tags Tags that should be removed/expired from the cache. An empty tag list is ignored.
-     *
-     * @return $this
+     * @param string[] $tags Tags that should be removed/expired from the cache. An empty tag list is ignored.
      *
      * @throws UnsupportedProxyOperationException If HTTP cache does not support Tags invalidation
      */
@@ -257,8 +234,6 @@ public function invalidateTags(array $tags): static
      * @param array|string|null $hosts       Regular expression of a host name or list of
      *                                       exact host names to limit banning
      *
-     * @return $this
-     *
      * @throws UnsupportedProxyOperationException If HTTP cache does not support BAN requests
      *
      *@see BanCapable::banPath()
@@ -277,8 +252,6 @@ public function invalidateRegex(string $path, ?string $contentType = null, array
     /**
      * Clear the cache completely.
      *
-     * @return $this
-     *
      * @throws UnsupportedProxyOperationException if HTTP cache does not support clearing the cache completely
      */
     public function clearCache(): static
@@ -299,7 +272,7 @@ public function clearCache(): static
      *
      * @throws ExceptionCollection if any errors occurred during flush
      */
-    public function flush()
+    public function flush(): int
     {
         try {
             return $this->cache->flush();

diff --git a/src/EventListener/LogListener.php b/src/EventListener/LogListener.php
@@ -22,10 +22,7 @@
  */
 class LogListener implements EventSubscriberInterface
 {
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
+    private LoggerInterface $logger;
 
     public function __construct(LoggerInterface $logger)
     {
@@ -40,22 +37,22 @@ public static function getSubscribedEvents(): array
         ];
     }
 
-    public function onProxyUnreachableError(Event $event)
+    public function onProxyUnreachableError(Event $event): void
     {
-        $this->log(LogLevel::CRITICAL, $event->getException());
+        $this->log($event->getException());
     }
 
-    public function onProxyResponseError(Event $event)
+    public function onProxyResponseError(Event $event): void
     {
-        $this->log(LogLevel::CRITICAL, $event->getException());
+        $this->log($event->getException());
     }
 
-    private function log($level, \Exception $exception)
+    private function log(\Throwable $exception): void
     {
         $context = [
             'exception' => $exception,
         ];
 
-        $this->logger->log($level, $exception->getMessage(), $context);
+        $this->logger->log(LogLevel::CRITICAL, $exception->getMessage(), $context);
     }
 }
diff --git a/src/Exception/ExceptionCollection.php b/src/Exception/ExceptionCollection.php
@@ -17,8 +17,14 @@
  */
 class ExceptionCollection extends \Exception implements \IteratorAggregate, \Countable, HttpCacheException
 {
-    private $exceptions = [];
+    /**
+     * @var \Throwable[]
+     */
+    private array $exceptions = [];
 
+    /**
+     * @param \Throwable[] $exceptions
+     */
     public function __construct(array $exceptions = [])
     {
         foreach ($exceptions as $exception) {
@@ -28,10 +34,8 @@ public function __construct(array $exceptions = [])
 
     /**
      * Add an exception to the collection.
-     *
-     * @return $this
      */
-    public function add(\Exception $e)
+    public function add(\Throwable $e): static
     {
         if (!$this->message) {
             $this->message = $e->getMessage();
@@ -44,34 +48,25 @@ public function add(\Exception $e)
 
     /**
      * Get first exception in collection or null, if there is none.
-     *
-     * @return \Exception|null
      */
-    public function getFirst()
+    public function getFirst(): ?\Throwable
     {
         if ($this->count() > 0) {
             return $this->exceptions[0];
         }
+
+        return null;
     }
 
-    /**
-     * Get exception iterator.
-     *
-     * @return \ArrayIterator
-     */
-    #[\ReturnTypeWillChange]
-    public function getIterator()
+    public function getIterator(): \ArrayIterator
     {
         return new \ArrayIterator($this->exceptions);
     }
 
     /**
      * Get number of exceptions in collection.
-     *
-     * @return int
      */
-    #[\ReturnTypeWillChange]
-    public function count()
+    public function count(): int
     {
         return count($this->exceptions);
     }

diff --git a/src/Exception/InvalidUrlException.php b/src/Exception/InvalidUrlException.php
@@ -17,12 +17,10 @@
 class InvalidUrlException extends InvalidArgumentException
 {
     /**
-     * @param string $url    the invalid URL
-     * @param string $reason Further explanation why the URL was invalid (optional)
-     *
-     * @return self
+     * @param string      $url    the invalid URL
+     * @param string|null $reason Further explanation why the URL was invalid (optional)
      */
-    public static function invalidUrl($url, $reason = null)
+    public static function invalidUrl(string $url, ?string $reason = null): InvalidUrlException
     {
         $msg = sprintf('URL "%s" is invalid.', $url);
         if ($reason) {
@@ -33,12 +31,10 @@ public static function invalidUrl($url, $reason = null)
     }
 
     /**
-     * @param string $server  Invalid server
-     * @param array  $allowed Allowed URL parts
-     *
-     * @return self
+     * @param string   $server  Invalid server
+     * @param string[] $allowed Allowed URL parts
      */
-    public static function invalidUrlParts($server, array $allowed)
+    public static function invalidUrlParts(string $server, array $allowed): InvalidUrlException
     {
         return new self(sprintf(
             'Server "%s" is invalid. Only %s URL parts are allowed.',

diff --git a/src/Exception/MissingHostException.php b/src/Exception/MissingHostException.php
@@ -19,10 +19,8 @@ class MissingHostException extends \RuntimeException implements HttpCacheExcepti
 {
     /**
      * @param string $path the path that was asked to be invalidated
-     *
-     * @return MissingHostException
      */
-    public static function missingHost($path)
+    public static function missingHost(string $path): MissingHostException
     {
         $msg = sprintf(
             'Path "%s" cannot be invalidated without a host. '

diff --git a/src/Exception/ProxyResponseException.php b/src/Exception/ProxyResponseException.php
@@ -18,10 +18,7 @@
  */
 class ProxyResponseException extends \RuntimeException implements HttpCacheException
 {
-    /**
-     * @return ProxyResponseException
-     */
-    public static function proxyResponse(HttpException $exception)
+    public static function proxyResponse(HttpException $exception): ProxyResponseException
     {
         $message = sprintf(
             '%s error response "%s" from caching proxy',

diff --git a/src/Exception/ProxyUnreachableException.php b/src/Exception/ProxyUnreachableException.php
@@ -19,10 +19,7 @@
  */
 class ProxyUnreachableException extends \RuntimeException implements HttpCacheException
 {
-    /**
-     * @return ProxyUnreachableException
-     */
-    public static function proxyUnreachable(NetworkException $requestException)
+    public static function proxyUnreachable(NetworkException $requestException): ProxyUnreachableException
     {
         $message = sprintf(
             'Request to caching proxy at %s failed with message "%s"',

diff --git a/src/Exception/UnsupportedProxyOperationException.php b/src/Exception/UnsupportedProxyOperationException.php
@@ -19,10 +19,8 @@ class UnsupportedProxyOperationException extends \RuntimeException implements Ht
 {
     /**
      * @param string $method name of the HTTP method that would be required
-     *
-     * @return UnsupportedProxyOperationException
      */
-    public static function cacheDoesNotImplement($method)
+    public static function cacheDoesNotImplement(string $method): UnsupportedProxyOperationException
     {
         return new self(sprintf('HTTP cache does not support %s requests', $method));
     }