chore: more const, better typing (PHP-CS-Fixer#8320)

dev-tools/phpstan/baseline.php

@@ -325,12 +325,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Console/Output/ErrorOutput.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset string might not exist on array\\<string, class\\-string\\<PhpCsFixer\\\\Console\\\\Output\\\\Progress\\\\ProgressOutputInterface\\>\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Console/Output/Progress/ProgressOutputFactory.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method PhpCsFixer\\\\Console\\\\Report\\\\FixReport\\\\CheckstyleReporter\\:\\:generate\\(\\) should return string but returns string\\|false\\.$#',
 	'identifier' => 'return.type',
@@ -739,24 +733,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Fixer/AbstractPhpUnitFixer.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset 0 might not exist on array\\<int, string\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/Alias/EregToPregFixer.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Offset 1 might not exist on array\\<int, string\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/Alias/EregToPregFixer.php',
-];
-$ignoreErrors[] = [
-	'message' => '#^Offset 2 might not exist on array\\<int, string\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/Alias/EregToPregFixer.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Offset 2 might not exist on non\\-empty\\-list\\<int\\<0, max\\>\\>\\.$#',
 	'identifier' => 'offsetAccess.notFound',
@@ -769,12 +745,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Fixer/Alias/PowToExponentiationFixer.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset string might not exist on array\\<string, array\\<int, int\\>\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/Alias/RandomApiMigrationFixer.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Offset 0 might not exist on list\\<int\\>\\.$#',
 	'identifier' => 'offsetAccess.notFound',
@@ -829,12 +799,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Fixer/Casing/MagicConstantCasingFixer.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset string might not exist on array\\<string, string\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/Casing/MagicMethodCasingFixer.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Cannot access offset \'elements\' on array\\{index\\: int, open\\: int\\|null, close\\: int\\<0, max\\>, elements\\: list\\<array\\{token\\: PhpCsFixer\\\\Tokenizer\\\\Token, type\\: \'case\'\\|\'const\'\\|\'method\'\\|\'property\'\\|\'trait_import\', index\\: int, start\\: int, end\\: int\\}\\>\\}\\|false\\.$#',
 	'identifier' => 'offsetAccess.nonOffsetAccessible',
@@ -1591,12 +1555,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Fixer/Operator/BinaryOperatorSpacesFixer.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset string might not exist on array\\<string, array\\{int, string\\}\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/Operator/LongToShorthandOperatorFixer.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method PhpCsFixer\\\\Fixer\\\\Operator\\\\TernaryToElvisOperatorFixer\\:\\:getAfterOperator\\(\\) should return array\\{start\\: int, end\\: int\\} but returns array\\{start\\: int\\|null, end\\?\\: int\\|null\\}\\.$#',
 	'identifier' => 'return.type',
@@ -1675,12 +1633,6 @@
 	'count' => 2,
 	'path' => __DIR__ . '/../../src/Fixer/PhpUnit/PhpUnitDedicateAssertFixer.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset string might not exist on array\\<string, array\\{positive\\: string, negative\\: string\\|false, argument_count\\?\\: int, swap_arguments\\?\\: true\\}\\|true\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/PhpUnit/PhpUnitDedicateAssertFixer.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Offset \'expectExceptionMessageRegExp\' might not exist on array\\<string, string\\>\\.$#',
 	'identifier' => 'offsetAccess.notFound',
@@ -1747,12 +1699,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Fixer/PhpUnit/PhpUnitNoExpectationAnnotationFixer.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset \'assertAttributeEquals\'\\|\'assertAttributeNotEquals\'\\|\'assertEquals\'\\|\'assertNotEquals\' might not exist on array\\<string, string\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/PhpUnit/PhpUnitStrictFixer.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Method PhpCsFixer\\\\Fixer\\\\PhpUnit\\\\PhpUnitTestAnnotationFixer\\:\\:updateLines\\(\\) should return list\\<PhpCsFixer\\\\DocBlock\\\\Line\\> but returns array\\<int\\<0, max\\>, PhpCsFixer\\\\DocBlock\\\\Line\\>\\.$#',
 	'identifier' => 'return.type',
@@ -2083,12 +2029,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../src/Fixer/Whitespace/ArrayIndentationFixer.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset \'break\'\\|\'case\'\\|\'continue\'\\|\'declare\'\\|\'default\'\\|\'do\'\\|\'exit\'\\|\'for\'\\|\'foreach\'\\|\'goto\'\\|\'if\'\\|\'include\'\\|\'include_once\'\\|\'phpdoc\'\\|\'require\'\\|\'require_once\'\\|\'return\'\\|\'switch\'\\|\'throw\'\\|\'try\'\\|\'while\'\\|\'yield\'\\|\'yield_from\' might not exist on array\\<string, int\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../src/Fixer/Whitespace/BlankLineBeforeStatementFixer.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Offset int\\<0, max\\> might not exist on list\\<int\\>\\.$#',
 	'identifier' => 'offsetAccess.notFound',
@@ -2917,12 +2857,6 @@
 	'count' => 1,
 	'path' => __DIR__ . '/../../tests/Fixer/FunctionNotation/NullableTypeDeclarationForDefaultNullValueFixerTest.php',
 ];
