Merge pull request #3261 from mhsdesign/task/phpStanLevel3

TASK: *PLING PLING* phpstan level 3

Neos.Cache/Classes/Backend/BackendInterface.php

@@ -51,7 +51,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 integer $lifetime Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.
+     * @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.
      * @throws \InvalidArgumentException if the identifier is not valid

Neos.Cache/Classes/Backend/FileBackend.php

@@ -48,7 +48,7 @@ class FileBackend extends SimpleFileBackend implements PhpCapableBackendInterfac
     protected $cacheEntryFileExtension = '';
 
     /**
-     * @var array
+     * @var array<string>
      */
     protected $cacheEntryIdentifiers = [];
 

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

@@ -39,7 +39,7 @@ class CacheItem implements CacheItemInterface
 
 
     /**
-     * @var \DateTime|null
+     * @var \DateTimeInterface|null
      */
     protected $expirationDate;
 
@@ -127,7 +127,7 @@ public function expiresAfter(int|\DateInterval|null $time): static
     }
 
     /**
-     * @return \DateTime|null
+     * @return \DateTimeInterface|null
      */
     public function getExpirationDate()
     {

Neos.Eel/Classes/FlowQuery/FlowQuery.php

@@ -145,13 +145,13 @@ public function setOperationResolver(OperationResolverInterface $operationResolv
     }
 
     /**
-     * Add a new operation to the operation list and return the new FlowQuery
-     * object. If the operation is final, we directly compute the result and
-     * return the value.
+     * Add a new operation to the operation list and return the new FlowQuery object.
+     *
+     * If the operation is final, we directly compute the result and return the value.
      *
      * @param string $operationName
      * @param array $arguments
-     * @return FlowQuery
+     * @return FlowQuery|mixed
      */
     public function __call($operationName, array $arguments)
     {

Neos.Eel/Classes/FlowQuery/OperationInterface.php

@@ -58,7 +58,7 @@ public function canEvaluate($context);
      *
      * @param FlowQuery $flowQuery the FlowQuery object
      * @param array $arguments the arguments for this operation
-     * @return mixed|null if the operation is final, the return value
+     * @return mixed if the operation is final, the return value
      */
     public function evaluate(FlowQuery $flowQuery, array $arguments);
 }

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

@@ -40,7 +40,7 @@ class IsOperation extends AbstractOperation
      *
      * @param FlowQuery $flowQuery the FlowQuery object
      * @param array $arguments the filter arguments
-     * @return void|boolean
+     * @return mixed
      */
     public function evaluate(FlowQuery $flowQuery, array $arguments)
     {
@@ -49,6 +49,7 @@ public function evaluate(FlowQuery $flowQuery, array $arguments)
         } else {
             $flowQuery->pushOperation('is', []);
             $flowQuery->pushOperation('filter', $arguments);
+            return null;
         }
     }
 }

Neos.Eel/Classes/Helper/MathHelper.php

@@ -421,7 +421,7 @@ public function round($subject, $precision = 0)
      * Get the sign of the given number, indicating whether the number is positive, negative or zero
      *
      * @param integer|float $x The value
