Merge pull request #2942 from teohhanhui/phpstan-infer-property-type-from-constructor

Enable "inferPrivatePropertyTypeFromConstructor" option in phpstan

Author: teohhanhui

.circleci/config.yml

@@ -224,7 +224,6 @@ jobs:
     working_directory: ~/api-platform/core
     steps:
       - checkout
-      - install-mongodb-php-extension
       - disable-xdebug-php-extension
       - disable-php-memory-limit
       - update-composer

.editorconfig

@@ -50,7 +50,7 @@ indent_size = 2
 [.gitmodules]
 indent_style = tab
 
-[.php_cs]
+[.php_cs{,.dist}]
 indent_style = space
 indent_size = 4
 

composer.json

@@ -49,7 +49,7 @@
         "phpdocumentor/type-resolver": "^0.3 || ^0.4",
         "phpspec/prophecy": "^1.8",
         "phpstan/extension-installer": "^1.0",
-        "phpstan/phpstan": "^0.11",
+        "phpstan/phpstan": "^0.11.10",
         "phpstan/phpstan-doctrine": "^0.11",
         "phpstan/phpstan-phpunit": "^0.11",
         "phpstan/phpstan-symfony": "^0.11",

phpstan.neon.dist

@@ -7,6 +7,7 @@ parameters:
 		- src
 		- tests
 		- tests/Fixtures/app/console
+	inferPrivatePropertyTypeFromConstructor: true
 	symfony:
 		container_xml_path: %rootDir%/../../../tests/Fixtures/app/var/cache/test/appAppKernelTestDebugContainer.xml
 		constant_hassers: false
@@ -32,6 +33,14 @@ parameters:
 			path: %currentWorkingDirectory%/src/GraphQl/Resolver/FieldsToAttributesTrait.php
 		- '#Access to an undefined property Prophecy\\Prophecy\\ObjectProphecy<(\\?[a-zA-Z0-9_]+)+>::\$[a-zA-Z0-9_]+#'
 		- '#Call to an undefined method Doctrine\\Common\\Persistence\\ObjectManager::getConnection\(\)#'
+		# https://github.com/willdurand/Negotiation/issues/89#issuecomment-513283286
+		-
+			message: '#Call to an undefined method Negotiation\\AcceptHeader::getType\(\)\.#'
+			path: %currentWorkingDirectory%/src/EventListener/AddFormatListener.php
+		# https://github.com/symfony/symfony/issues/31814#issuecomment-498749590
+		-
+			message: '#Call to an undefined method Symfony\\Component\\Security\\Core\\Role\\RoleHierarchyInterface::getReachableRoles\(\)\.#'
+			path: %currentWorkingDirectory%/src/Security/ResourceAccessChecker.php
 		- '#Parameter \#1 \$function of function call_user_func expects callable\(\): mixed, .+ given\.#'
 		- '#Parameter \#1 \$exception of static method Symfony\\Component\\Debug\\Exception\\FlattenException::create\(\) expects Exception, Symfony\\Component\\Serializer\\Exception\\ExceptionInterface given\.#'
 		- '#Parameter \#1 \$classes of class ApiPlatform\\Core\\Metadata\\Resource\\ResourceNameCollection constructor expects array<string>, array<int, int\|string> given\.#'
@@ -52,14 +61,8 @@ parameters:
 			message: '#Parameter \#1 \$collection of method ApiPlatform\\Core\\Tests\\GraphQl\\Resolver\\Factory\\CollectionResolverFactoryTest::createCollectionResolverFactory\(\) expects array\|Iterator, object given\.#'
 			path: %currentWorkingDirectory%/tests/GraphQl/Resolver/Factory/CollectionResolverFactoryTest.php
 		-
