DRAFT: Raise PhpStan to level 8

Neos.Cache/Classes/Backend/AbstractBackend.php

@@ -28,18 +28,18 @@ abstract class AbstractBackend implements BackendInterface
 
     /**
      * Reference to the cache frontend which uses this backend
-     * @var FrontendInterface
+     * @var ?FrontendInterface
      */
     protected $cache;
 
     /**
-     * @var string
+     * @var ?string
      */
     protected $cacheIdentifier;
 
     /**
-     * A prefix to seperate stored by appliaction context and cache
-     * @var string
+     * A prefix to separate stored by application context and cache
+     * @var ?string
      */
     protected $identifierPrefix;
 
@@ -50,28 +50,25 @@ abstract class AbstractBackend implements BackendInterface
     protected $defaultLifetime = 3600;
 
     /**
-     * @var EnvironmentConfiguration
+     * @var ?EnvironmentConfiguration
      */
     protected $environmentConfiguration;
 
     /**
      * Constructs this backend
      *
-     * @param EnvironmentConfiguration $environmentConfiguration
-     * @param array $options Configuration options - depends on the actual backend
+     * @param ?EnvironmentConfiguration $environmentConfiguration @todo is this ever null and does that even make sense?
+     * @param array<mixed> $options Configuration options - depends on the actual backend
      * @api
      */
     public function __construct(?EnvironmentConfiguration $environmentConfiguration = null, array $options = [])
     {
         $this->environmentConfiguration = $environmentConfiguration;
-
-        if (is_array($options) || $options instanceof \Iterator) {
-            $this->setProperties($options);
-        }
+        $this->setProperties($options);
     }
 
     /**
-     * @param array $properties
+     * @param array<mixed> $properties
      * @param boolean $throwExceptionIfPropertyNotSettable
      * @return void
      * @throws \InvalidArgumentException

Neos.Cache/Classes/Backend/ApcuBackend.php

@@ -83,6 +83,10 @@ public function setCache(FrontendInterface $cache): void
     {
         parent::setCache($cache);
 
+        if ($this->environmentConfiguration === null) {
+            throw new \RuntimeException('The environment configuration is not set.', 1744537489);
+        }
+
         $pathHash = substr(md5($this->environmentConfiguration->getApplicationIdentifier() . $cache->getIdentifier()), 0, 12);
         $this->identifierPrefix = 'Flow_' . $pathHash . '_';
     }
@@ -110,7 +114,7 @@ public function getPrefixedIdentifier(string $entryIdentifier): string
      *
      * @param string $entryIdentifier An identifier for this specific cache entry
      * @param string $data The data to be stored
-     * @param array $tags Tags to associate with this cache entry
+     * @param array<string> $tags Tags to associate with this cache entry
      * @param int|null $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
      * @return void
      * @throws Exception if no cache frontend has been set.
@@ -263,7 +267,7 @@ public function flushByTags(array $tags): int
      * Associates the identifier with the given tags
      *
      * @param string $entryIdentifier
-     * @param array $tags
+     * @param array<string> $tags
      * @return void
      */
     protected function addIdentifierToTags(string $entryIdentifier, array $tags)
@@ -391,6 +395,7 @@ public function valid(): bool
      *
      * @return void
      * @api
+     * @phpstan-assert \APCUIterator $this->cacheEntriesIterator
      */
     #[\ReturnTypeWillChange]
     public function rewind()

Neos.Cache/Classes/Backend/BackendInterface.php

@@ -50,7 +50,7 @@ public function getPrefixedIdentifier(string $entryIdentifier): string;
      *
      * @param string $entryIdentifier An identifier for this specific cache entry
      * @param string $data The data to be stored
-     * @param array $tags Tags to associate with this cache entry. If the backend does not support tags, this option can be ignored.
+     * @param array<string> $tags Tags to associate with this cache entry. If the backend does not support tags, this option can be ignored.
      * @param integer|null $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
      * @return void
      * @throws \Neos\Cache\Exception if no cache frontend has been set.

Neos.Cache/Classes/Backend/FileBackend.php

