Increased Phpstan validation up to level 6

Author: Geolim4

.github/workflows/tests.yml

@@ -41,7 +41,7 @@ jobs:
         run: ./vendor/bin/phpmd lib/ ansi phpmd.xml
 
       - name: Run PHPSTAN (lite)
-        run: ./vendor/bin/phpstan analyse lib/ -l 4 -c phpstan_lite.neon 2>&1
+        run: ./vendor/bin/phpstan analyse lib/ -l 6 -c phpstan_lite.neon 2>&1
 
       - name: Run TESTS
         env:

.travis.yml

@@ -59,5 +59,5 @@ install:
 script:
   - ./vendor/bin/phpcs lib/ --report=summary
   - ./vendor/bin/phpmd lib/ ansi phpmd.xml
-  - "[[ $TRAVIS_PHP_VERSION != \"nightly\" ]] && ./vendor/bin/phpstan analyse lib/ -l 4 -c phpstan.neon 2>&1 || ./vendor/bin/phpstan analyse lib/ -l 4 -c phpstan_lite.neon 2>&1"
+  - "[[ $TRAVIS_PHP_VERSION != \"nightly\" ]] && ./vendor/bin/phpstan analyse lib/ -l 6 -c phpstan.neon 2>&1 || ./vendor/bin/phpstan analyse lib/ -l 4 -c phpstan_lite.neon 2>&1"
   - php -f ./bin/ci/run_tests.php

lib/Phpfastcache/Cluster/ClusterPoolTrait.php

@@ -33,7 +33,7 @@ protected function driverConnect(): bool
 
     /**
      * @param ExtendedCacheItemInterface $item
-     * @return ?array
+     * @return ?array<string, mixed>
      */
     protected function driverRead(ExtendedCacheItemInterface $item): ?array
     {

lib/Phpfastcache/Config/ConfigurationOption.php

@@ -50,6 +50,7 @@ class ConfigurationOption extends AbstractConfigurationOption implements Configu
     protected ?object $superGlobalAccessor = null;
 
     /**
+     * @inheritDoc
      * @throws PhpfastcacheInvalidConfigurationException
      * @throws PhpfastcacheInvalidTypeException
      */

lib/Phpfastcache/Config/ConfigurationOptionInterface.php

@@ -23,12 +23,13 @@
 interface ConfigurationOptionInterface extends LockableConfigurationInterface
 {
     /**
+     * @param array<string, mixed> $parameters
      * ConfigurationOptionInterface constructor.
      */
     public function __construct(array $parameters = []);
 
     /**
-     * @return array
+     * @return array<string, mixed>
      */
     public function toArray(): array;
 

lib/Phpfastcache/Core/Item/ExtendedCacheItemInterface.php

@@ -166,15 +166,15 @@ public function increment(int $step = 1): ExtendedCacheItemInterface;
     public function decrement(int $step = 1): ExtendedCacheItemInterface;
 
     /**
-     * @param array|string $data
+     * @param mixed[]|string $data
      *
      * @return ExtendedCacheItemInterface
      * @throws PhpfastcacheInvalidTypeException
      */
     public function append(array|string $data): ExtendedCacheItemInterface;
 
     /**
-     * @param array|string $data
+     * @param mixed[]|string $data
      *
      * @return ExtendedCacheItemInterface
      * @throws PhpfastcacheInvalidTypeException

lib/Phpfastcache/Core/Pool/CacheItemPoolTrait.php

@@ -33,7 +33,7 @@
 use RuntimeException;
 
 /**
- * @method array driverUnwrapTags(array $wrapper)
+ * @method string[] driverUnwrapTags(array $wrapper)
  * @method void cleanItemTags(ExtendedCacheItemInterface $item)
  */
 trait CacheItemPoolTrait
@@ -92,8 +92,7 @@ public function setItem(CacheItemInterface $item): static
     }
 
     /**
-     * @param array $keys
-     * @return array
+     * @inheritDoc
      * @throws PhpfastcacheCoreException
      * @throws PhpfastcacheDriverException
      * @throws PhpfastcacheInvalidArgumentException
@@ -278,8 +277,7 @@ public function clear(): bool
     }
 
     /**
-     * @param array $keys
-     * @return bool
+     * @inheritDoc
      * @throws PhpfastcacheCoreException
      * @throws PhpfastcacheDriverException
      * @throws PhpfastcacheInvalidArgumentException

lib/Phpfastcache/Core/Pool/DriverBaseTrait.php

@@ -40,10 +40,16 @@ trait DriverBaseTrait
     use ClassNamespaceResolverTrait;
     use EventManagerDispatcherTrait;
 
+    /**
+     * @var string[]
+     */
     protected static array $cacheItemClasses = [];
 
     protected ConfigurationOptionInterface $config;
 
+    /**
+     * @var object|array<mixed>|null
+     */
     protected object|array|null $instance;
 
     protected string $driverName;
@@ -136,7 +142,7 @@ public static function getItemClass(): string
     /**
      * @param ExtendedCacheItemInterface $item
      * @param bool $stringifyDate
-     * @return array
+     * @return array<string, mixed>
      * @throws PhpfastcacheLogicException
      */
     public function driverPreWrap(ExtendedCacheItemInterface $item, bool $stringifyDate = false): array
@@ -191,7 +197,7 @@ public function setConfig(ConfigurationOptionInterface $config): static
     }
 
     /**
-     * @param array $wrapper
+     * @param array<string, mixed> $wrapper
      * @return mixed
      * @throws \Exception
      */
