Upgrade PHPStan to 0.10 and fix new violations

Author: dunglas

.circleci/config.yml

@@ -110,7 +110,7 @@ jobs:
       - *update-project-dependencies
       - run:
           name: Install PHPStan
-          command: composer global require phpstan/phpstan:^0.8
+          command: composer global require phpstan/phpstan:^0.10
       - *save-composer-cache-by-revision
       - *save-composer-cache-by-branch
       - run:

phpstan.neon

@@ -3,16 +3,35 @@ parameters:
         - tests/Fixtures/app/AppKernel.php
     excludes_analyse:
         - tests/Fixtures/app/cache
+        # The Symfony Configuration API isn't good enough to be analysed
+        - src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
     ignoreErrors:
-        - '#Call to an undefined method Symfony\\Component\\Routing\\Exception\\ExceptionInterface::getCode\(\)#'
-        - '#Call to an undefined method Prophecy\\Prophecy\\ObjectProphecy::[a-zA-Z0-9_]+\(\)#'
-        - '#Access to an undefined property Prophecy\\Prophecy\\ObjectProphecy::\$[a-zA-Z0-9_]+#'
-        - '#Call to an undefined method PHPUnit\\Framework\\MockObject\\MockObject::[a-zA-Z0-9_]+\(\)#'
-        - '#Call to an undefined method Doctrine\\Common\\Persistence\\Mapping\\ClassMetadata::getAssociationMappings\(\)#'
+        # Real problems, hard to fix
+        - '#Parameter \#2 \$dqlPart of method Doctrine\\ORM\\QueryBuilder::add\(\) expects array\|object, string given\.#'
 
         # False positives
+        - '#Access to an undefined property Prophecy\\Prophecy\\ObjectProphecy::\$[a-zA-Z0-9_]+#'
+        - '#Access to an undefined property object::\$isIdentifierComposite.#'
         - '#Call to an undefined method Doctrine\\Common\\Persistence\\ObjectManager::getConnection\(\)#'
-        - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryResult(Item|Collection)ExtensionInterface::supportsResult\(\) invoked with 3 parameters, 1-2 required\.#'
+        - '#Call to an undefined method PHPUnit\\Framework\\MockObject\\MockObject::[a-zA-Z0-9_]+\(\)#'
+        - '#Call to an undefined method Prophecy\\Prophecy\\ObjectProphecy::[a-zA-Z0-9_]+\(\)#'
+        - '#Method ApiPlatform\\Core\\Tests\\Bridge\\Doctrine\\Orm\\ItemDataProviderTest::getManagerRegistry\(\) should return Doctrine\\Common\\Persistence\\ManagerRegistry but returns object\.#'
+        - '#Method ApiPlatform\\Core\\Tests\\Bridge\\Doctrine\\Util\\IdentifierManagerTraitTest::getObjectManager\(\) should return Doctrine\\Common\\Persistence\\ObjectManager but returns object\.#'
+        # Temporary fix while the PHPStan extension for Prophecy isn't compatible with 0.10
+        - '#Parameter .* expects .*, .*object.* given\.#'
+        - '#Parameter \#[0-9] \$filterLocator of class ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\FilterExtension constructor expects ApiPlatform\\Core\\Api\\FilterCollection|Psr\\Container\\ContainerInterface(\|null)?, ArrayObject given\.#'
+        - '#Property ApiPlatform\\Core\\Test\\DoctrineOrmFilterTestCase::\$managerRegistry \(Doctrine\\Common\\Persistence\\ManagerRegistry\) does not accept object\.#'
+        - '#Property ApiPlatform\\Core\\Test\\DoctrineOrmFilterTestCase::\$repository \(Doctrine\\ORM\\EntityRepository\) does not accept Doctrine\\Common\\Persistence\\ObjectRepository\.#'
+        # https://github.com/doctrine/doctrine2/pull/7298/files
+        - '#Strict comparison using === between null and int will always evaluate to false\.#'
+        - '#Strict comparison using !== between null and null will always evaluate to false\.#'
+
+        # Expected, due to deprecations
         - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryResult(Item|Collection)ExtensionInterface::getResult\(\) invoked with 4 parameters, 1 required\.#'
+        - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryResult(Item|Collection)ExtensionInterface::supportsResult\(\) invoked with 3 parameters, 1-2 required\.#'
+        - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Filter\\AbstractFilter::apply\(\) invoked with 5 parameters, 3-4 required\.#'
         - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Filter\\AbstractFilter::filterProperty\(\) invoked with 7 parameters, 5-6 required\.#'
+        - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Filter\\FilterInterface::apply\(\) invoked with 5 parameters, 3-4 required\.#'
         - '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Filter\\OrderFilter::filterProperty\(\) invoked with 7 parameters, 5-6 required\.#'
