Merge pull request #234 from moufmouf/phpstan_wrongly_ignored_errors

Fixing ignoreErrors section of PHPStan file

Author: moufmouf

phpstan.neon

@@ -1,12 +1,14 @@
 parameters:
     ignoreErrors:
         - "#PHPDoc tag \\@throws with type Psr\\\\Container\\\\ContainerExceptionInterface is not subtype of Throwable#"
-        - "#Property TheCodingMachine\\\\GraphQLite\\\\Types\\\\ResolvableInputObjectType::$resolve \\(array<int, object|string>&callable\\) does not accept array<int,object|string>#"
+        #- "#Property TheCodingMachine\\\\GraphQLite\\\\Types\\\\ResolvableInputObjectType::\\$resolve \\(array<int, object\\|string>&callable\\) does not accept array<int,object\\|string>#"
         - "#Variable \\$prefetchRefMethod might not be defined.#"
-        - "#Parameter \\#2 $type of class TheCodingMachine\\\\GraphQLite\\\\Parameters\\\\InputTypeParameter constructor expects GraphQL\\\\Type\\\\Definition\\\\InputType&GraphQL\\\\Type\\\\Definition\\\\Type, GraphQL\\\\Type\\\\Definition\\\\InputType|GraphQL\\\\Type\\\\Definition\\\\Type given.#"
-        - "#Parameter .* of class ReflectionMethod constructor expects string, object|string given.#"
-        - "#Method TheCodingMachine\\\\GraphQLite\\\\Types\\\\MutableObjectType::getFields() should return array<GraphQL\\\\Type\\\\Definition\\\\FieldDefinition> but returns array|float|int.#"
-        - "#Parameter \\#2 \\$inputTypeNode of static method GraphQL\\\\Utils\\\\AST::typeFromAST() expects GraphQL\\\\Language\\\\AST\\\\ListTypeNode|GraphQL\\\\Language\\\\AST\\\\NamedTypeNode|GraphQL\\\\Language\\\\AST\\\\NonNullTypeNode, GraphQL\\\\Language\\\\AST\\\\ListTypeNode|GraphQL\\\\Language\\\\AST\\\\NameNode|GraphQL\\\\Language\\\\AST\\\\NonNullTypeNode given.#"
+        #- "#Parameter \\#2 \\$type of class TheCodingMachine\\\\GraphQLite\\\\Parameters\\\\InputTypeParameter constructor expects GraphQL\\\\Type\\\\Definition\\\\InputType&GraphQL\\\\Type\\\\Definition\\\\Type, GraphQL\\\\Type\\\\Definition\\\\InputType\\|GraphQL\\\\Type\\\\Definition\\\\Type given.#"
+        - "#Parameter .* of class ReflectionMethod constructor expects string, object\\|string given.#"
+        -
+           message: '#Method TheCodingMachine\\GraphQLite\\Types\\Mutable(Interface|Object)Type::getFields\(\) should return array<GraphQL\\Type\\Definition\\FieldDefinition> but returns array\|float\|int#'
+           path: src/Types/MutableTrait.php
+        #- "#Parameter \\#2 \\$inputTypeNode of static method GraphQL\\\\Utils\\\\AST::typeFromAST() expects GraphQL\\\\Language\\\\AST\\\\ListTypeNode\\|GraphQL\\\\Language\\\\AST\\\\NamedTypeNode\\|GraphQL\\\\Language\\\\AST\\\\NonNullTypeNode, GraphQL\\\\Language\\\\AST\\\\ListTypeNode\\|GraphQL\\\\Language\\\\AST\\\\NameNode\\|GraphQL\\\\Language\\\\AST\\\\NonNullTypeNode given.#"
         - "#PHPDoc tag @throws with type Psr\\\\SimpleCache\\\\InvalidArgumentException is not subtype of Throwable#"
         - '#Variable \$context might not be defined.#'
         -
@@ -22,9 +24,14 @@ parameters:
            message: '#Unreachable statement - code above always terminates.#'
            path: src/Http/WebonyxGraphqlMiddleware.php
         -