@@ -201,7 +207,7 @@ public function driverUnwrapData(array $wrapper): mixed
     }
 
     /**
-     * @param array $wrapper
+     * @param array<string, mixed> $wrapper
      * @return DateTimeInterface
      */
     public function driverUnwrapEdate(array $wrapper): \DateTimeInterface
@@ -214,7 +220,7 @@ public function driverUnwrapEdate(array $wrapper): \DateTimeInterface
     }
 
     /**
-     * @param array $wrapper
+     * @param array<string, mixed> $wrapper
      * @return DateTimeInterface|null
      */
     public function driverUnwrapCdate(array $wrapper): ?\DateTimeInterface
@@ -227,7 +233,7 @@ public function driverUnwrapCdate(array $wrapper): ?\DateTimeInterface
     }
 
     /**
-     * @param array $wrapper
+     * @param array<string, mixed> $wrapper
      * @return DateTimeInterface|null
      */
     public function driverUnwrapMdate(array $wrapper): ?\DateTimeInterface
@@ -251,10 +257,10 @@ public function getInstanceId(): string
      * Encode data types such as object/array
      * for driver that does not support
      * non-scalar value
-     * @param $data
+     * @param mixed $data
      * @return string
      */
-    protected function encode($data): string
+    protected function encode(mixed $data): string
     {
         return \serialize($data);
     }

lib/Phpfastcache/Core/Pool/DriverPoolAbstractTrait.php

@@ -33,7 +33,7 @@ abstract protected function driverConnect(): bool;
 
     /**
      * @param ExtendedCacheItemInterface $item
-     * @return ?array
+     * @return ?array<string, mixed>
      */
     abstract protected function driverRead(ExtendedCacheItemInterface $item): ?array;
 

lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolInterface.php

@@ -122,7 +122,7 @@ public function getItem(string $key): ExtendedCacheItemInterface;
      * @param string[] $keys
      * An indexed array of keys of items to retrieve.
      *
-     * @return ExtendedCacheItemInterface[]
+     * @return iterable<ExtendedCacheItemInterface>
      *   A traversable collection of Cache Items keyed by the cache keys of
      *   each item. A Cache item will be returned for each key, even if that
      *   key is not found. However, if no keys are specified then an empty
