fix: PHPStan

Author: vincentchalamon

phpstan.neon.dist

@@ -39,6 +39,10 @@ parameters:
 			- handleNotFound
 	ignoreErrors:
 		# False positives
+		-
+			message: '#but database expects#'
+			paths:
+				- tests/Fixtures/TestBundle/Entity/
 		-
 			message: '#is never read, only written.#'
 			paths:
@@ -49,14 +53,12 @@ parameters:
 			message: '#is never written, only read.#'
 			paths:
 				- tests/Fixtures/TestBundle/Document/
-				- tests/Fixtures/TestBundle/Entity/
 		- '#Access to an undefined property Prophecy\\Prophecy\\ObjectProphecy<(\\?[a-zA-Z0-9_]+)+>::\$[a-zA-Z0-9_]+#'
 		# https://github.com/willdurand/Negotiation/issues/89#issuecomment-513283286
 		-
 			message: '#Call to an undefined method Negotiation\\AcceptHeader::getType\(\)\.#'
 			path: src/Symfony/EventListener/AddFormatListener.php
 		- '#Parameter \#1 \$vars of class GraphQL\\Language\\AST\\(IntValue|ObjectField|ObjectValue|BooleanValue|ListValue|StringValue)Node constructor expects array<bool\|float\|GraphQL\\Language\\AST\\Location\|GraphQL\\Language\\AST\\NameNode\|GraphQL\\Language\\AST\\NodeList\|GraphQL\\Language\\AST\\SelectionSetNode\|int\|string\|null>, array<string, .+> given\.#'
-		- '#Parameter \#1 \$defaultContext of class Symfony\\Component\\Serializer\\Encoder\\Json(De|En)code constructor expects array, (int|true) given\.#'
 		-
 			message: '#Parameter \#1 \$objectValue of method GraphQL\\Type\\Definition\\InterfaceType::resolveType\(\) expects object, array(<string, string>)? given.#'
 			path: tests/GraphQl/Type/TypeBuilderTest.php
@@ -74,23 +76,10 @@ parameters:
 		-
 			message: "#Call to function method_exists\\(\\) with ApiPlatform\\\\JsonApi\\\\Serializer\\\\ItemNormalizer and 'setCircularReferenc…' will always evaluate to false\\.#"
 			path: tests/JsonApi/Serializer/ItemNormalizerTest.php
-		-
-			message: "#Dead catch - JsonException is never thrown in the try block.#"
-			path: src/Symfony/Bundle/Test/Response.php
 		# See https://github.com/phpstan/phpstan-symfony/issues/27
 		-
 			message: '#^Service "[^"]+" is private.$#'
 			path: src
 		-
 			message: '#^Property .+ is unused.$#'
 			path: tests/Doctrine/Odm/PropertyInfo/Fixtures/DoctrineDummy.php
-		-
-			message: '#Call to an undefined method Symfony\\Component\\PropertyInfo\\Type::getCollectionValueType\(\)#'
-			path: src
-		-
-			message: '#Call to an undefined method Symfony\\Component\\PropertyInfo\\Type::getCollectionKeyType\(\)#'
-			path: src
-		# Skipped tests, we do this on purpose
-		-
-			message: "#Access to an undefined static property static\\([^)]+\\)::\\$container.$#"
-			path: tests

rector.php

@@ -30,7 +30,7 @@
     ]);
     $rectorConfig->phpstanConfig(__DIR__.'/phpstan.neon.dist');
     $rectorConfig->importNames();
-    $rectorConfig->disableImportShortClasses();
+    $rectorConfig->importShortClasses(false);
 
     $rectorConfig->rule(InlineConstructorDefaultToPropertyRector::class);
 

src/Api/IdentifiersExtractor.php