-           message: '#Property TheCodingMachine\GraphQLite\Annotations\Type::$class \(class-string<object>|null\) does not accept string.#'
+           message: '#Property TheCodingMachine\GraphQLite\Annotations\Type::\$class \(class-string<object>\\|null\) does not accept string.#'
            path: src/Annotations/Type.php
+        -
+           message: '#Method TheCodingMachine\\GraphQLite\\AnnotationReader::getMethodAnnotations\(\) should return array<int, T of object> but returns array<object>.#'
+           path: src/AnnotationReader.php
         - '#Call to an undefined method GraphQL\\Error\\ClientAware::getMessage()#'
+        # Needed because of a bug in PHP-CS
+        - '#PHPDoc tag @param for parameter \$args with type mixed is not subtype of native type array<int, mixed>.#'
         #-
         #  message: '#If condition is always true#'
         #  path: src/Middlewares/SecurityFieldMiddleware.php

src/AggregateControllerQueryProvider.php

@@ -24,15 +24,15 @@
  */
 class AggregateControllerQueryProvider implements QueryProviderInterface
 {
-    /** @var array|string[] */
+    /** @var iterable<string> */
     private $controllers;
     /** @var ContainerInterface */
     private $controllersContainer;
     /** @var FieldsBuilder */
     private $fieldsBuilder;
 
     /**
-     * @param string[]           $controllers          A list of controllers name in the container.
+     * @param iterable<string>   $controllers          A list of controllers name in the container.
      * @param ContainerInterface $controllersContainer The container we will fetch controllers from.
      */
     public function __construct(iterable $controllers, FieldsBuilder $fieldsBuilder, ContainerInterface $controllersContainer)
@@ -73,7 +73,7 @@ public function getMutations(): array
     }
 
     /**
-     * @param array<int, array<string, FieldDefinition>> $list
+     * @param array<string, array<string, FieldDefinition>> $list
      *
      * @return array<string, FieldDefinition>
      */

src/AggregateControllerQueryProviderFactory.php