@@ -48,7 +48,7 @@ class FileBackend extends SimpleFileBackend implements PhpCapableBackendInterfac
     protected $cacheEntryFileExtension = '';
 
     /**
-     * @var array<string>
+     * @var array<string, true> @phpstan-ignore property.phpDocType (this backend seems to work differently)
      */
     protected $cacheEntryIdentifiers = [];
 
@@ -90,6 +90,9 @@ public function freeze(): void
         $cachePathAndFileName = $this->cacheDirectory . 'FrozenCache.data';
         if ($this->useIgBinary === true) {
             $data = igbinary_serialize($this->cacheEntryIdentifiers);
+            if ($data === null) {
+                throw new \RuntimeException('Failed to serialize cache entry identifiers', 1744536663);
+            }
         } else {
             $data = serialize($this->cacheEntryIdentifiers);
         }
@@ -140,8 +143,8 @@ public function setCache(FrontendInterface $cache): void
      *
      * @param string $entryIdentifier An identifier for this specific cache entry
      * @param string $data The data to be stored
-     * @param array $tags Tags to associate with this cache entry
-     * @param integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
+     * @param array<string> $tags Tags to associate with this cache entry
+     * @param ?integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
      * @return void
      * @throws \RuntimeException
      * @throws Exception if the directory does not exist or is not writable or exceeds the maximum allowed path length, or if no cache frontend has been set.

Neos.Cache/Classes/Backend/IterableBackendInterface.php

@@ -14,6 +14,7 @@
 /**
  * A contract for a cache backend which provides Iterator functionality.
  *
+ * @extends \Iterator<int|string,mixed>
  * @api
  */
 interface IterableBackendInterface extends BackendInterface, \Iterator

Neos.Cache/Classes/Backend/IterableMultiBackend.php

