TASK: Phpstan level 2 for Flow 8.3 and ignore to be fixed things

.github/workflows/build.yml

@@ -120,8 +120,6 @@ jobs:
           git -C ../${{ env.FLOW_FOLDER }} checkout -b build
           composer config repositories.flow '{ "type": "path", "url": "../${{ env.FLOW_FOLDER }}", "options": { "symlink": false } }'
           composer require --no-update neos/flow-development-collection:"dev-build as ${{ env.FLOW_BRANCH_ALIAS }}"
-          # todo remove temporary hack ;) (sorry - if i forget)
-          composer require --no-update --dev "phpstan/phpstan:^1.10.0"
 
       - name: Cache Composer packages
         id: composer-cache

Neos.Cache/Classes/Psr/Cache/CacheItem.php

@@ -110,7 +110,7 @@ public function expiresAt(?\DateTimeInterface $expiration): static
 
     /**
      * @param \DateInterval|int|null $time
-     * @return CacheItem|static
+     * @return static
      */
     public function expiresAfter(int|\DateInterval|null $time): static
     {

Neos.Cache/Classes/Psr/SimpleCache/SimpleCache.php

@@ -60,7 +60,7 @@ public function __construct(string $identifier, BackendInterface $backend)
      *
      * @param string $key An identifier used for this cache entry
      * @param mixed $value The variable to cache
-     * @param null|int|\DateInterval $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
+     * @param null|int|\DateInterval $ttl Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
      * @return bool
      *
      * @throws Exception

Neos.Eel/Classes/CompilingEvaluator.php

@@ -97,13 +97,15 @@ protected function evaluateAndUnwrap(\closure $expressionFunction, Context $cont
      */
     protected function generateEvaluatorCode($expression)
     {
-        /** @phpstan-ignore-next-line */
+        /** @phpstan-ignore-next-line `CompilingEelParser` has been explicitly excluded from analysis, because it contains generated code that is impossible to fix */
         $parser = new CompilingEelParser($expression);
         $result = $parser->match_Expression();
 
         if ($result === false) {
             throw new ParserException(sprintf('Expression "%s" could not be parsed.', $expression), 1344513194);
+            /** @phpstan-ignore-next-line $parser->pos appears to be undeclared, because instantiation of $parser is hidden as well */
         } elseif ($parser->pos !== strlen($expression)) {
+            /** @phpstan-ignore-next-line $parser->pos appears to be undeclared, because instantiation of $parser is hidden as well */
             throw new ParserException(sprintf('Expression "%s" could not be parsed. Error starting at character %d: "%s".', $expression, $parser->pos, substr($expression, $parser->pos)), 1327682383);
         } elseif (!array_key_exists('code', $result)) {
             throw new ParserException(sprintf('Parser error, no code in result %s ', json_encode($result)), 1334491498);

Neos.Eel/Classes/FlowQuery/OperationInterface.php

@@ -42,7 +42,7 @@ public static function isFinal();
      * can work with the $context objects. It can be implemented
      * to implement runtime conditions.
      *
-     * @param array (or array-like object) $context onto which this operation should be applied
+     * @param array $context (or array-like object) $context onto which this operation should be applied
      * @return boolean true if the operation can be applied onto the $context, false otherwise
      * @api
      */

Neos.Eel/Classes/FlowQuery/OperationResolver.php

@@ -73,7 +73,7 @@ public static function buildOperationsAndFinalOperationNames($objectManager)
 
         $reflectionService = $objectManager->get(ReflectionService::class);
         $operationClassNames = $reflectionService->getAllImplementationClassNamesForInterface(OperationInterface::class);
-        /** @var $operationClassName OperationInterface */
+        /** @var OperationInterface $operationClassName */
         foreach ($operationClassNames as $operationClassName) {
             $shortOperationName = $operationClassName::getShortName();
             $operationPriority = $operationClassName::getPriority();

Neos.Eel/Classes/FlowQuery/Operations/AbstractOperation.php

@@ -80,7 +80,7 @@ public static function getShortName()
     /**
      * {@inheritdoc}
      *
-     * @param array (or array-like object) $context onto which this operation should be applied
+     * @param array $context (or array-like object) $context onto which this operation should be applied
      * @return boolean true if the operation can be applied onto the $context, false otherwise
      * @api
      */

Neos.Eel/Classes/Helper/MathHelper.php

@@ -94,7 +94,7 @@ public function getSQRT2()
      * @param float $x A number
      * @return float The absolute value of the given value
      */
-    public function abs($x = 'NAN')
+    public function abs($x = NAN)
     {
         if (!is_numeric($x) && $x !== null) {
             return NAN;

Neos.Eel/Classes/InterpretedEvaluator.php

@@ -35,7 +35,12 @@ public function evaluate($expression, Context $context)
 
         if ($res === false) {
             throw new ParserException(sprintf('Expression "%s" could not be parsed.', $expression), 1344514198);
+            /**
+             * @phpstan-ignore-next-line $parser->pos appears to be undeclared, because it is declared up in the parent class chain of `InterpretedEelParser`,
+             * wherein multiple classes (e.g. `EelParser` and `AbstractEelParser`) are explicitly excluded from analysis, because they contain generated code that is impossible to fix
+             */
         } elseif ($parser->pos !== strlen($expression)) {
+            /** @phpstan-ignore-next-line $parser->pos appears to be undeclared see comment above. */
             throw new ParserException(sprintf('Expression "%s" could not be parsed. Error starting at character %d: "%s".', $expression, $parser->pos, substr($expression, $parser->pos)), 1344514188);
         } elseif (!array_key_exists('val', $res)) {
             throw new ParserException(sprintf('Parser error, no val in result %s ', json_encode($res)), 1344514204);

Neos.Eel/Classes/Validation/ExpressionSyntaxValidator.php

@@ -28,7 +28,9 @@ protected function isValid($value)
 
         if ($result === false) {
             $this->addError('Expression "%s" could not be parsed.', 1421940748, [$value]);
+            /** @phpstan-ignore-next-line */
         } elseif ($parser->pos !== strlen($value)) {
+            /** @phpstan-ignore-next-line */
             $this->addError('Expression "%s" could not be parsed. Error starting at character %d: "%s".', 1421940760, [$value, $parser->pos, substr($value, $parser->pos)]);
         }
     }

Neos.Error.Messages/Classes/Result.php

@@ -458,7 +458,6 @@ public function merge(Result $otherResult)
             $this->mergeProperty($otherResult, 'getNotices', 'addNotice');
         }
 
-        /** @var $subResult Result */
         foreach ($otherResult->getSubResults() as $subPropertyName => $subResult) {
             if (array_key_exists($subPropertyName, $this->propertyResults) && $this->propertyResults[$subPropertyName]->hasMessages()) {
                 $this->forProperty($subPropertyName)->merge($subResult);

Neos.Flow/Classes/Annotations/Inject.php

@@ -43,9 +43,6 @@ final class Inject
      */
     public $name;
 
-    /**
-     * @param array $values
-     */
     public function __construct(?string $name = null, bool $lazy = true)
     {
         $this->lazy = $lazy;

Neos.Flow/Classes/Aop/Advice/AdviceChain.php

@@ -11,6 +11,7 @@
  * source code.
  */
 use Neos\Flow\Aop\JoinPointInterface;
+use Neos\Flow\Aop\ProxyInterface as InternalAopProxyInterface;
 
 /**
  * The advice chain holds a number of subsequent advices that
@@ -56,7 +57,9 @@ public function proceed(JoinPointInterface &$joinPoint)
         if ($this->adviceIndex < count($this->advices)) {
             $result = $this->advices[$this->adviceIndex]->invoke($joinPoint);
         } else {
-            $result = $joinPoint->getProxy()->Flow_Aop_Proxy_invokeJoinpoint($joinPoint);
+            /** @var InternalAopProxyInterface $proxy */
+            $proxy = $joinPoint->getProxy();
+            $result = $proxy->Flow_Aop_Proxy_invokeJoinpoint($joinPoint);
         }
         return $result;
     }

Neos.Flow/Classes/Aop/Builder/ProxyClassBuilder.php

@@ -435,7 +435,7 @@ public function buildProxyClass(string $targetClassName, array &$aspectContainer
         $proxyClass->addInterfaces($introducedInterfaces);
         $proxyClass->addTraits($introducedTraits);
 
-        /** @var $propertyIntroduction PropertyIntroduction */
+        /** @var PropertyIntroduction $propertyIntroduction */
         foreach ($propertyIntroductions as $propertyIntroduction) {
             $propertyName = $propertyIntroduction->getPropertyName();
             $declaringAspectClassName = $propertyIntroduction->getDeclaringAspectClassName();

Neos.Flow/Classes/Aop/Pointcut/PointcutExpressionParser.php

@@ -279,7 +279,6 @@ protected function parseDesignatorMethod(string $operator, string $signaturePatt
         $classNameFilter = new PointcutClassNameFilter($classPattern);
         $classNameFilter->injectReflectionService($this->reflectionService);
         $methodNameFilter = new PointcutMethodNameFilter($methodNamePattern, $methodVisibility, $methodArgumentConstraints);
-        /** @var LoggerInterface $logger */
         $logger = $this->objectManager->get(PsrLoggerFactoryInterface::class)->get('systemLogger');
         $methodNameFilter->injectLogger($logger);
         $methodNameFilter->injectReflectionService($this->reflectionService);

Neos.Flow/Classes/Aop/Pointcut/RuntimeExpressionEvaluator.php

@@ -11,6 +11,7 @@
  * source code.
  */
 
+use Neos\Cache\Frontend\StringFrontend;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Aop\JoinPointInterface;
 use Neos\Flow\Cache\CacheManager;

Neos.Flow/Classes/Cli/Response.php

@@ -47,12 +47,12 @@ class Response
     private $content = '';
 
     /**
-     * @var
+     * @var bool|int
      */
     private $colorSupport;
 
     /**
-     * @var
+     * @var int
      */
     private $outputFormat = self::OUTPUTFORMAT_STYLED;
 

Neos.Flow/Classes/Command/ConfigurationCommandController.php

@@ -17,8 +17,6 @@
 use Neos\Flow\Configuration\ConfigurationManager;
 use Neos\Flow\Configuration\ConfigurationSchemaValidator;
 use Neos\Flow\Configuration\Exception\SchemaValidationException;
-use Neos\Error\Messages\Error;
-use Neos\Error\Messages\Notice;
 use Neos\Utility\Arrays;
 use Neos\Utility\SchemaGenerator;
 
@@ -155,7 +153,6 @@ public function validateCommand(string $type = null, string $path = null, bool $
             if ($result->hasNotices()) {
                 $notices = $result->getFlattenedNotices();
                 $this->outputLine('<b>%d notices:</b>', [count($notices)]);
-                /** @var Notice $notice */
                 foreach ($notices as $path => $pathNotices) {
                     foreach ($pathNotices as $notice) {
                         $this->outputLine(' - %s -> %s', [$path, $notice->render()]);
@@ -168,7 +165,6 @@ public function validateCommand(string $type = null, string $path = null, bool $
         if ($result->hasErrors()) {
             $errors = $result->getFlattenedErrors();
             $this->outputLine('<b>%d errors were found:</b>', [count($errors)]);
-            /** @var Error $error */
             foreach ($errors as $path => $pathErrors) {
                 foreach ($pathErrors as $error) {
                     $this->outputLine(' - %s -> %s', [$path, $error->render()]);

Neos.Flow/Classes/Command/MiddlewareCommandController.php

@@ -13,7 +13,6 @@
 
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Cli\CommandController;
-use Neos\Flow\Mvc\Routing\Route;
 use Neos\Utility\PositionalArraySorter;
 
 /**
@@ -36,7 +35,6 @@ public function listCommand(): void
         $this->outputLine('<b>Currently configured middlewares:</b>');
         $rows = [];
         $index = 0;
-        /** @var Route $route */
         foreach ($orderedChainConfiguration->toArray() as $middlewareName => $middlewareConfiguration) {
             $rows[] = [
                 '#' => ++ $index,

Neos.Flow/Classes/Command/ResourceCommandController.php

@@ -24,7 +24,6 @@
 use Neos\Flow\ResourceManagement\ResourceManager;
 use Neos\Flow\ResourceManagement\ResourceRepository;
 use Neos\Media\Domain\Repository\AssetRepository;
-
 use Neos\Media\Domain\Repository\ThumbnailRepository;
 
 /**
@@ -98,6 +97,7 @@ public function publishCommand(string $collection = null)
                     /** @var CollectionInterface $collection */
                     $this->outputLine('Publishing resources of collection "%s"', [$collection->getName()]);
                     $target = $collection->getTarget();
+                    /** @phpstan-ignore-next-line will be fixed via https://github.com/neos/flow-development-collection/pull/3229 */
                     $target->publishCollection($collection, function ($iteration) {
                         $this->clearState($iteration);
                     });
@@ -232,13 +232,13 @@ public function cleanCommand()
         $assetRepository = class_exists(AssetRepository::class) ? $this->objectManager->get(AssetRepository::class) : null;
         /* @var ThumbnailRepository|null $thumbnailRepository */
         $thumbnailRepository = class_exists(ThumbnailRepository::class) ? $this->objectManager->get(ThumbnailRepository::class) : null;
-        $mediaPackagePresent = $assetRepository && $thumbnailRepository && $this->packageManager->isPackageAvailable('Neos.Media');
+        $mediaPackagePresent = $this->packageManager->isPackageAvailable('Neos.Media');
 
         if (count($brokenResources) > 0) {
             foreach ($brokenResources as $key => $resourceIdentifier) {
                 $resource = $this->resourceRepository->findByIdentifier($resourceIdentifier);
                 $brokenResources[$key] = $resource;
-                if ($mediaPackagePresent) {
+                if ($mediaPackagePresent && $assetRepository !== null && $thumbnailRepository !== null) {
                     $assets = $assetRepository->findByResource($resource);
                     if ($assets !== null) {
                         $relatedAssets[$resource] = $assets;
@@ -280,7 +280,7 @@ public function cleanCommand()
                         ]);
                         $resource->disableLifecycleEvents();
                         $this->resourceRepository->remove($resource);
-                        if ($mediaPackagePresent) {
+                        if ($mediaPackagePresent && $assetRepository !== null && $thumbnailRepository !== null) {
                             if (isset($relatedAssets[$resource])) {
                                 foreach ($relatedAssets[$resource] as $asset) {
                                     $assetRepository->removeWithoutUsageChecks($asset);

Neos.Flow/Classes/Command/SchemaCommandController.php

@@ -15,8 +15,6 @@
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Package\PackageManager;
 use Neos\Flow\Cli\CommandController;
-use Neos\Error\Messages\Error;
-use Neos\Error\Messages\Notice;
 use Neos\Utility\SchemaValidator;
 use Symfony\Component\Yaml\Yaml;
 use Neos\Utility\Files;
@@ -80,7 +78,6 @@ public function validateCommand(string $configurationFile = null, string $schema
             if ($result->hasNotices()) {
                 $notices = $result->getFlattenedNotices();
                 $this->outputLine('<b>%d notices:</b>', [count($notices)]);
-                /** @var Notice $notice */
                 foreach ($notices as $path => $pathNotices) {
                     foreach ($pathNotices as $notice) {
                         $this->outputLine(' - %s -> %s', [$path, $notice->render()]);
@@ -93,7 +90,6 @@ public function validateCommand(string $configurationFile = null, string $schema
         if ($result->hasErrors()) {
             $errors = $result->getFlattenedErrors();
             $this->outputLine('<b>%d errors were found:</b>', [count($errors)]);
-            /** @var Error $error */
             foreach ($errors as $path => $pathErrors) {
                 foreach ($pathErrors as $error) {
                     $this->outputLine(' - %s -> %s', [$path, $error->render()]);

Neos.Flow/Classes/Core/Booting/Scripts.php

@@ -41,6 +41,7 @@
 use Neos\Flow\ObjectManagement\ObjectManager;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 use Neos\Flow\Package\FlowPackageInterface;
+use Neos\Flow\Package\GenericPackage;
 use Neos\Flow\Package\PackageManager;
 use Neos\Flow\Reflection\ReflectionService;
 use Neos\Flow\Reflection\ReflectionServiceFactory;
@@ -577,8 +578,10 @@ public static function initializeSystemFileMonitor(Bootstrap $bootstrap)
             if (!in_array($packageKey, $packagesWithConfiguredObjects)) {
                 continue;
             }
-            foreach ($package->getAutoloadPaths() as $autoloadPath) {
-                self::monitorDirectoryIfItExists($fileMonitors['Flow_ClassFiles'], $autoloadPath, '\.php$');
+            if ($package instanceof GenericPackage) {
+                foreach ($package->getAutoloadPaths() as $autoloadPath) {
+                    self::monitorDirectoryIfItExists($fileMonitors['Flow_ClassFiles'], $autoloadPath, '\.php$');
+                }
             }
 
             // Note that getFunctionalTestsPath is currently not part of any interface... We might want to add it or find a better way.
@@ -602,8 +605,10 @@ public static function initializeSystemFileMonitor(Bootstrap $bootstrap)
      */
     protected static function getListOfPackagesWithConfiguredObjects(Bootstrap $bootstrap): array
     {
-        $objectManager = $bootstrap->getEarlyInstance(ObjectManagerInterface::class);
-        $packagesWithConfiguredObjects = array_reduce($objectManager->getAllObjectConfigurations(), function ($foundPackages, $item) {
+        $objectManager = $bootstrap->getObjectManager();
+        /** @phpstan-ignore-next-line the object manager interface doesn't specify this method */
+        $allObjectConfigurations = $objectManager->getAllObjectConfigurations();
+        $packagesWithConfiguredObjects = array_reduce($allObjectConfigurations, function ($foundPackages, $item) {
             if (isset($item['p']) && !in_array($item['p'], $foundPackages)) {
                 $foundPackages[] = $item['p'];
             }

Neos.Flow/Classes/Http/Client/InternalRequestEngine.php

@@ -126,11 +126,12 @@ public function sendRequest(RequestInterface $httpRequest): ResponseInterface
         }
 
         $requestHandler = $this->bootstrap->getActiveRequestHandler();
-        /** @phpstan-ignore-next-line */
+        /** @phpstan-ignore-next-line composer doesnt autoload this class */
         if (!$requestHandler instanceof FunctionalTestRequestHandler) {
             throw new Http\Exception('The browser\'s internal request engine has only been designed for use within functional tests.', 1335523749);
         }
 
+        /** @phpstan-ignore-next-line composer doesnt autoload this class */
         $requestHandler->setHttpRequest($httpRequest);
         $this->securityContext->clearContext();
         $this->validatorResolver->reset();
@@ -142,6 +143,7 @@ public function sendRequest(RequestInterface $httpRequest): ResponseInterface
          */
         $middlewaresChain = $objectManager->get(Http\Middleware\MiddlewaresChain::class);
         $middlewaresChain->onStep(function (ServerRequestInterface $request) use ($requestHandler) {
+            /** @phpstan-ignore-next-line composer doesnt autoload this class */
             $requestHandler->setHttpRequest($request);
         });
 

Neos.Flow/Classes/I18n/Xliff/Service/XliffReader.php

@@ -39,6 +39,7 @@ public function readFiles($sourcePath, callable $iterator)
         $reader->open($sourcePath);
         $reader->read();
 
+        /** @var object|\XMLReader $reader the stubs for XMLReader are wrong https://github.com/phpstan/phpstan/issues/8629 */
         if ($reader->nodeType == \XMLReader::ELEMENT && $reader->name === 'xliff') {
             $version = $reader->getAttribute('version');
             $result = true;
@@ -66,6 +67,7 @@ public function readFiles($sourcePath, callable $iterator)
      */
     protected function isFileNode(\XMLReader $reader)
     {
+        /** @var object|\XMLReader $reader the stubs for XMLReader are wrong https://github.com/phpstan/phpstan/issues/8629 */
         return $reader->nodeType === \XMLReader::ELEMENT && $reader->name === 'file';
     }
 }

Neos.Flow/Classes/Log/ThrowableStorage/FileStorage.php

@@ -266,7 +266,6 @@ protected function cleanupThrowableDumps(): void
         if ($this->maximumThrowableDumpAge > 0) {
             $cutoffTime = time() - $this->maximumThrowableDumpAge;
 
-            /** @var \SplFileInfo $directoryEntry */
             $iterator = new \DirectoryIterator($this->storagePath);
             foreach ($iterator as $directoryEntry) {
                 if ($directoryEntry->isFile() && $directoryEntry->getCTime() < $cutoffTime) {

Neos.Flow/Classes/Mvc/Controller/Arguments.php

@@ -18,7 +18,7 @@
  * A composite of controller arguments
  *
  * @api
- * @extends \ArrayObject<Argument>
+ * @extends \ArrayObject<string, Argument>
  */
 class Arguments extends \ArrayObject
 {