@@ -11,13 +11,13 @@
  */
 class AggregateControllerQueryProviderFactory implements QueryProviderFactoryInterface
 {
-    /** @var array|string[] */
+    /** @var iterable<string> */
     private $controllers;
     /** @var ContainerInterface */
     private $controllersContainer;
 
     /**
-     * @param string[]           $controllers          A list of controllers name in the container.
+     * @param iterable<string>   $controllers          A list of controllers name in the container.
      * @param ContainerInterface $controllersContainer The container we will fetch controllers from.
      */
     public function __construct(iterable $controllers, ContainerInterface $controllersContainer)

src/Annotations/Security.php

@@ -25,7 +25,7 @@ class Security implements MiddlewareAnnotationInterface
     private $failWith;
     /** @var bool */
     private $failWithIsSet = false;
-    /** @var int|null */
+    /** @var int */
     private $statusCode;
     /** @var string */
     private $message;

src/InputTypeUtils.php

@@ -40,10 +40,13 @@ public function __construct(
     /**
      * Returns an array with 2 elements: [ $inputName, $className ]
      *
-     * @return string[]
+     * @return array{0: string, 1:class-string<object>}
      */
     public function getInputTypeNameAndClassName(ReflectionMethod $method): array
     {
+        /**
+         * @var class-string<object>
+         */
         $fqsen   = ltrim((string) $this->validateReturnType($method), '\\');
         $factory = $this->annotationReader->getFactoryAnnotation($method);
         if ($factory === null) {

src/Mappers/AbstractTypeMapper.php

@@ -241,6 +241,8 @@ private function buildMapClassToExtendTypeArray(): GlobExtendTypeMapperCache
 
     /**
      * Returns true if this type mapper can map the $className FQCN to a GraphQL type.
+     *
+     * @param class-string<object> $className
      */
     public function canMapClassToType(string $className): bool
     {
@@ -250,7 +252,7 @@ public function canMapClassToType(string $className): bool
     /**
      * Maps a PHP fully qualified class name to a GraphQL type.
      *
-     * @param string $className The exact class name to look for (this function does not look into parent classes).
+     * @param class-string<object> $className The exact class name to look for (this function does not look into parent classes).
      * @param OutputType|null $subType An optional sub-type if the main class is an iterator that needs to be typed.
      *
      * @throws CannotMapTypeExceptionInterface
@@ -287,9 +289,11 @@ public function canMapClassToInputType(string $className): bool
     /**
      * Maps a PHP fully qualified class name to a GraphQL input type.
      *
+     * @param class-string<object> $className
+     *
      * @return ResolvableMutableInputInterface&InputObjectType
      *
-     * @throws CannotMapTypeExceptionInterface
+     * @throws CannotMapTypeException
      */
     public function mapClassToInputType(string $className): ResolvableMutableInputInterface
     {
@@ -359,6 +363,7 @@ public function canExtendTypeForClass(string $className, MutableInterface $type)
     /**
      * Extends the existing GraphQL type that is mapped to $className.
      *
+     * @param class-string<object> $className
      * @param MutableInterface&(MutableObjectType|MutableInterfaceType) $type
      *
      * @throws CannotMapTypeExceptionInterface

src/Mappers/CannotMapTypeException.php

@@ -26,11 +26,17 @@ class CannotMapTypeException extends Exception implements CannotMapTypeException
 {
     use CannotMapTypeTrait;
 
+    /**
+     * @param class-string<object> $className
+     */
     public static function createForType(string $className): self
     {
         return new self('cannot map class "' . $className . '" to a known GraphQL type. Check your TypeMapper configuration.');
     }
 
+    /**
+     * @param class-string<object> $className
+     */
     public static function createForInputType(string $className): self
     {
         return new self('cannot map class "' . $className . '" to a known GraphQL input type. Check your TypeMapper configuration.');
@@ -46,6 +52,9 @@ public static function createForParseError(Error $error): self
         return new self($error->getMessage(), $error->getCode(), $error);
     }
 
+    /**
+     * @param class-string<object> $className
+     */
     public static function createForMissingIteratorValue(string $className, self $e): self
     {
         $message = sprintf(
@@ -87,6 +96,7 @@ public static function mustBeInputType(string $subTypeName): self
     }
 
     /**
+     * @param class-string<object> $className
      * @param NamedType&(ObjectType|InterfaceType) $type
      *
      * @return CannotMapTypeException
@@ -111,6 +121,9 @@ public static function createForDecorateName(string $name, InputObjectType $type
         return new self('cannot decorate GraphQL input type "' . $type->name . '" with type "' . $name . '". Check your TypeMapper configuration.');
     }
 
+    /**
+     * @param class-string<object> $className
+     */
     public static function extendTypeWithBadTargetedClass(string $className, ExtendType $extendType): self
     {
         return new self('For ' . self::extendTypeToString($extendType) . ' annotation declared in class "' . $className . '", the pointed at GraphQL type cannot be extended. You can only target types extending the MutableObjectType (like types created with the @Type annotation).');

src/Mappers/CompositeTypeMapper.php

@@ -35,6 +35,8 @@ public function addTypeMapper(TypeMapperInterface $typeMapper): void
 
     /**
      * Returns true if this type mapper can map the $className FQCN to a GraphQL type.
+     *
+     * @param class-string<object> $className
      */
     public function canMapClassToType(string $className): bool
     {
@@ -50,6 +52,7 @@ public function canMapClassToType(string $className): bool
     /**
      * Maps a PHP fully qualified class name to a GraphQL type.
      *
+     * @param class-string<object> $className
      * @param (OutputType&Type)|null $subType
      *
      * @throws CannotMapTypeExceptionInterface
@@ -87,6 +90,8 @@ public function getSupportedClasses(): array
 
     /**
      * Returns true if this type mapper can map the $className FQCN to a GraphQL input type.
+     *
+     * @param class-string<object> $className
      */
     public function canMapClassToInputType(string $className): bool
     {
@@ -102,6 +107,8 @@ public function canMapClassToInputType(string $className): bool
     /**
      * Maps a PHP fully qualified class name to a GraphQL input type.
      *
+     * @param class-string<object> $className
+     *
      * @return ResolvableMutableInputInterface&InputObjectType
      *
      * @throws CannotMapTypeExceptionInterface
@@ -152,6 +159,7 @@ public function canMapNameToType(string $typeName): bool
     /**
      * Returns true if this type mapper can extend an existing type for the $className FQCN
      *
+     * @param class-string<object> $className
      * @param MutableInterface&(MutableObjectType|MutableInterfaceType) $type
      */
     public function canExtendTypeForClass(string $className, MutableInterface $type): bool
@@ -168,6 +176,7 @@ public function canExtendTypeForClass(string $className, MutableInterface $type)
     /**
      * Extends the existing GraphQL type that is mapped to $className.
      *
+     * @param class-string<object> $className
      * @param MutableInterface&(MutableObjectType|MutableInterfaceType) $type
      *
      * @throws CannotMapTypeExceptionInterface

src/Mappers/DuplicateMappingException.php

@@ -15,6 +15,11 @@ public static function createForType(string $sourceClass, string $type1, string
         throw new self(sprintf("The class '%s' should be mapped by only one GraphQL type class. Two classes are pointing via the @Type annotation to this class: '%s' and '%s'", $sourceClass, $type1, $type2));
     }
 
+    /**
+     * @param class-string<object> $sourceClass
+     * @param class-string<object> $className1
+     * @param class-string<object> $className2
+     */
     public static function createForFactory(string $sourceClass, string $className1, string $method1, string $className2, string $method2): self
     {
         throw new self(sprintf("The class '%s' should be mapped to only one GraphQL Input type. Two methods are pointing via the @Factory annotation to this class: '%s::%s' and '%s::%s'", $sourceClass, $className1, $method1, $className2, $method2));

src/Mappers/GlobAnnotationsCache.php

@@ -11,7 +11,7 @@
  */
 final class GlobAnnotationsCache
 {
-    /** @var string|null */
+    /** @var class-string<object>|null */
     private $typeClassName;
 
     /** @var string|null */
@@ -20,19 +20,25 @@ final class GlobAnnotationsCache
     /** @var bool */
     private $default;
 
-    /** @var array<string, array<int, string|bool>> An array mapping a factory method name to an input name / class name / default flag / declaring class */
+    /** @var array<string, array{0: string, 1:class-string<object>|null, 2:bool, 3:class-string<object>}> An array mapping a factory method name to an input name / class name / default flag / declaring class */
     private $factories = [];
 
-    /** @var array<string, array<int, string>> An array mapping a decorator method name to an input name / declaring class */
+    /** @var array<string, array{0: string, 1:class-string<object>}> An array mapping a decorator method name to an input name / declaring class */
     private $decorators = [];
 
+    /**
+     * @param class-string<object> $className
+     */
     public function setType(string $className, string $typeName, bool $isDefault): void
     {
         $this->typeClassName = $className;
         $this->typeName = $typeName;
         $this->default = $isDefault;
     }
 
+    /**
+     * @return class-string<object>|null
+     */
     public function getTypeClassName(): ?string
     {
         return $this->typeClassName;
@@ -48,26 +54,33 @@ public function isDefault(): bool
         return $this->default;
     }
 
+    /**
+     * @param class-string<object>|null $className
+     * @param class-string<object> $declaringClass
+     */
     public function registerFactory(string $methodName, string $inputName, ?string $className, bool $isDefault, string $declaringClass): void
     {
         $this->factories[$methodName] = [$inputName, $className, $isDefault, $declaringClass];
     }
 
+    /**
+     * @param class-string<object> $declaringClass
+     */
     public function registerDecorator(string $methodName, string $inputName, string $declaringClass): void
     {
         $this->decorators[$methodName] = [$inputName, $declaringClass];
     }
 
     /**
-     * @return array<string, array<int, string|bool>>
+     * @return array<string, array{0: string, 1:class-string<object>|null, 2:bool, 3:class-string<object>}>
      */
     public function getFactories(): array
     {
         return $this->factories;
     }
 
     /**
-     * @return array<string, array<int, string>>
+     * @return array<string, array{0: string, 1:class-string<object>}>
      */
     public function getDecorators(): array
     {