@@ -45,6 +45,9 @@ public function current(): mixed
         $this->prepareBackends();
         foreach ($this->backends as $backend) {
             try {
+                if (!method_exists($backend, 'current')) {
+                    throw new \RuntimeException(get_class($backend) . ' does not implement rewind');
+                }
                 return $backend->current();
             } catch (Throwable $throwable) {
                 $this->logger?->error('Failed retrieving current cache entry using backend ' . get_class($backend) . ' in ' . get_class($this) . ': ' . $this->throwableStorage?->logThrowable($throwable), LogEnvironment::fromMethodName(__METHOD__));
@@ -63,6 +66,9 @@ public function next(): void
         $this->prepareBackends();
         foreach ($this->backends as $backend) {
             try {
+                if (!method_exists($backend, 'next')) {
+                    throw new \RuntimeException(get_class($backend) . ' does not implement rewind');
+                }
                 $backend->next();
             } catch (Throwable $throwable) {
                 $this->logger?->error('Failed retrieving next cache entry using backend ' . get_class($backend) . ' in ' . get_class($this) . ': ' . $this->throwableStorage?->logThrowable($throwable), LogEnvironment::fromMethodName(__METHOD__));
@@ -80,6 +86,9 @@ public function key(): string|int|bool|null|float
         $this->prepareBackends();
         foreach ($this->backends as $backend) {
             try {
+                if (!method_exists($backend, 'key')) {
+                    throw new \RuntimeException(get_class($backend) . ' does not implement rewind');
+                }
                 return $backend->key();
             } catch (Throwable $throwable) {
                 $this->logger?->error('Failed retrieving cache entry key using backend ' . get_class($backend) . ' in ' . get_class($this) . ': ' . $this->throwableStorage?->logThrowable($throwable), LogEnvironment::fromMethodName(__METHOD__));
@@ -98,6 +107,9 @@ public function valid(): bool
         $this->prepareBackends();
         foreach ($this->backends as $backend) {
             try {
+                if (!method_exists($backend, 'valid')) {
+                    throw new \RuntimeException(get_class($backend) . ' does not implement rewind');
+                }
                 return $backend->valid();
             } catch (Throwable $throwable) {
                 $this->logger?->error('Failed checking if current cache entry is valid using backend ' . get_class($backend) . ' in ' . get_class($this) . ': ' . $this->throwableStorage?->logThrowable($throwable), LogEnvironment::fromMethodName(__METHOD__));
@@ -116,6 +128,9 @@ public function rewind(): void
         $this->prepareBackends();
         foreach ($this->backends as $backend) {
             try {
+                if (!method_exists($backend, 'rewind')) {
+                    throw new \RuntimeException(get_class($backend) . ' does not implement rewind');
+                }
                 $backend->rewind();
             } catch (Throwable $throwable) {
                 $this->logger?->error('Failed rewinding cache entries using backend ' . get_class($backend) . ' in ' . get_class($this) . ': ' . $this->throwableStorage?->logThrowable($throwable), LogEnvironment::fromMethodName(__METHOD__));

Neos.Cache/Classes/Backend/MemcachedBackend.php

@@ -65,7 +65,7 @@ class MemcachedBackend extends IndependentAbstractBackend implements TaggableBac
     /**
      * Array of Memcache server configurations
      *
-     * @var array
+     * @var array<string>
      */
     protected $servers = [];
 
@@ -102,7 +102,7 @@ public function __construct(EnvironmentConfiguration $environmentConfiguration,
      * Setter for servers to be used. Expects an array,  the values are expected
      * to be formatted like "<host>[:<port>]" or "unix://<path>"
      *
-     * @param array $servers An array of servers to add.
+     * @param array<string> $servers An array of servers to add.
      * @return void
      * @throws Exception
      * @api
@@ -121,12 +121,12 @@ protected function setServers(array $servers)
             $host = $server;
             $port = 0;
 
-            if (strpos($server, 'tcp://') === 0) {
+            if (str_starts_with($server, 'tcp://')) {
                 $port = $defaultPort;
                 $server = substr($server, 6);
             }
 
-            if (strpos($server, ':') !== false) {
+            if (str_contains($server, ':')) {
                 [$host, $portValue] = explode(':', $server, 2);
                 $port = (int)$portValue;
             }
@@ -165,6 +165,10 @@ public function setCache(FrontendInterface $cache): void
     {
         parent::setCache($cache);
 
+        if ($this->environmentConfiguration === null) {
+            throw new \RuntimeException('No environment configuration set', 1744535714);
+        }
+
         $pathHash = substr(md5($this->environmentConfiguration->getApplicationIdentifier() . $cache->getIdentifier()), 0, 12);
         $this->identifierPrefix = 'Flow_' . $pathHash . '_';
     }
@@ -192,8 +196,8 @@ public function getPrefixedIdentifier(string $entryIdentifier): string
      *
      * @param string $entryIdentifier An identifier for this specific cache entry
      * @param string $data The data to be stored
-     * @param array $tags Tags to associate with this cache entry
-     * @param integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
+     * @param array<string> $tags Tags to associate with this cache entry
+     * @param ?integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
      * @return void
      * @throws Exception if no cache frontend has been set.
      * @throws \InvalidArgumentException if the identifier is not valid or the final memcached key is longer than 250 characters
@@ -325,7 +329,7 @@ public function findIdentifiersByTag(string $tag): array
      * index to search for tags.
      *
      * @param string $identifier Identifier to find tags by
-     * @return array Array with tags
+     * @return array<string> Array with tags
      */
     protected function findTagsByIdentifier(string $identifier): array
     {
@@ -383,7 +387,7 @@ public function flushByTags(array $tags): int
      * Associates the identifier with the given tags
      *
      * @param string $entryIdentifier
-     * @param array $tags
+     * @param array<string> $tags
      * @return void
      */
     protected function addIdentifierToTags(string $entryIdentifier, array $tags)

Neos.Cache/Classes/Backend/MultiBackend.php

@@ -30,7 +30,13 @@ class MultiBackend extends AbstractBackend
 {
     use BackendInstantiationTrait;
 
+    /**
+     * @var array<mixed>
+     */
     protected array $backendConfigurations = [];
+    /**
+     * @var array<int,BackendInterface>
+     */
     protected array $backends = [];
     protected bool $setInAllBackends = true;
     protected bool $debug = false;
@@ -48,10 +54,8 @@ public function __construct(?EnvironmentConfiguration $environmentConfiguration
         if ($this->logErrors && class_exists(Bootstrap::class) && Bootstrap::$staticObjectManager instanceof ObjectManagerInterface) {
             try {
                 $logger = Bootstrap::$staticObjectManager->get(LoggerInterface::class);
-                assert($logger instanceof LoggerInterface);
                 $this->logger = $logger;
                 $throwableStorage = Bootstrap::$staticObjectManager->get(ThrowableStorageInterface::class);
-                assert($throwableStorage instanceof ThrowableStorageInterface);
                 $this->throwableStorage = $throwableStorage;
             } catch (UnknownObjectException) {
                 // Logging might not be available during compile time
@@ -78,11 +82,18 @@ protected function prepareBackends(): void
     }
 
     /**
+     * @param array<mixed> $backendOptions
      * @throws Throwable
      */
     protected function buildSubBackend(string $backendClassName, array $backendOptions): ?BackendInterface
     {
         try {
+            if ($this->cache === null) {
+                throw new \RuntimeException('Cache frontend is not yet initialized', 1744535490);
+            }
+            if ($this->environmentConfiguration === null) {
+                throw new \RuntimeException('Environment configuration is missing', 1744535532);
+            }
             $backend = $this->instantiateBackend($backendClassName, $backendOptions, $this->environmentConfiguration);
             $backend->setCache($this->cache);
         } catch (Throwable $throwable) {
@@ -95,6 +106,7 @@ protected function buildSubBackend(string $backendClassName, array $backendOptio
 
     /**
      * @throws Throwable
+     * @param array<string> $tags
      */
     public function set(string $entryIdentifier, string $data, array $tags = [], ?int $lifetime = null): void
     {
@@ -204,6 +216,7 @@ public function collectGarbage(): void
 
     /**
      * This setter is used by AbstractBackend::setProperties()
+     * @param array<mixed> $backendConfigurations
      */
     protected function setBackendConfigurations(array $backendConfigurations): void
     {

Neos.Cache/Classes/Backend/NullBackend.php

@@ -41,8 +41,8 @@ protected function setProperty(string $propertyName, $propertyValue) : bool
      *
      * @param string $entryIdentifier ignored
      * @param string $data ignored
-     * @param array $tags ignored
-     * @param integer $lifetime ignored
+     * @param array<string> $tags ignored
+     * @param ?integer $lifetime ignored
      * @return void
      * @api
      */

Neos.Cache/Classes/Backend/PdoBackend.php

@@ -48,7 +48,7 @@ class PdoBackend extends IndependentAbstractBackend implements TaggableBackendIn
     protected $password;
 
     /**
-     * @var array
+     * @var array<mixed>
      */
     protected $driverOptions = [];
 
@@ -83,7 +83,7 @@ class PdoBackend extends IndependentAbstractBackend implements TaggableBackendIn
     protected $batchSize = 999;
 
     /**
-     * @var \ArrayIterator|null
+     * @var \ArrayIterator<string,mixed>|null
      */
     protected $cacheEntriesIterator;
 
@@ -126,7 +126,7 @@ protected function setPassword(string $password): void
     /**
      * Sets the driverOptions to use
      *
-     * @param array $driverOptions The options to use for connecting to the DB
+     * @param array<mixed> $driverOptions The options to use for connecting to the DB
      * @return void
      * @api
      */
@@ -174,7 +174,7 @@ protected function setBatchSize(int $batchSize): void
      *
      * @param string $entryIdentifier An identifier for this specific cache entry
      * @param string $data The data to be stored
-     * @param array $tags Tags to associate with this cache entry
+     * @param array<string> $tags Tags to associate with this cache entry
      * @param int|null $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
      * @return void
      * @throws Exception if no cache frontend has been set.
@@ -613,6 +613,7 @@ public function valid(): bool
      *
      * @return void
      * @api
+     * @phpstan-assert \ArrayIterator<string,mixed> $this->cacheEntriesIterator
      */
     public function rewind(): void
     {
@@ -647,6 +648,9 @@ public function rewind(): void
     protected function context(): string
     {
         if ($this->context === null) {
+            if ($this->environmentConfiguration === null) {
+                throw new \RuntimeException('Environment configuration not set', 1744534618);
+            }
             $this->context = md5($this->environmentConfiguration->getApplicationIdentifier());
         }
         return $this->context;