-$ignoreErrors[] = [
-	'message' => '#^Offset \'operators\' might not exist on array\\<string, mixed\\>\\.$#',
-	'identifier' => 'offsetAccess.notFound',
-	'count' => 1,
-	'path' => __DIR__ . '/../../tests/Fixer/Operator/LongToShorthandOperatorFixerTest.php',
-];
 $ignoreErrors[] = [
 	'message' => '#^Only booleans are allowed in a negated boolean, string\\|false given\\.$#',
 	'identifier' => 'booleanNot.exprNotBoolean',

src/Console/ConfigurationResolver.php

@@ -166,7 +166,7 @@ final class ConfigurationResolver
     private ?array $path = null;
 
     /**
-     * @var null|string
+     * @var null|ProgressOutputType::*
      */
     private $progress;
 
@@ -409,6 +409,8 @@ static function (string $rawPath) use ($cwd, $filesystem): string {
     }
 
     /**
+     * @return ProgressOutputType::*
+     *
      * @throws InvalidConfigurationException
      */
     public function getProgressType(): string

src/Console/Output/Progress/ProgressOutputFactory.php

@@ -22,14 +22,17 @@
 final class ProgressOutputFactory
 {
     /**
-     * @var array<string, class-string<ProgressOutputInterface>>
+     * @var array<ProgressOutputType::*, class-string<ProgressOutputInterface>>
      */
-    private static array $outputTypeMap = [
+    private const OUTPUT_TYPE_MAP = [
         ProgressOutputType::NONE => NullOutput::class,
         ProgressOutputType::DOTS => DotsOutput::class,
         ProgressOutputType::BAR => PercentageBarOutput::class,
     ];
 
+    /**
+     * @param ProgressOutputType::* $outputType
+     */
     public function create(string $outputType, OutputContext $context): ProgressOutputInterface
     {
         if (null === $context->getOutput()) {
@@ -45,7 +48,10 @@ public function create(string $outputType, OutputContext $context): ProgressOutp
             );
         }
 
-        return new self::$outputTypeMap[$outputType]($context);
+        $outputClass = self::OUTPUT_TYPE_MAP[$outputType];
+
+        // @phpstan-ignore-next-line new.noConstructor
+        return new $outputClass($context);
     }
 
     private function isBuiltInType(string $outputType): bool

src/DocBlock/Annotation.php

@@ -31,7 +31,7 @@ final class Annotation
      *
      * @var list<string>
      */
-    private static array $tags = [
+    private const TAGS = [
         'method',
         'param',
         'property',
@@ -127,7 +127,7 @@ public function __toString(): string
      */
     public static function getTagsWithTypes(): array
     {
-        return self::$tags;
+        return self::TAGS;
     }
 
     /**
@@ -291,7 +291,7 @@ public function getContent(): string
 
     public function supportTypes(): bool
     {
-        return \in_array($this->getTag()->getName(), self::$tags, true);
+        return \in_array($this->getTag()->getName(), self::TAGS, true);
     }
 
     /**

src/Fixer/Alias/EregToPregFixer.php

@@ -33,7 +33,7 @@ final class EregToPregFixer extends AbstractFixer
      * @var list<array<int, string>> the list of the ext/ereg function names, their preg equivalent and the preg modifier(s), if any
      *                               all condensed in an array of arrays
      */
-    private static array $functions = [
+    private const FUNCTIONS = [
         ['ereg', 'preg_match', ''],
         ['eregi', 'preg_match', 'i'],
         ['ereg_replace', 'preg_replace', ''],
@@ -82,7 +82,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
         $end = $tokens->count() - 1;
         $functionsAnalyzer = new FunctionsAnalyzer();
 
-        foreach (self::$functions as $map) {
+        foreach (self::FUNCTIONS as $map) {
             // the sequence is the function name, followed by "(" and a quoted string
             $seq = [[T_STRING, $map[0]], '(', [T_CONSTANT_ENCAPSED_STRING]];
             $currIndex = 0;

src/Fixer/Alias/RandomApiMigrationFixer.php

@@ -48,7 +48,7 @@ final class RandomApiMigrationFixer extends AbstractFunctionReferenceFixer imple
     /**
      * @var array<string, array<int, int>>
      */
-    private static array $argumentCounts = [
+    private const ARGUMENT_COUNTS = [
         'getrandmax' => [0],
         'mt_rand' => [1, 2],
         'rand' => [0, 2],
@@ -99,7 +99,9 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
                 [$functionName, $openParenthesis, $closeParenthesis] = $boundaries;
                 $count = $argumentsAnalyzer->countArguments($tokens, $openParenthesis, $closeParenthesis);
 
-                if (!\in_array($count, self::$argumentCounts[$functionIdentity], true)) {
+                \assert(isset(self::ARGUMENT_COUNTS[$functionIdentity])); // for PHPStan
+
+                if (!\in_array($count, self::ARGUMENT_COUNTS[$functionIdentity], true)) {
                     continue 2;
                 }
 
@@ -130,7 +132,7 @@ protected function createConfigurationDefinition(): FixerConfigurationResolverIn
                 ->setAllowedTypes(['array<string, string>'])
                 ->setAllowedValues([static function (array $value): bool {
                     foreach ($value as $functionName => $replacement) {
-                        if (!\array_key_exists($functionName, self::$argumentCounts)) {
+                        if (!\array_key_exists($functionName, self::ARGUMENT_COUNTS)) {
                             throw new InvalidOptionsException(\sprintf(
                                 'Function "%s" is not handled by the fixer.',
                                 $functionName

src/Fixer/Basic/NonPrintableCharacterFixer.php

@@ -46,15 +46,10 @@ final class NonPrintableCharacterFixer extends AbstractFixer implements Configur
     /** @use ConfigurableFixerTrait<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration> */
     use ConfigurableFixerTrait;
 
-    /**
-     * @var array<string, array{string, string}>
-     */
-    private array $symbolsReplace;
-
     /**
      * @var list<int>
      */
-    private static array $tokens = [
+    private const TOKENS = [
         T_STRING_VARNAME,
         T_INLINE_HTML,
         T_VARIABLE,
@@ -64,6 +59,11 @@ final class NonPrintableCharacterFixer extends AbstractFixer implements Configur
         T_DOC_COMMENT,
     ];
 
+    /**
+     * @var array<string, array{string, string}>
+     */
+    private array $symbolsReplace;
+
     public function __construct()
     {
         parent::__construct();
@@ -102,7 +102,7 @@ public function isRisky(): bool
 
     public function isCandidate(Tokens $tokens): bool
     {
-        return $tokens->isAnyTokenKindsFound(self::$tokens);
+        return $tokens->isAnyTokenKindsFound(self::TOKENS);
     }
 
     protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
@@ -171,7 +171,7 @@ protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
                 continue;
             }
 
-            if ($token->isGivenKind(self::$tokens)) {
+            if ($token->isGivenKind(self::TOKENS)) {
                 $newContent = strtr($content, $replacements);
 
                 // variable name cannot contain space

src/Fixer/Casing/LowercaseKeywordsFixer.php

@@ -28,11 +28,6 @@
  */
 final class LowercaseKeywordsFixer extends AbstractFixer
 {
-    /**
-     * @var list<int>
-     */
-    private static array $excludedTokens = [T_HALT_COMPILER];
-
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(
@@ -64,7 +59,7 @@ public function isCandidate(Tokens $tokens): bool
     protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
     {
         foreach ($tokens as $index => $token) {
-            if ($token->isKeyword() && !$token->isGivenKind(self::$excludedTokens)) {
+            if ($token->isKeyword() && !$token->isGivenKind([T_HALT_COMPILER])) {
                 $tokens[$index] = new Token([$token->getId(), strtolower($token->getContent())]);
             }
         }

src/Fixer/Casing/MagicMethodCasingFixer.php

@@ -26,7 +26,7 @@ final class MagicMethodCasingFixer extends AbstractFixer
     /**
      * @var array<string, string>
      */
-    private static array $magicNames = [
+    private const MAGIC_NAMES = [
         '__call' => '__call',
         '__callstatic' => '__callStatic',
         '__clone' => '__clone',
@@ -177,17 +177,22 @@ private function isStaticMethodCall(Tokens $tokens, int $index): bool
         return $tokens[$tokens->getNextMeaningfulToken($index)]->equals('(');
     }
 
+    /**
+     * @phpstan-assert-if-true key-of<self::MAGIC_NAMES> $name
+     */
     private function isMagicMethodName(string $name): bool
     {
-        return isset(self::$magicNames[$name]);
+        return isset(self::MAGIC_NAMES[$name]);
     }
 
     /**
-     * @param string $name name of a magic method
+     * @param key-of<self::MAGIC_NAMES> $name name of a magic method
+     *
+     * @return value-of<self::MAGIC_NAMES>
      */
     private function getMagicMethodNameInCorrectCasing(string $name): string
     {
-        return self::$magicNames[$name];
+        return self::MAGIC_NAMES[$name];
     }
 
     private function setTokenToCorrectCasing(Tokens $tokens, int $index, string $nameInCorrectCasing): void