+        - '#Method ApiPlatform\\Core\\DataProvider\\CollectionDataProviderInterface::getCollection\(\) invoked with 3 parameters, 1-2 required.#'
+        - '#PHPDoc tag @param references unknown parameter \$operationName#'

src/Annotation/ApiFilter.php

@@ -53,11 +53,11 @@ final class ApiFilter
 
     public function __construct($options = [])
     {
-        if (!isset($options['value'])) {
+        if (!\is_string($options['value'] ?? null)) {
             throw new InvalidArgumentException('This annotation needs a value representing the filter class.');
         }
 
-        if (!is_subclass_of($options['value'], FilterInterface::class)) {
+        if (!is_a($options['value'], FilterInterface::class, true)) {
             throw new InvalidArgumentException(sprintf('The filter class "%s" does not implement "%s".', $options['value'], FilterInterface::class));
         }
 

src/Api/ResourceClassResolver.php

@@ -51,7 +51,7 @@ public function getResourceClass($value, string $resourceClass = null, bool $str
             $typeToFind = $type = $resourceClass;
         }
 
-        if (($strict && isset($type) && $resourceClass !== $type) || false === $isResourceClass = $this->isResourceClass($typeToFind)) {
+        if (($strict && $resourceClass !== $type) || false === $isResourceClass = $this->isResourceClass($typeToFind)) {
             if (is_subclass_of($type, $resourceClass) && $this->isResourceClass($resourceClass)) {
                 return $type;
             }

src/Bridge/Doctrine/Orm/Extension/FilterExtension.php

@@ -61,13 +61,11 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
         }
 
         foreach ($resourceFilters as $filterId) {
-            if (!($filter = $this->getFilter($filterId)) instanceof FilterInterface) {
-                continue;
+            $filter = $this->getFilter($filterId);
+            if ($filter instanceof FilterInterface) {
+                $context['filters'] = $context['filters'] ?? [];
+                $filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context);
             }
-
-            $context['filters'] = $context['filters'] ?? [];
-
-            $filter->apply($queryBuilder, $queryNameGenerator, $resourceClass, $operationName, $context);
         }
     }
 }

src/Bridge/Doctrine/Orm/Extension/OrderExtension.php

@@ -60,8 +60,8 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
                         $order = 'ASC';
                     }
 
-                    if (false === ($pos = \strpos($field, '.'))
-                        || isset($classMetaData->embeddedClasses[\substr($field, 0, $pos)])) {
+                    $pos = strpos($field, '.');
+                    if (false === $pos || isset($classMetaData->embeddedClasses[\substr($field, 0, $pos)])) {
                         // Configure default filter with property
                         $field = "{$rootAlias}.{$field}";
                     } else {

src/Bridge/Doctrine/Orm/Filter/AbstractFilter.php

@@ -164,7 +164,8 @@ protected function isPropertyNested(string $property/*, string $resourceClass*/)
             $resourceClass = null;
         }
 
-        if (false === $pos = strpos($property, '.')) {
+        $pos = strpos($property, '.');
+        if (false === $pos) {
             return false;
         }
 

src/Bridge/Doctrine/Orm/Util/IdentifierManagerTrait.php

@@ -49,7 +49,7 @@ private function normalizeIdentifiers($id, ObjectManager $manager, string $resou
             $identifiersMap = [];
 
             // first transform identifiers to a proper key/value array
-            foreach (explode(';', $id) as $identifier) {
+            foreach (explode(';', (string) $id) as $identifier) {
                 if (!$identifier) {
                     continue;
                 }

src/Bridge/Doctrine/Orm/Util/QueryChecker.php

@@ -127,10 +127,9 @@ public static function hasOrderByOnToManyJoin(QueryBuilder $queryBuilder, Manage
             $parts = QueryJoinParser::getOrderByParts($orderBy);
 
             foreach ($parts as $part) {
-                if (false !== ($pos = strpos($part, '.'))) {
-                    $alias = substr($part, 0, $pos);
-
-                    $orderByAliases[$alias] = true;
+                $pos = strpos($part, '.');
+                if (false !== $pos) {
+                    $orderByAliases[substr($part, 0, $pos)] = true;
                 }
             }
         }

src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/AnnotationFilterPass.php

@@ -39,6 +39,9 @@ final class AnnotationFilterPass implements CompilerPassInterface
     public function process(ContainerBuilder $container)
     {
         $resourceClassDirectories = $container->getParameter('api_platform.resource_class_directories');
+        /**
+         * @var Reader
+         */
         $reader = $container->get('annotation_reader');
 
         foreach (ReflectionClassRecursiveIterator::getReflectionClassesFromDirectories($resourceClassDirectories) as $className => $reflectionClass) {