PHPCSStandards · jrfnl · Mar 23, 2025 · Mar 18, 2025
diff --git a/autoload.php b/autoload.php
@@ -26,7 +26,8 @@ class Autoload
         /**
          * The composer autoloader.
          *
-         * @var \Composer\Autoload\ClassLoader
+         * @var \Composer\Autoload\ClassLoader|false|null The autoloader object or FALSE if no Composer autoloader could
+         *                                                be found. NULL when this hasn't been determined yet.
          */
         private static $composerAutoloader = null;
 

diff --git a/src/Files/File.php b/src/Files/File.php
@@ -656,13 +656,13 @@ public function cleanUp()
     /**
      * Records an error against a specific token in the file.
      *
-     * @param string  $error    The error message.
-     * @param int     $stackPtr The stack position where the error occurred.
-     * @param string  $code     A violation code unique to the sniff message.
-     * @param array   $data     Replacements for the error message.
-     * @param int     $severity The severity level for this error. A value of 0
-     *                          will be converted into the default severity level.
-     * @param boolean $fixable  Can the error be fixed by the sniff?
+     * @param string   $error    The error message.
+     * @param int|null $stackPtr The stack position where the error occurred.
+     * @param string   $code     A violation code unique to the sniff message.
+     * @param array    $data     Replacements for the error message.
+     * @param int      $severity The severity level for this error. A value of 0
+     *                           will be converted into the default severity level.
+     * @param boolean  $fixable  Can the error be fixed by the sniff?
      *
      * @return boolean
      */