-			message: '#Parameter \#1 \$resourceClass of method ApiPlatform\\Core\\Metadata\\Property\\Factory\\InheritedPropertyMetadataFactory::create\(\) expects string, object\|string given\.#'
-			path: %currentWorkingDirectory%/src/Metadata/Property/Factory/InheritedPropertyMetadataFactory.php
-		-
-			message: '#Parameter \#1 \$childInherited of method ApiPlatform\\Core\\Metadata\\Property\\PropertyMetadata::withChildInherited\(\) expects string, object\|string given\.#'
-			path: %currentWorkingDirectory%/src/Metadata/Property/Factory/InheritedPropertyMetadataFactory.php
-		-
-			message: '#Parameter \#1 \$resourceClass of method ApiPlatform\\Core\\Metadata\\Property\\Factory\\InheritedPropertyNameCollectionFactory::create\(\) expects string, object\|string given\.#'
-			path: %currentWorkingDirectory%/src/Metadata/Property/Factory/InheritedPropertyNameCollectionFactory.php
+			message: '#Parameter \#1 \$docblock of method phpDocumentor\\Reflection\\DocBlockFactoryInterface::create\(\) expects string, ReflectionClass given\.#'
+			path: %currentWorkingDirectory%/src/Metadata/Resource/Factory/PhpDocResourceMetadataFactory.php
 		-
 			message: '#Property ApiPlatform\\Core\\Test\\DoctrineMongoDbOdmFilterTestCase::\$repository \(Doctrine\\ODM\\MongoDB\\Repository\\DocumentRepository\) does not accept Doctrine\\ORM\\EntityRepository<ApiPlatform\\Core\\Tests\\Fixtures\\TestBundle\\Document\\Dummy>\.#'
 			path: %currentWorkingDirectory%/src/Test/DoctrineMongoDbOdmFilterTestCase.php
@@ -85,14 +88,22 @@ parameters:
 			message: '#Binary operation "\+" between (float\|int\|)?string and 0 results in an error\.#'
 			path: %currentWorkingDirectory%/src/Bridge/Doctrine/Common/Filter/RangeFilterTrait.php
 
-		# Expected, due to deprecations
+		# Expected, due to optional interfaces
+		- '#Method ApiPlatform\\Core\\Bridge\\Doctrine\\Orm\\Extension\\QueryCollectionExtensionInterface::applyToCollection\(\) invoked with 5 parameters, 3-4 required\.#'
 		- '#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\\Symfony\\Routing\\RouteNameResolverInterface::getRouteName\(\) invoked with 3 parameters, 2 required\.#'
+		- '#Method ApiPlatform\\Core\\DataPersister\\DataPersisterInterface::persist\(\) invoked with 2 parameters, 1 required\.#'
+		- '#Method ApiPlatform\\Core\\DataPersister\\DataPersisterInterface::remove\(\) invoked with 2 parameters, 1 required\.#'
+		- '#Method ApiPlatform\\Core\\DataPersister\\DataPersisterInterface::supports\(\) invoked with 2 parameters, 1 required\.#'
+		- '#Method ApiPlatform\\Core\\DataProvider\\CollectionDataProviderInterface::getCollection\(\) invoked with 3 parameters, 1-2 required\.#'
+		- '#Method Symfony\\Component\\Serializer\\NameConverter\\NameConverterInterface::denormalize\(\) invoked with (2|3|4) parameters, 1 required\.#'
+		- '#Method Symfony\\Component\\Serializer\\NameConverter\\NameConverterInterface::normalize\(\) invoked with (2|3|4) parameters, 1 required\.#'
+		- '#Method Symfony\\Component\\Serializer\\Normalizer\\NormalizerInterface::supportsNormalization\(\) invoked with 3 parameters, 1-2 required\.#'
+
+		# Expected, due to deprecations
 		- '#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\.#'
-		- '#Method Symfony\\Component\\Serializer\\NameConverter\\NameConverterInterface::normalize\(\) invoked with 3 parameters, 1 required\.#'
-		- '#Method Symfony\\Component\\Serializer\\NameConverter\\NameConverterInterface::normalize\(\) invoked with 4 parameters, 1 required\.#'
-		- '#Class Symfony\\Component\\HttpKernel\\EventListener\\ExceptionListener constructor invoked with 5 parameters, 1-3 required\.#'
+		- '#Method ApiPlatform\\Core\\PathResolver\\OperationPathResolverInterface::resolveOperationPath\(\) invoked with 4 parameters, 3 required\.#'

src/Api/FormatMatcher.php

