chore: add missing key types in PHPDoc types (#7779)

PHP-CS-Fixer · Jan 25, 2024 · f868ed7 · f868ed7
1 parent dcaee18
commit f868ed7
Show file tree

Hide file tree

Showing 17 changed files with 24 additions and 24 deletions.
diff --git a/dev-tools/phpstan/baseline.php b/dev-tools/phpstan/baseline.php
@@ -62,7 +62,7 @@
 	'path' => __DIR__ . '/../../src/Doctrine/Annotation/Tokens.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Parameter \\#1 \\$array \\(array\\<PhpCsFixer\\\\Doctrine\\\\Annotation\\\\Token\\>\\) of method PhpCsFixer\\\\Doctrine\\\\Annotation\\\\Tokens\\:\\:fromArray\\(\\) should be contravariant with parameter \\$array \\(array\\<int, mixed\\>\\) of method SplFixedArray\\<PhpCsFixer\\\\Doctrine\\\\Annotation\\\\Token\\>\\:\\:fromArray\\(\\)$#',
+	'message' => '#^Parameter \\#1 \\$array \\(array\\<int, PhpCsFixer\\\\Doctrine\\\\Annotation\\\\Token\\>\\) of method PhpCsFixer\\\\Doctrine\\\\Annotation\\\\Tokens\\:\\:fromArray\\(\\) should be contravariant with parameter \\$array \\(array\\<int, mixed\\>\\) of method SplFixedArray\\<PhpCsFixer\\\\Doctrine\\\\Annotation\\\\Token\\>\\:\\:fromArray\\(\\)$#',
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Doctrine/Annotation/Tokens.php',
 ];

diff --git a/src/Console/ConfigurationResolver.php b/src/Console/ConfigurationResolver.php
@@ -630,7 +630,7 @@ private function iterableToTraversable(iterable $iterable): \Traversable
     }
 
     /**
-     * @return array<mixed>
+     * @return array<string, mixed>
      */
     private function parseRules(): array
     {
@@ -673,7 +673,7 @@ private function parseRules(): array
     }
 
     /**
-     * @param array<mixed> $rules
+     * @param array<string, mixed> $rules
      *
      * @throws InvalidConfigurationException
      */