-     * @return integer -1, 0, 1 depending on the sign or NAN if the given value was not numeric
+     * @return integer|float -1, 0, 1 depending on the sign or NAN if the given value was not numeric
      */
     public function sign($x)
     {

Neos.Error.Messages/Classes/Result.php

@@ -345,7 +345,7 @@ public function hasMessages(): bool
      * where the key is the property path where the error occurred, and the
      * value is a list of all errors (stored as array)
      *
-     * @return array<Error>
+     * @return array<string, array<int, Error>>
      * @api
      */
     public function getFlattenedErrors(): array
@@ -361,7 +361,7 @@ public function getFlattenedErrors(): array
      * value is a list of all errors (stored as array)
      *
      * @param string $type
-     * @return array<Error>
+     * @return array<string, array<int, Error>>
      * @api
      */
     public function getFlattenedErrorsOfType(string $type): array
@@ -376,7 +376,7 @@ public function getFlattenedErrorsOfType(string $type): array
      * where the key is the property path where the warning occurred, and the
      * value is a list of all warnings (stored as array)
      *
-     * @return array<Warning>
+     * @return array<string, array<int, Warning>>
      * @api
      */
     public function getFlattenedWarnings(): array
@@ -391,7 +391,7 @@ public function getFlattenedWarnings(): array
      * where the key is the property path where the notice occurred, and the
      * value is a list of all notices (stored as array)
      *
-     * @return array<Notice>
+     * @return array<string, array<int, Notice>>
      * @api
      */
     public function getFlattenedNotices(): array
@@ -408,6 +408,7 @@ public function getFlattenedNotices(): array
      * @param array $result The current result to be flattened
      * @param array $level The property path in the format array('level1', 'level2', ...) for recursion
      * @param string $messageTypeFilter If specified only messages implementing the given class name are taken into account
+     * @param-out array<string, array<int, mixed>> $result
      * @return void
      */
     public function flattenTree(string $propertyName, array &$result, array $level = [], string $messageTypeFilter = null)

Neos.Flow.Log/Classes/PlainTextFormatter.php

@@ -36,7 +36,7 @@ public function format($spaces = 4)
      * @param mixed $var The variable
      * @param integer $spaces Indent for this var dump
      * @param int $continuationSpaces Running total indentation (INTERNAL)
-     * @return string text output
+     * @return string|null text output
      */
     protected function renderVariableAsPlaintext($var, $spaces = 4, $continuationSpaces = 0)
     {

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

@@ -11,7 +11,7 @@
  * source code.
  */
 
-use Neos\Cache\Frontend\StringFrontend;
+use Neos\Cache\Frontend\FrontendInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Aop\JoinPointInterface;
 use Neos\Flow\Cache\CacheManager;
@@ -28,7 +28,7 @@
 class RuntimeExpressionEvaluator
 {
     /**
-     * @var StringFrontend
+     * @var FrontendInterface
      */
     protected $runtimeExpressionsCache;
 
@@ -54,7 +54,6 @@ public function injectObjectManager(ObjectManagerInterface $objectManager): void
     {
         if ($this->objectManager === null) {
             $this->objectManager = $objectManager;
-            /** @var CacheManager $cacheManager */
             $cacheManager = $this->objectManager->get(CacheManager::class);
             $this->runtimeExpressionsCache = $cacheManager->getCache('Flow_Aop_RuntimeExpressions');
         }

Neos.Flow/Classes/Cli/ConsoleOutput.php

@@ -32,12 +32,12 @@
 class ConsoleOutput
 {
     /**
-     * @var SymfonyConsoleOutput
+     * @var OutputInterface
      */
     protected $output;
 
     /**
-     * @var SymfonyStringInput
+     * @var InputInterface
      */
     protected $input;
 
@@ -158,7 +158,7 @@ public function outputTable(array $rows, array $headers = null, string $headerTi
      *
      * @param string|array $question The question to ask. If an array each array item is turned into one line of a multi-line question
      * @param array $choices List of choices to pick from
-     * @param mixed|null $default The default answer if the user enters nothing
+     * @param string|bool|int|float|null $default The default answer if the user enters nothing
      * @param boolean $multiSelect If true the result will be an array with the selected options. Multiple options can be given separated by commas
      * @param integer|null $attempts Max number of times to ask before giving up (null by default, which means infinite)
      * @return integer|string|array Either the value for indexed arrays, the key for associative arrays or an array for multiple selections
@@ -291,7 +291,7 @@ public function askHiddenResponseAndValidate($question, callable $validator, int
     /**
      * Starts the progress output
      *
-     * @param integer $max Maximum steps. If NULL an indeterminate progress bar is rendered
+     * @param integer|null $max Maximum steps. If NULL an indeterminate progress bar is rendered
      * @return void
      */
     public function progressStart(int $max = null): void

Neos.Flow/Classes/Cli/Request.php

@@ -32,7 +32,7 @@ class Request
     protected $controllerCommandName = 'default';
 
     /**
-     * @var Command
+     * @var Command|null
      */
     protected $command;
 

Neos.Flow/Classes/Cli/Response.php

@@ -47,7 +47,7 @@ class Response
     private $content = '';
 
     /**
-     * @var bool|null
+     * @var bool|null true, false or NULL (= autodetection)
      */
     private $colorSupport;
 

Neos.Flow/Classes/Command/CacheCommandController.php

@@ -25,7 +25,6 @@
 use Neos\Flow\Core\Bootstrap;
 use Neos\Flow\Core\LockManager;
 use Neos\Flow\Mvc\Exception\StopActionException;
-use Neos\Flow\ObjectManagement\ObjectManager;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
 use Neos\Flow\Package\PackageManager;
 use Neos\Flow\Utility\Environment;
@@ -61,7 +60,7 @@ class CacheCommandController extends CommandController
     protected $bootstrap;
 
     /**
-     * @var ObjectManager
+     * @var ObjectManagerInterface
      */
     protected $objectManager;
 

Neos.Flow/Classes/Command/RoutingCommandController.php

@@ -91,7 +91,7 @@ public function listCommand(): void
      */
     public function showCommand(int $index): void
     {
-        $route = $this->routesProvider->getRoutes()[$index - 1] ?? null;
+        $route = iterator_to_array($this->routesProvider->getRoutes())[$index - 1] ?? null;
         if ($route === null) {
             $this->outputLine('<error>Route %d was not found!</error>', [$index]);
             $this->outputLine('Run <i>./flow routing:list</i> to show all registered routes');

Neos.Flow/Classes/Command/SecurityCommandController.php

@@ -11,9 +11,9 @@
  * source code.
  */
 
+use Neos\Cache\Frontend\FrontendInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\Cache\CacheManager;
-use Neos\Cache\Frontend\VariableFrontend;
 use Neos\Flow\Cli\CommandController;
 use Neos\Flow\Configuration\Exception\InvalidConfigurationTypeException;
 use Neos\Flow\Mvc\Controller\AbstractController;
@@ -60,7 +60,7 @@ class SecurityCommandController extends CommandController
     protected $policyService;
 
     /**
-     * @var VariableFrontend
+     * @var FrontendInterface
      */
     protected $methodPermissionCache;
 

Neos.Flow/Classes/Http/ContentStream.php

@@ -25,7 +25,7 @@
 class ContentStream implements StreamInterface
 {
     /**
-     * @var resource
+     * @var resource|null
      */
     protected $resource;
 

Neos.Flow/Classes/Http/Cookie.php

@@ -169,7 +169,7 @@ public function __construct($name, $value = null, $expires = 0, $maximumAge = nu
      * rather than the created cookie.
      *
      * @param string $header The Set-Cookie string without the actual "Set-Cookie:" part
-     * @return Cookie
+     * @return Cookie|null
      * @see http://tools.ietf.org/html/rfc6265
      */
     public static function createFromRawSetCookieHeader($header)

Neos.Flow/Classes/Http/Headers.php

@@ -161,7 +161,7 @@ public function getRaw(string $name): array
      * Dates are returned as DateTime objects with the timezone set to GMT.
      *
      * @param string $name Name of the header, for example "Location", "Content-Description" etc.
-     * @return array|string An array of field values if multiple headers of that name exist, a string value if only one value exists and NULL if there is no such header.
+     * @return array|string|null An array of field values if multiple headers of that name exist, a string value if only one value exists and NULL if there is no such header.
      * @api
      */
     public function get($name)

Neos.Flow/Classes/I18n/Cldr/CldrRepository.php

@@ -73,7 +73,7 @@ public function injectLocalizationService(I18n\Service $localizationService)
      * file.
      *
      * @param string $filename Relative (from CLDR root) path to existing CLDR file
-     * @return CldrModel|boolean A CldrModel instance or false on failure
+     * @return CldrModel|false A CldrModel instance or false on failure
      */
     public function getModel($filename)
     {

Neos.Flow/Classes/I18n/Formatter/DatetimeFormatter.php

@@ -228,9 +228,9 @@ protected function doFormattingForSubpattern(\DateTimeInterface $dateTime, $subf
             case 'd':
                 return $this->padString($dateTime->format('j'), $formatLengthOfSubformat);
             case 'D':
-                return $this->padString((int)($dateTime->format('z') + 1), $formatLengthOfSubformat);
+                return $this->padString(((int)$dateTime->format('z') + 1), $formatLengthOfSubformat);
             case 'F':
-                return (int)(($dateTime->format('j') + 6) / 7);
+                return (string)(int)(((int)$dateTime->format('j') + 6) / 7);
             case 'M':
             case 'L':
                 $month = (int)$dateTime->format('n');

Neos.Flow/Classes/I18n/LocaleTypeConverter.php

@@ -24,7 +24,7 @@
 class LocaleTypeConverter extends AbstractTypeConverter
 {
     /**
-     * @var string
+     * @var array<string>
      */
     protected $sourceTypes = ['string'];
 

Neos.Flow/Classes/I18n/Parser/DatetimeParser.php

@@ -143,7 +143,7 @@ protected function doParsingWithParsedFormat($datetimeToParse, array $parsedForm
      * @param string $datetimeToParse Date/time to be parsed
      * @param array $parsedFormat Format parsed by DatesReader
      * @param array $localizedLiterals Array of date / time literals from CLDR
-     * @return array Array of parsed date and / or time elements, false on failure
+     * @return array|false Array of parsed date and / or time elements, false on failure
      * @throws InvalidArgumentException When unexpected symbol found in format
      * @see DatesReader
      */

Neos.Flow/Classes/Log/PsrLoggerFactory.php

@@ -70,7 +70,7 @@ public function get(string $identifier): \Psr\Log\LoggerInterface
      * Create a new instance of this PsrLoggerFactory
      *
      * @param array $configuration
-     * @return static
+     * @return PsrLoggerFactory
      * @api
      */
     public static function create(array $configuration): PsrLoggerFactory

Neos.Flow/Classes/Monitor/FileMonitor.php

@@ -81,7 +81,7 @@ class FileMonitor
     /**
      * Array of directories and files that were cached on the last run.
      *
-     * @var array
+     * @var array|null
      */
     protected $directoriesAndFiles = null;
 

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

@@ -45,7 +45,7 @@ class Argument
 
     /**
      * Actual value of this argument
-     * @var object
+     * @var object|null
      */
     protected $value = null;
 

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

@@ -221,7 +221,7 @@ public function __call($methodName, array $arguments)
      * string is returned.
      *
      * @param string $argumentName argument name
-     * @return string long argument name or empty string
+     * @return string|false long argument name or empty string
      */
     protected function validateArgumentExistence($argumentName)
     {

Neos.Flow/Classes/Mvc/Routing/DynamicRoutePart.php

@@ -204,7 +204,7 @@ final public function resolveWithParameters(array &$routeValues, RouteParameters
      * This method can be overridden by custom RoutePartHandlers to implement custom resolving mechanisms.
      *
      * @param array $routeValues An array with key/value pairs to be resolved by Dynamic Route Parts.
-     * @return string|array value to resolve.
+     * @return string|array|null value to resolve.
      * @api
      */
     protected function findValueToResolve(array $routeValues)

Neos.Flow/Classes/Mvc/Routing/Route.php

@@ -92,7 +92,7 @@ class Route
      * Contains the routing results (indexed by "package", "controller" and
      * "action") after a successful call of matches()
      *
-     * @var array
+     * @var array|null
      */
     protected $matchResults = [];