@@ -20,8 +20,14 @@
  */
 final class FormatMatcher
 {
+    /**
+     * @var array<string, string[]>
+     */
     private $formats;
 
+    /**
+     * @param array<string, string[]|string> $formats
+     */
     public function __construct(array $formats)
     {
         $normalizedFormats = [];

src/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -48,6 +48,9 @@ final class PublishMercureUpdatesListener
     private $deletedEntities;
     private $formats;
 
+    /**
+     * @param array<string, string[]|string> $formats
+     */
     public function __construct(ResourceClassResolverInterface $resourceClassResolver, IriConverterInterface $iriConverter, ResourceMetadataFactoryInterface $resourceMetadataFactory, SerializerInterface $serializer, array $formats, MessageBusInterface $messageBus = null, callable $publisher = null, ExpressionLanguage $expressionLanguage = null)
     {
         if (null === $messageBus && null === $publisher) {
@@ -166,6 +169,7 @@ private function publishUpdate($entity, array $targets): void
             // This may change in the feature, because it's not JSON Merge Patch compliant,
             // and I'm not a fond of this approach
             $iri = $entity->iri;
+            /** @var string $data */
             $data = json_encode(['@id' => $entity->id]);
         } else {
             $resourceClass = $this->getObjectClass($entity);

src/Bridge/Doctrine/MongoDbOdm/PropertyInfo/DoctrineExtractor.php

@@ -16,6 +16,7 @@
 use Doctrine\Common\Collections\Collection;
 use Doctrine\Common\Persistence\Mapping\MappingException;
 use Doctrine\Common\Persistence\ObjectManager;
+use Doctrine\ODM\MongoDB\Mapping\ClassMetadata as MongoDbClassMetadata;
 use Doctrine\ODM\MongoDB\Types\Type as MongoDbType;
 use Symfony\Component\PropertyInfo\PropertyListExtractorInterface;
 use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
@@ -63,17 +64,11 @@ public function getTypes($class, $property, array $context = [])
             return null;
         }
 
-        $reflectionMetadata = new \ReflectionClass($metadata);
-
         if ($metadata->hasAssociation($property)) {
             $class = $metadata->getAssociationTargetClass($property);
 
             if ($metadata->isSingleValuedAssociation($property)) {
-                if ($reflectionMetadata->hasMethod('isNullable')) {
-                    $nullable = $metadata->isNullable($property);
-                } else {
-                    $nullable = false;
-                }
+                $nullable = $metadata instanceof MongoDbClassMetadata && $metadata->isNullable($property);
 
                 return [new Type(Type::BUILTIN_TYPE_OBJECT, $nullable, $class)];
             }
@@ -94,7 +89,7 @@ public function getTypes($class, $property, array $context = [])
 
         if ($metadata->hasField($property)) {
             $typeOfField = $metadata->getTypeOfField($property);
-            $nullable = $reflectionMetadata->hasMethod('isNullable') && $metadata->isNullable($property);
+            $nullable = $metadata instanceof MongoDbClassMetadata && $metadata->isNullable($property);
 
             switch ($typeOfField) {
                 case MongoDbType::DATE:

src/Bridge/Doctrine/Orm/CollectionDataProvider.php

@@ -13,7 +13,6 @@
 
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm;
 
-use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\ContextAwareQueryCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\QueryResultCollectionExtensionInterface;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
@@ -36,9 +35,9 @@ class CollectionDataProvider implements ContextAwareCollectionDataProviderInterf
     private $collectionExtensions;
 
     /**
-     * @param QueryCollectionExtensionInterface[]|ContextAwareQueryCollectionExtensionInterface[] $collectionExtensions
+     * @param QueryCollectionExtensionInterface[] $collectionExtensions
      */
-    public function __construct(ManagerRegistry $managerRegistry, /* iterable */ $collectionExtensions = [])
+    public function __construct(ManagerRegistry $managerRegistry, iterable $collectionExtensions = [])
     {
         $this->managerRegistry = $managerRegistry;
         $this->collectionExtensions = $collectionExtensions;

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

@@ -38,6 +38,9 @@ final class PaginationExtension implements ContextAwareQueryResultCollectionExte
 {
     private $managerRegistry;
     private $requestStack;
+    /**
+     * @var ResourceMetadataFactoryInterface
+     */
     private $resourceMetadataFactory;
     private $enabled;
     private $clientEnabled;
@@ -50,6 +53,9 @@ final class PaginationExtension implements ContextAwareQueryResultCollectionExte
     private $partial;
     private $clientPartial;
     private $partialParameterName;
+    /**
+     * @var Pagination|null
+     */
     private $pagination;
 
     /**

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

@@ -27,7 +27,7 @@ interface QueryResultCollectionExtensionInterface extends QueryCollectionExtensi
     public function supportsResult(string $resourceClass, string $operationName = null): bool;
 
     /**
-     * @return array|\Traversable
+     * @return iterable
      */
     public function getResult(QueryBuilder $queryBuilder);
 }