@@ -137,8 +137,7 @@ public function getItems(array $keys = []): iterable;
     /**
      * Returns A json string that represents an array of items.
      *
-     * @param array $keys
-     * An indexed array of keys of items to retrieve.
+     * @param array<string> $keys An indexed array of keys of items to retrieve.
      * @param int $options \json_encode() options
      * @param int $depth \json_encode() depth
      *

lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolTrait.php

@@ -30,10 +30,7 @@ trait ExtendedCacheItemPoolTrait
     use CacheItemPoolTrait;
 
     /**
-     * @param array $keys
-     * @param int $options
-     * @param int $depth
-     * @return string
+     * @inheritDoc
      * @throws PhpfastcacheCoreException
      * @throws PhpfastcacheDriverException
      * @throws PhpfastcacheInvalidArgumentException

lib/Phpfastcache/Core/Pool/IO/IOHelperTrait.php

@@ -33,7 +33,7 @@ trait IOHelperTrait
     use TaggableCacheItemPoolTrait;
 
     /**
-     * @var array
+     * @var array<string, string>
      */
     public array $tmp = [];
 
@@ -51,13 +51,13 @@ public function getStats(): DriverStatistic
         if (!is_dir($path)) {
             throw new PhpfastcacheIOException("Can't read PATH:" . $path);
         }
-        $stat->setRawData(
-            [
+        $stat->setSize(Directory::dirSize($path))
+            ->setInfo('Number of files used to build the cache: ' . Directory::getFileCount($path))
+            ->setRawData(
+                [
                     'tmp' => $this->tmp,
                 ]
-        )
-            ->setSize(Directory::dirSize($path))
-            ->setInfo('Number of files used to build the cache: ' . Directory::getFileCount($path));
+            );
 
         if ($this->getConfig()->isUseStaticItemCaching()) {
             $stat->setData(implode(', ', \array_keys($this->itemInstances)));
@@ -283,7 +283,7 @@ protected function writeFile(string $file, string $data, bool $secureFileManipul
                 dirname($file) . \DIRECTORY_SEPARATOR . 'tmp_' . $this->getConfig()->getDefaultFileNameHashFunction()(
                     \bin2hex(\random_bytes(16))
                 )
-            ) . '.' .  $this->getConfig()->getCacheFileExtension() . \random_int(1000, 9999);
+            ) . '.' . $this->getConfig()->getCacheFileExtension() . \random_int(1000, 9999);
 
             $handle = \fopen($tmpFilename, 'w+b');
             if (\is_resource($handle)) {
@@ -304,6 +304,6 @@ protected function writeFile(string $file, string $data, bool $secureFileManipul
             }
         }
 
-        return (bool) ($octetWritten ?? false);
+        return (bool)($octetWritten ?? false);
     }
 }

lib/Phpfastcache/Core/Pool/TaggableCacheItemPoolInterface.php

@@ -216,7 +216,7 @@ public function decrementItemsByTags(array $tagNames, int $step = 1, int $strate
      * @param string $tagName
      *   The tag for which to append
      *
-     * @param array|string $data
+     * @param array<mixed>|string $data
      *
      * @param int $strategy
      *
@@ -235,7 +235,7 @@ public function appendItemsByTag(string $tagName, array|string $data, int $strat
      * @param string[] $tagNames
      *   The tag for which to append
      *
-     * @param array|string $data
+     * @param array<mixed>|string $data
      *
      * @param int $strategy
      *
@@ -254,7 +254,7 @@ public function appendItemsByTags(array $tagNames, array|string $data, int $stra
      * @param string $tagName
      *   The tag for which to prepend
      *
-     * @param array|string $data
+     * @param array<mixed>|string $data
      *
      * @param int $strategy
      *
@@ -273,7 +273,7 @@ public function prependItemsByTag(string $tagName, array|string $data, int $stra
      * @param string[] $tagNames
      *   The tag for which to prepend
      *
-     * @param array|string $data
+     * @param array<mixed>|string $data
      *
      * @param int $strategy
      *