@@ -33,7 +33,7 @@
 final class IdentifiersExtractor implements IdentifiersExtractorInterface
 {
     use ResourceClassInfoTrait;
-    private readonly PropertyAccessorInterface|PropertyAccessor $propertyAccessor;
+    private readonly PropertyAccessorInterface $propertyAccessor;
 
     public function __construct(ResourceMetadataCollectionFactoryInterface $resourceMetadataFactory, ResourceClassResolverInterface $resourceClassResolver, private readonly PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, private readonly PropertyMetadataFactoryInterface $propertyMetadataFactory, PropertyAccessorInterface $propertyAccessor = null)
     {

src/Doctrine/Common/PropertyHelperTrait.php

@@ -71,8 +71,6 @@ protected function isPropertyEmbedded(string $property, string $resourceClass):
      * Returns an array with the following keys:
      *   - associations: array of associations according to nesting order
      *   - field: string holding the actual field (leaf node)
-     *
-     * @return array{associations: string[], field: string}
      */
     protected function splitPropertyParts(string $property, string $resourceClass): array
     {

src/Doctrine/Odm/Filter/SearchFilter.php

@@ -142,8 +142,6 @@ protected function filterProperty(string $property, $value, Builder $aggregation
 
     /**
      * Add equality match stage according to the strategy.
-     *
-     * @param mixed $values
      */
     private function addEqualityMatchStrategy(string $strategy, Builder $aggregationBuilder, string $field, string $matchField, array $values, bool $caseSensitive, ClassMetadata $metadata): void
     {

src/GraphQl/Resolver/Stage/SerializeStage.php

@@ -109,8 +109,6 @@ public function __invoke($itemOrCollection, string $resourceClass, Operation $op
     /**
      * @throws \LogicException
      * @throws \UnexpectedValueException
-     *
-     * @return array{totalCount: float|int, edges: array<mixed, array{node: mixed[]|bool|float|int|string|null, cursor: string}>, pageInfo: array{startCursor: string|null, endCursor: string|null, hasNextPage: bool, hasPreviousPage: bool}}
      */
     private function serializeCursorBasedPaginatedCollection(iterable $collection, array $normalizationContext, array $context): array
     {
@@ -175,8 +173,6 @@ private function serializeCursorBasedPaginatedCollection(iterable $collection, a
 
     /**
      * @throws \LogicException
-     *
-     * @return array{collection: bool[]|float[]|int[]|string[]|mixed[][]|null[], paginationInfo: array{itemsPerPage: float, totalCount: float, lastPage: float}}
      */
     private function serializePageBasedPaginatedCollection(iterable $collection, array $normalizationContext): array
     {
@@ -196,33 +192,21 @@ private function serializePageBasedPaginatedCollection(iterable $collection, arr
         return $data;
     }
 
-    /**
-     * @return array{totalCount: float, edges: never[], pageInfo: array{startCursor: null, endCursor: null, hasNextPage: false, hasPreviousPage: false}}
-     */
     private function getDefaultCursorBasedPaginatedData(): array
     {
         return ['totalCount' => 0., 'edges' => [], 'pageInfo' => ['startCursor' => null, 'endCursor' => null, 'hasNextPage' => false, 'hasPreviousPage' => false]];
     }
 
-    /**
-     * @return array{collection: never[], paginationInfo: array{itemsPerPage: float, totalCount: float, lastPage: float}}
-     */
     private function getDefaultPageBasedPaginatedData(): array
     {
         return ['collection' => [], 'paginationInfo' => ['itemsPerPage' => 0., 'totalCount' => 0., 'lastPage' => 0.]];
     }
 
-    /**
-     * @return array{clientMutationId: mixed}
-     */
     private function getDefaultMutationData(array $context): array
     {
         return ['clientMutationId' => $context['args']['input']['clientMutationId'] ?? null];
     }
 
-    /**
-     * @return array{clientSubscriptionId: mixed}
-     */
     private function getDefaultSubscriptionData(array $context): array
     {
         return ['clientSubscriptionId' => $context['args']['input']['clientSubscriptionId'] ?? null];

src/GraphQl/Type/FieldsBuilder.php

@@ -29,8 +29,6 @@
 use ApiPlatform\State\Pagination\Pagination;
 use ApiPlatform\Util\Inflector;
 use GraphQL\Type\Definition\InputObjectType;
-use GraphQL\Type\Definition\InterfaceType;
-use GraphQL\Type\Definition\NonNull;
 use GraphQL\Type\Definition\NullableType;
 use GraphQL\Type\Definition\Type as GraphQLType;
 use GraphQL\Type\Definition\WrappingType;
@@ -53,8 +51,6 @@ public function __construct(private readonly PropertyNameCollectionFactoryInterf
 
     /**
      * {@inheritdoc}
-     *
-     * @return array{type: InterfaceType, args: array{id: array{type: NonNull}}, resolve: callable}
      */
     public function getNodeQueryFields(): array
     {
@@ -379,7 +375,7 @@ private function getFilterArgs(array $args, ?string $resourceClass, string $root
         }
 
         foreach ($operation->getFilters() ?? [] as $filterId) {
-            if (null === $this->filterLocator || !$this->filterLocator->has($filterId)) {
+            if (!$this->filterLocator->has($filterId)) {
                 continue;
             }
 
@@ -410,11 +406,7 @@ private function getFilterArgs(array $args, ?string $resourceClass, string $root
         return $this->convertFilterArgsToTypes($args);
     }
 
-    /**
-     * @param AbstractOperation|null $operation
-     * @param mixed                  $original
-     */
-    private function mergeFilterArgs(array $args, array $parsed, $operation = null, string $original = ''): array
+    private function mergeFilterArgs(array $args, array $parsed, ?AbstractOperation $operation = null, string $original = ''): array
     {
         foreach ($parsed as $key => $value) {
             // Never override keys that cannot be merged

src/GraphQl/Type/TypeBuilder.php

@@ -25,7 +25,6 @@
 use ApiPlatform\State\Pagination\Pagination;
 use GraphQL\Type\Definition\InputObjectType;
 use GraphQL\Type\Definition\InterfaceType;
-use GraphQL\Type\Definition\ListOfType;
 use GraphQL\Type\Definition\NonNull;
 use GraphQL\Type\Definition\ObjectType;
 use GraphQL\Type\Definition\Type as GraphQLType;
@@ -245,9 +244,6 @@ public function isCollection(Type $type): bool
         return $type->isCollection() && ($collectionValueType = $type->getCollectionValueTypes()[0] ?? null) && null !== $collectionValueType->getClassName();
     }
 
-    /**
-     * @return array{edges: ListOfType, pageInfo: NonNull, totalCount: NonNull}
-     */
     private function getCursorBasedPaginationFields(GraphQLType $resourceType): array
     {
         $shortName = $resourceType->name;
@@ -283,9 +279,6 @@ private function getCursorBasedPaginationFields(GraphQLType $resourceType): arra
         ];
     }
 
-    /**
-     * @return array{collection: ListOfType, paginationInfo: NonNull}
-     */
     private function getPageBasedPaginationFields(GraphQLType $resourceType): array
     {
         $shortName = $resourceType->name;

src/Hal/Serializer/CollectionNormalizer.php

@@ -35,8 +35,6 @@ public function __construct(ResourceClassResolverInterface $resourceClassResolve
 
     /**
      * {@inheritdoc}
-     *
-     * @return array{_links: array{self: array{href: string}, first?: array{href: string}, last?: array{href: string}, prev?: array{href: string}, next?: array{href: string}}, totalItems?: mixed, itemsPerPage?: int}
      */
     protected function getPaginationData($object, array $context = []): array
     {

src/Hal/Serializer/EntrypointNormalizer.php

@@ -38,8 +38,6 @@ public function __construct(private readonly ResourceMetadataCollectionFactoryIn
 
     /**
      * {@inheritdoc}
-     *
-     * @return array{_links: array<string, array{href: string|null}>&mixed[]}
      */
     public function normalize(mixed $object, string $format = null, array $context = []): array
     {