diff --git a/src/Doctrine/Annotation/Tokens.php b/src/Doctrine/Annotation/Tokens.php
@@ -138,8 +138,8 @@ public static function createFromDocComment(PhpToken $input, array $ignoredTags
     /**
      * Create token collection from array.
      *
-     * @param Token[] $array       the array to import
-     * @param ?bool   $saveIndices save the numeric indices used in the original array, default is yes
+     * @param array<int, Token> $array       the array to import
+     * @param ?bool             $saveIndices save the numeric indices used in the original array, default is yes
      */
     public static function fromArray($array, $saveIndices = null): self
     {

diff --git a/src/Fixer/FunctionNotation/NullableTypeDeclarationForDefaultNullValueFixer.php b/src/Fixer/FunctionNotation/NullableTypeDeclarationForDefaultNullValueFixer.php
@@ -114,7 +114,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
     }
 
     /**
-     * @param ArgumentAnalysis[] $arguments
+     * @param array<string, ArgumentAnalysis> $arguments
      */
     private function fixFunctionParameters(Tokens $tokens, array $arguments): void
     {

diff --git a/src/Fixer/PhpUnit/PhpUnitNamespacedFixer.php b/src/Fixer/PhpUnit/PhpUnitNamespacedFixer.php
@@ -45,7 +45,7 @@ final class PhpUnitNamespacedFixer extends AbstractFixer implements Configurable
      *    space class and need a dedicated translation table. This trans-
      *    lation table is defined in @see configure.
      *
-     * @var array|string[] Class Mappings
+     * @var array<string, string> Class Mappings
      */
     private $classMap;
 

diff --git a/tests/Fixer/Alias/NoAliasFunctionsFixerTest.php b/tests/Fixer/Alias/NoAliasFunctionsFixerTest.php
@@ -247,7 +247,7 @@ private static function provideAllCases(): iterable
     {
         $reflectionConstant = new \ReflectionClassConstant(NoAliasFunctionsFixer::class, 'SETS');
 
-        /** @var array<string, string[]> $allAliases */
+        /** @var array<string, array<string, string>> $allAliases */
         $allAliases = $reflectionConstant->getValue();
 
         $sets = $allAliases;

diff --git a/tests/Fixer/Alias/NoMixedEchoPrintFixerTest.php b/tests/Fixer/Alias/NoMixedEchoPrintFixerTest.php
@@ -337,7 +337,7 @@ public function testConfigure(): void
     }
 
     /**
-     * @param array<mixed> $wrongConfig
+     * @param array<string, mixed> $wrongConfig
      *
      * @dataProvider provideInvalidConfigurationCases
      */

diff --git a/tests/Fixer/ClassNotation/ClassDefinitionFixerTest.php b/tests/Fixer/ClassNotation/ClassDefinitionFixerTest.php
@@ -46,7 +46,7 @@ public function testConfigure(): void
     }
 
     /**
-     * @param array<mixed> $config
+     * @param array<string, mixed> $config
      *
      * @dataProvider provideInvalidConfigurationCases
      */
@@ -59,7 +59,7 @@ public function testInvalidConfiguration(array $config, string $exceptionExpress
     }
 
     /**
-     * @return iterable<array{array<mixed>, string}>
+     * @return iterable<array{array<string, mixed>, string}>
      */
     public static function provideInvalidConfigurationCases(): iterable
     {

diff --git a/tests/Fixer/ClassNotation/FinalInternalClassFixerTest.php b/tests/Fixer/ClassNotation/FinalInternalClassFixerTest.php
@@ -345,7 +345,7 @@ class Foo {}
     /**
      * @group legacy
      *
-     * @param array<mixed> $config
+     * @param array<string, mixed> $config
      *
      * @dataProvider provideInvalidConfigurationCases
      */
@@ -361,7 +361,7 @@ public function testInvalidConfiguration(array $config, string $exceptionExpress
     }
 
     /**
-     * @return iterable<array{array<mixed>, string, 2?: string}>
+     * @return iterable<array{array<string, mixed>, string, 2?: string}>
      */
     public static function provideInvalidConfigurationCases(): iterable
     {

diff --git a/tests/Fixer/ControlStructure/YodaStyleFixerTest.php b/tests/Fixer/ControlStructure/YodaStyleFixerTest.php
@@ -936,7 +936,7 @@ public function testComplexConfiguration(): void
     }
 
     /**
-     * @param array<mixed> $config
+     * @param array<string, mixed> $config
      *
      * @dataProvider provideInvalidConfigCases
      */

diff --git a/tests/Fixer/FunctionNotation/NativeFunctionInvocationFixerTest.php b/tests/Fixer/FunctionNotation/NativeFunctionInvocationFixerTest.php
@@ -604,7 +604,7 @@ public function testFixPre80(string $expected, ?string $input = null, array $con
     }
 
     /**
-     * @return iterable<array{string, 1?: string, 2?: array<mixed>}>
+     * @return iterable<array{string, 1?: string, 2?: array<string, mixed>}>
      */
     public static function provideFixPre80Cases(): iterable
     {

diff --git a/tests/Fixer/LanguageConstruct/DeclareEqualNormalizeFixerTest.php b/tests/Fixer/LanguageConstruct/DeclareEqualNormalizeFixerTest.php
@@ -110,7 +110,7 @@ public static function provideFixCases(): iterable
     }
 
     /**
-     * @param array<mixed> $config
+     * @param array<string, mixed> $config
      *
      * @dataProvider provideInvalidConfigurationCases
      */

diff --git a/tests/Fixer/LanguageConstruct/FunctionToConstantFixerTest.php b/tests/Fixer/LanguageConstruct/FunctionToConstantFixerTest.php
@@ -271,7 +271,7 @@ class Foo{ public function Bar(){ echo $reflection = new \ReflectionClass(get_cl
     }
 
     /**
-     * @param array<mixed> $config
+     * @param array<string, mixed> $config
      *
      * @dataProvider provideInvalidConfigurationKeysCases
      */

diff --git a/tests/Fixer/Phpdoc/PhpdocReturnSelfReferenceFixerTest.php b/tests/Fixer/Phpdoc/PhpdocReturnSelfReferenceFixerTest.php
@@ -162,7 +162,7 @@ public static function provideGeneratedFixCases(): iterable
     }
 
     /**
-     * @param array<mixed> $configuration
+     * @param array<string, mixed> $configuration
      *
      * @dataProvider provideInvalidConfigurationCases
      */

diff --git a/tests/Fixer/Whitespace/NoSpacesAroundOffsetFixerTest.php b/tests/Fixer/Whitespace/NoSpacesAroundOffsetFixerTest.php
@@ -293,7 +293,7 @@ public function testFixWithConfiguration(string $expected, string $input, array
     }
 
     /**
-     * @return iterable<array{string, string, array<mixed>}>
+     * @return iterable<array{string, string, array{positions: array<string>}}>
      */
     public static function provideFixWithConfigurationCases(): iterable
     {
@@ -371,7 +371,7 @@ public function testFix80(string $expected, ?string $input, array $configuration
     }
 
     /**
-     * @return iterable<array{string, string, array<mixed>}>
+     * @return iterable<array{string, string, array{positions: array<string>}}>
      */
     public static function provideFix80Cases(): iterable
     {

diff --git a/tests/Test/AbstractIntegrationCaseFactory.php b/tests/Test/AbstractIntegrationCaseFactory.php
@@ -225,9 +225,9 @@ private function determineCode(SplFileInfo $file, ?string $code, string $suffix)
     }
 
     /**
-     * @param null|array<mixed> $template
+     * @param null|array<string, mixed> $template
      *
-     * @return array<mixed>
+     * @return array<string, mixed>
      */
     private function parseJson(?string $encoded, array $template = null): array
     {

diff --git a/tests/Tokenizer/Analyzer/FunctionsAnalyzerTest.php b/tests/Tokenizer/Analyzer/FunctionsAnalyzerTest.php
@@ -400,7 +400,7 @@ public function testFunctionArgumentInfo(string $code, int $methodIndex, array $
     }
 
     /**
-     * @return iterable<array{string, int, array<ArgumentAnalysis>}>
+     * @return iterable<array{string, int, array<string, ArgumentAnalysis>}>
      */
     public static function provideFunctionArgumentInfoCases(): iterable
     {
@@ -593,7 +593,7 @@ public function testFunctionArgumentInfoPre80(string $code, int $methodIndex, ar
     }
 
     /**
-     * @return iterable<array{string, int, array<ArgumentAnalysis>}>
+     * @return iterable<array{string, int, array<string, ArgumentAnalysis>}>
      */
     public static function provideFunctionArgumentInfoPre80Cases(): iterable
     {