@@ -690,13 +690,13 @@ public function addError(
     /**
      * Records a warning against a specific token in the file.
      *
-     * @param string  $warning  The error message.
-     * @param int     $stackPtr The stack position where the error occurred.
-     * @param string  $code     A violation code unique to the sniff message.
-     * @param array   $data     Replacements for the warning message.
-     * @param int     $severity The severity level for this warning. A value of 0
-     *                          will be converted into the default severity level.
-     * @param boolean $fixable  Can the warning be fixed by the sniff?
+     * @param string   $warning  The error message.
+     * @param int|null $stackPtr The stack position where the error occurred.
+     * @param string   $code     A violation code unique to the sniff message.
+     * @param array    $data     Replacements for the warning message.
+     * @param int      $severity The severity level for this warning. A value of 0
+     *                           will be converted into the default severity level.
+     * @param boolean  $fixable  Can the warning be fixed by the sniff?
      *
      * @return boolean
      */

diff --git a/src/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php b/src/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php
@@ -43,7 +43,7 @@ public function register()
      * @param int                         $stackPtr  The position of the current token
      *                                               in the stack passed in $tokens.
      *
-     * @return void
+     * @return int
      */
     public function process(File $phpcsFile, $stackPtr)
     {

diff --git a/src/Standards/Generic/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php b/src/Standards/Generic/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php
@@ -51,7 +51,8 @@ public function register()
      * @param int                         $stackPtr  The position of the current token in
      *                                               the stack passed in $tokens.
      *
-     * @return void
+     * @return int|void Integer stack pointer to skip forward or void to continue
+     *                  normal file processing.
      */
     public function process(File $phpcsFile, $stackPtr)
     {

diff --git a/src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.php b/src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.php
@@ -43,7 +43,7 @@ public function setCliValues($testFile, $config)
      *
      * @param string $testFile The name of the file being tested.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getErrorList($testFile='')
     {
@@ -115,7 +115,7 @@ public function getErrorList($testFile='')
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getWarningList()
     {

diff --git a/src/Standards/Generic/Tests/Files/OneTraitPerFileUnitTest.php b/src/Standards/Generic/Tests/Files/OneTraitPerFileUnitTest.php
@@ -26,7 +26,7 @@ final class OneTraitPerFileUnitTest extends AbstractSniffUnitTest
      * The key of the array should represent the line number and the value
      * should represent the number of errors that should occur on that line.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getErrorList()
     {
@@ -44,7 +44,7 @@ public function getErrorList()
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
      *
-     * @return array(int => int)
+     * @return array<int, int>
      */
     public function getWarningList()
     {

diff --git a/src/Standards/Squiz/Sniffs/Classes/ClassFileNameSniff.php b/src/Standards/Squiz/Sniffs/Classes/ClassFileNameSniff.php
@@ -39,7 +39,8 @@ public function register()
      * @param int                         $stackPtr  The position of the current token in
      *                                               the stack passed in $tokens.
      *
-     * @return void
+     * @return int|void Integer stack pointer to skip forward or void to continue
+     *                  normal file processing.
      */
     public function process(File $phpcsFile, $stackPtr)
     {

diff --git a/src/Standards/Squiz/Sniffs/Commenting/LongConditionClosingCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/LongConditionClosingCommentSniff.php
@@ -28,7 +28,7 @@ class LongConditionClosingCommentSniff implements Sniff
     /**
      * The openers that we are interested in.
      *
-     * @var integer[]
+     * @var array<int|string>
      */
     private static $openers = [
         T_SWITCH,

diff --git a/src/Standards/Squiz/Sniffs/Operators/ComparisonOperatorUsageSniff.php b/src/Standards/Squiz/Sniffs/Operators/ComparisonOperatorUsageSniff.php
@@ -44,7 +44,7 @@ class ComparisonOperatorUsageSniff implements Sniff
     /**
      * A list of invalid operators with their alternatives.
      *
-     * @var array<string, array<int, string>>
+     * @var array<string, array<int|string, string>>
      */
     private static $invalidOps = [
         'PHP' => [

diff --git a/tests/Core/AbstractMethodUnitTest.php b/tests/Core/AbstractMethodUnitTest.php
@@ -164,9 +164,9 @@ public static function assertTestMarkersAreUnique(File $phpcsFile)
      * Note: the test delimiter comment MUST start with "/* test" to allow this function to
      * distinguish between comments used *in* a test and test delimiters.
      *
-     * @param string           $commentString The delimiter comment to look for.
-     * @param int|string|array $tokenType     The type of token(s) to look for.
-     * @param string           $tokenContent  Optional. The token content for the target token.
+     * @param string                       $commentString The delimiter comment to look for.
+     * @param int|string|array<int|string> $tokenType     The type of token(s) to look for.
+     * @param string                       $tokenContent  Optional. The token content for the target token.
      *
      * @return int
      */
@@ -183,10 +183,10 @@ public function getTargetToken($commentString, $tokenType, $tokenContent=null)
      * Note: the test delimiter comment MUST start with "/* test" to allow this function to
      * distinguish between comments used *in* a test and test delimiters.
      *
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile     The file to find the token in.
-     * @param string                      $commentString The delimiter comment to look for.
-     * @param int|string|array            $tokenType     The type of token(s) to look for.
-     * @param string                      $tokenContent  Optional. The token content for the target token.
+     * @param \PHP_CodeSniffer\Files\File  $phpcsFile     The file to find the token in.
+     * @param string                       $commentString The delimiter comment to look for.
+     * @param int|string|array<int|string> $tokenType     The type of token(s) to look for.
+     * @param string                       $tokenContent  Optional. The token content for the target token.
      *
      * @return int
      *

diff --git a/tests/Core/Config/ExtensionsArgTest.php b/tests/Core/Config/ExtensionsArgTest.php
@@ -44,7 +44,7 @@ public function testValidExtensions($passedValue, $expected)
      *
      * @see self::testValidExtensions()
      *
-     * @return array<int, array<string>>
+     * @return array<string, array<string, string|array<string, string>>>
      */
     public static function dataValidExtensions()
     {

diff --git a/tests/Core/Config/GeneratorArgTest.php b/tests/Core/Config/GeneratorArgTest.php
@@ -44,7 +44,7 @@ public function testValidGenerators($argumentValue, $expectedPropertyValue)
      *
      * @see self::testValidGenerators()
      *
-     * @return array<int, array<string>>
+     * @return array<string, array<string, string>>
      */
     public static function dataValidGeneratorNames()
     {
@@ -131,7 +131,7 @@ public function testInvalidGenerator($generatorName)
      *
      * @see self::testInvalidGenerator()
      *
-     * @return array<int, array<string>>
+     * @return array<array<string>>
      */
     public static function dataInvalidGeneratorNames()
     {

diff --git a/tests/Core/File/FindImplementedInterfaceNamesTest.php b/tests/Core/File/FindImplementedInterfaceNamesTest.php
@@ -71,7 +71,7 @@ public function testFindImplementedInterfaceNames($identifier, $expected)
      *
      * @see testFindImplementedInterfaceNames()
      *
-     * @return array<string, array<string, string|array<string>>>
+     * @return array<string, array<string, string|array<string>|false>>
      */
     public static function dataImplementedInterface()
     {

diff --git a/tests/Core/Filters/AbstractFilterTestCase.php b/tests/Core/Filters/AbstractFilterTestCase.php
@@ -223,10 +223,10 @@ protected static function getFakeFileList()
      * These type of tests should be able to run and pass on both *nix as well as Windows
      * based dev systems. This method is a helper to allow for this.
      *
-     * @param array<string|array> $paths A single or multi-dimensional array containing
-     *                                   file paths.
+     * @param array<string|array<string>> $paths A single or multi-dimensional array containing
+     *                                           file paths.
      *
-     * @return array<string|array>
+     * @return array<string|array<string>>
      */
     protected static function mapPathsToRuntimeOs(array $paths)
     {

diff --git a/tests/Core/Filters/GitStagedTest.php b/tests/Core/Filters/GitStagedTest.php
@@ -240,7 +240,7 @@ public function testExecAlwaysReturnsArray($cmd, $expected)
      *            JRF: I've not managed to find a command which does so, let alone one, which then
      *            doesn't have side-effects of uncatchable output while running the tests.}
      *
-     * @return array<string, array<string, array<string>>>
+     * @return array<string, array<string, string|array<string>>>
      */
     public static function dataExecAlwaysReturnsArray()
     {

diff --git a/tests/Core/Ruleset/DisplayCachedMessagesTest.php b/tests/Core/Ruleset/DisplayCachedMessagesTest.php
@@ -136,7 +136,7 @@ public function testNonBlockingErrorsGenerateOutput($messages, $expected)
      *
      * @see testNonBlockingErrorsGenerateOutput()
      *
-     * @return array<string, array<string, string|array<string>>>
+     * @return array<string, array<string, string|array<string, int>>>
      */
     public static function dataNonBlockingErrorsGenerateOutput()
     {

diff --git a/tests/Core/Ruleset/ProcessRulesetTest.php b/tests/Core/Ruleset/ProcessRulesetTest.php
@@ -243,7 +243,7 @@ public function testRuleExcludeWithoutNameIsIgnored()
     /**
      * Test Helper.
      *
-     * @return \PHP_CodeSniffer\Sniffs\Sniff
+     * @return \PHP_CodeSniffer\Ruleset
      */
     private function getMiscRuleset()
     {

diff --git a/tests/Core/Sniffs/AbstractArraySniffTest.php b/tests/Core/Sniffs/AbstractArraySniffTest.php
@@ -25,7 +25,7 @@ final class AbstractArraySniffTest extends AbstractMethodUnitTest
      * This extends the \PHP_CodeSniffer\Sniffs\AbstractArraySniff class to make the
      * internal workings of the sniff observable.
      *
-     * @var \PHP_CodeSniffer\Sniffs\AbstractArraySniffTestable
+     * @var \PHP_CodeSniffer\Tests\Core\Sniffs\AbstractArraySniffTestable
      */
     protected static $sniff;
 

diff --git a/tests/Core/Tokenizers/AbstractTokenizerTestCase.php b/tests/Core/Tokenizers/AbstractTokenizerTestCase.php
@@ -113,9 +113,9 @@ public function testTestMarkersAreUnique()
      * Note: the test delimiter comment MUST start with "/* test" to allow this function to
      * distinguish between comments used *in* a test and test delimiters.
      *
-     * @param string           $commentString The delimiter comment to look for.
-     * @param int|string|array $tokenType     The type of token(s) to look for.
-     * @param string           $tokenContent  Optional. The token content for the target token.
+     * @param string                       $commentString The delimiter comment to look for.
+     * @param int|string|array<int|string> $tokenType     The type of token(s) to look for.
+     * @param string                       $tokenContent  Optional. The token content for the target token.
      *
      * @return int
      */

diff --git a/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.php b/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.php
@@ -462,16 +462,16 @@ public static function dataSwitchCaseVersusMatch()
      * Helper function to verify that all scope related array indexes for a control structure
      * are set correctly.
      *
-     * @param string $token                The control structure token to check.
-     * @param int    $openerOffset         The expected offset of the scope opener in relation to
-     *                                     the control structure token.
-     * @param int    $closerOffset         The expected offset of the scope closer in relation to
-     *                                     the control structure token.
-     * @param bool   $skipScopeCloserCheck Whether to skip the scope closer check.
-     *                                     This should be set to "true" when testing nested arrow functions,
-     *                                     where the "inner" arrow function shares a scope closer with the
-     *                                     "outer" arrow function, as the 'scope_condition' for the scope closer
-     *                                     of the "inner" arrow function will point to the "outer" arrow function.
+     * @param int  $token                The control structure token to check.
+     * @param int  $openerOffset         The expected offset of the scope opener in relation to
+     *                                   the control structure token.
+     * @param int  $closerOffset         The expected offset of the scope closer in relation to
+     *                                   the control structure token.
+     * @param bool $skipScopeCloserCheck Whether to skip the scope closer check.
+     *                                   This should be set to "true" when testing nested arrow functions,
+     *                                   where the "inner" arrow function shares a scope closer with the
+     *                                   "outer" arrow function, as the 'scope_condition' for the scope closer
+     *                                   of the "inner" arrow function will point to the "outer" arrow function.
      *
      * @return void
      */

diff --git a/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.php b/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.php
@@ -178,7 +178,7 @@ public function testKeywords($testMarker, $expectedTokenType)
      *
      * @see testKeywords()
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
     public static function dataKeywords()
     {

diff --git a/tests/Core/Tokenizers/PHP/DNFTypesParseError1Test.php b/tests/Core/Tokenizers/PHP/DNFTypesParseError1Test.php
@@ -52,7 +52,7 @@ public function testBrokenDNFTypeCantEndOnOpenParenthesis($testMarker)
      *
      * @see testBrokenDNFTypeCantEndOnOpenParenthesis()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string>>
      */
     public static function dataBrokenDNFTypeCantEndOnOpenParenthesis()
     {

diff --git a/tests/Core/Tokenizers/PHP/DNFTypesParseError2Test.php b/tests/Core/Tokenizers/PHP/DNFTypesParseError2Test.php
@@ -61,7 +61,7 @@ public function testBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens($te
      *
      * @see testBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string>>
      */
     public static function dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens()
     {
@@ -120,7 +120,7 @@ public function testBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens($tes
      *
      * @see testBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string>>
      */
     public static function dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens()
     {
@@ -201,7 +201,7 @@ public function testBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched($t
      *
      * @see testBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string>>
      */
     public static function dataBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched()
     {

diff --git a/tests/Core/Tokenizers/PHP/DNFTypesTest.php b/tests/Core/Tokenizers/PHP/DNFTypesTest.php
@@ -98,7 +98,7 @@ public function testNormalParentheses($testMarker, $skipCheckInside=false)
      *
      * @see testNormalParentheses()
      *
-     * @return array<string, array<string, string|int|false>>
+     * @return array<string, array<string, string|bool>>
      */
     public static function dataNormalParentheses()
     {

diff --git a/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.php b/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.php
@@ -134,7 +134,7 @@ public function testKeywords($testMarker, $expectedTokenType)
      *
      * @see testKeywords()
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
     public static function dataKeywords()
     {

diff --git a/tests/Core/Tokenizers/PHP/TypedConstantsTest.php b/tests/Core/Tokenizers/PHP/TypedConstantsTest.php
@@ -271,7 +271,7 @@ public static function dataTypedConstant()
      *
      * @see testTypedConstant()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string, string|array<int|string>>>
      */
     public static function dataNullableTypedConstant()
     {
@@ -386,7 +386,7 @@ public static function dataNullableTypedConstant()
      *
      * @see testTypedConstant()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string, string|array<int|string>>>
      */
     public static function dataUnionTypedConstant()
     {
@@ -475,7 +475,7 @@ public static function dataUnionTypedConstant()
      *
      * @see testTypedConstant()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string, string|array<int|string>>>
      */
     public static function dataIntersectionTypedConstant()
     {
@@ -520,7 +520,7 @@ public static function dataIntersectionTypedConstant()
      *
      * @see testTypedConstant()
      *
-     * @return array<string, array<string, string>>
+     * @return array<string, array<string, string|array<int|string>>>
      */
     public static function dataDNFTypedConstant()
     {

diff --git a/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.php b/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.php
@@ -92,7 +92,7 @@ public function testSwitchScope($testMarker, $expectedTokens, $testOpenerMarker=
      *
      * @see testSwitchScope()
      *
-     * @return array<string, array<string, string|array<string, int|string>>>
+     * @return array<string, array<string, string|array<string, int|string>|null>>
      */
     public static function dataSwitchScope()
     {