4.0 | AbstractSniffTestCase: add parameter types

jrfnl · jrfnl · commit a44f026657b2 · 2025-09-11T22:23:12.000+02:00
Includes updating the sniff test classes overloading these methods.
diff --git a/src/Standards/Generic/Tests/CodeAnalysis/EmptyPHPStatementUnitTest.php b/src/Standards/Generic/Tests/CodeAnalysis/EmptyPHPStatementUnitTest.php
@@ -27,7 +27,7 @@ final class EmptyPHPStatementUnitTest extends AbstractSniffTestCase
      *
      * @return string[]
      */
-    protected function getTestFiles($testFileBase)
+    protected function getTestFiles(string $testFileBase)
     {
         $testFiles = [$testFileBase.'1.inc'];
 
diff --git a/src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.php b/src/Standards/Generic/Tests/Commenting/DocCommentUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Generic\Tests\Commenting;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class DocCommentUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         $config->tabWidth = 4;
 
diff --git a/src/Standards/Generic/Tests/Files/LineEndingsUnitTest.php b/src/Standards/Generic/Tests/Files/LineEndingsUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Generic\Tests\Files;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class LineEndingsUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         $config->tabWidth = 4;
 
diff --git a/src/Standards/Generic/Tests/Files/LineLengthUnitTest.php b/src/Standards/Generic/Tests/Files/LineLengthUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Generic\Tests\Files;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class LineLengthUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         $config->tabWidth = 4;
 
diff --git a/src/Standards/Generic/Tests/Files/LowercasedFilenameUnitTest.php b/src/Standards/Generic/Tests/Files/LowercasedFilenameUnitTest.php
@@ -30,7 +30,7 @@ final class LowercasedFilenameUnitTest extends AbstractSniffTestCase
      *
      * @return string[]
      */
-    protected function getTestFiles($testFileBase)
+    protected function getTestFiles(string $testFileBase)
     {
         $testFileDir = dirname($testFileBase);
         $testFiles   = parent::getTestFiles($testFileBase);
diff --git a/src/Standards/Generic/Tests/Functions/OpeningFunctionBraceKernighanRitchieUnitTest.php b/src/Standards/Generic/Tests/Functions/OpeningFunctionBraceKernighanRitchieUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Generic\Tests\Functions;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class OpeningFunctionBraceKernighanRitchieUnitTest extends AbstractSniffTe
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         if ($testFile === 'OpeningFunctionBraceKernighanRitchieUnitTest.2.inc') {
             $config->tabWidth = 4;
diff --git a/src/Standards/Generic/Tests/PHP/DisallowShortOpenTagUnitTest.php b/src/Standards/Generic/Tests/PHP/DisallowShortOpenTagUnitTest.php
@@ -27,7 +27,7 @@ final class DisallowShortOpenTagUnitTest extends AbstractSniffTestCase
      *
      * @return string[]
      */
-    protected function getTestFiles($testFileBase)
+    protected function getTestFiles(string $testFileBase)
     {
         $testFiles = [$testFileBase.'1.inc'];
 
diff --git a/src/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.php b/src/Standards/Generic/Tests/WhiteSpace/DisallowSpaceIndentUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Generic\Tests\WhiteSpace;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class DisallowSpaceIndentUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         if ($testFile === 'DisallowSpaceIndentUnitTest.2.inc') {
             return;
diff --git a/src/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.php b/src/Standards/Generic/Tests/WhiteSpace/DisallowTabIndentUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Generic\Tests\WhiteSpace;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class DisallowTabIndentUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         $config->tabWidth = 4;
 
diff --git a/src/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.php b/src/Standards/Generic/Tests/WhiteSpace/ScopeIndentUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Generic\Tests\WhiteSpace;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class ScopeIndentUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         $config->setConfigData('scope_indent_debug', '0', true);
 
diff --git a/src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.php b/src/Standards/PEAR/Tests/Classes/ClassDeclarationUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\PEAR\Tests\Classes;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class ClassDeclarationUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         if ($testFile === 'ClassDeclarationUnitTest.1.inc') {
             return;
diff --git a/src/Standards/PEAR/Tests/WhiteSpace/ScopeIndentUnitTest.php b/src/Standards/PEAR/Tests/WhiteSpace/ScopeIndentUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\PEAR\Tests\WhiteSpace;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class ScopeIndentUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         $config->setConfigData('scope_indent_debug', '0', true);
 
diff --git a/src/Standards/PSR1/Tests/Files/SideEffectsUnitTest.php b/src/Standards/PSR1/Tests/Files/SideEffectsUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\PSR1\Tests\Files;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class SideEffectsUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         if ($testFile === 'SideEffectsUnitTest.12.inc') {
             $config->annotations = false;
diff --git a/src/Standards/Squiz/Tests/Classes/ClassFileNameUnitTest.php b/src/Standards/Squiz/Tests/Classes/ClassFileNameUnitTest.php
@@ -31,7 +31,7 @@ final class ClassFileNameUnitTest extends AbstractSniffTestCase
      *
      * @return string[]
      */
-    protected function getTestFiles($testFileBase)
+    protected function getTestFiles(string $testFileBase)
     {
         $testFiles = [];
 
diff --git a/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.php b/src/Standards/Squiz/Tests/Commenting/BlockCommentUnitTest.php
@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\Squiz\Tests\Commenting;
 
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
 /**
@@ -28,7 +29,7 @@ final class BlockCommentUnitTest extends AbstractSniffTestCase
      *
      * @return void
      */
-    public function setCliValues($testFile, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
         $config->tabWidth = 4;
 
diff --git a/tests/Standards/AbstractSniffTestCase.php b/tests/Standards/AbstractSniffTestCase.php
@@ -14,6 +14,7 @@
 namespace PHP_CodeSniffer\Tests\Standards;
 
 use DirectoryIterator;
+use PHP_CodeSniffer\Config;
 use PHP_CodeSniffer\Exceptions\RuntimeException;
 use PHP_CodeSniffer\Files\LocalFile;
 use PHP_CodeSniffer\Ruleset;
@@ -99,7 +100,7 @@ public static function tearDownAfterClass(): void
      *
      * @return string[]
      */
-    protected function getTestFiles($testFileBase)
+    protected function getTestFiles(string $testFileBase)
     {
         $testFiles = [];
 
@@ -440,12 +441,12 @@ public function generateFailureMessages(LocalFile $file)
     /**
      * Get a list of CLI values to set before the file is tested.
      *
-     * @param string                  $filename The name of the file being tested.
+     * @param string                  $testFile The name of the file being tested.
      * @param \PHP_CodeSniffer\Config $config   The config data for the run.
      *
      * @return void
      */
-    public function setCliValues($filename, $config)
+    public function setCliValues(string $testFile, Config $config)
     {
 
     }//end setCliValues()

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ final class EmptyPHPStatementUnitTest extends AbstractSniffTestCase`
`27`	`27`	`*`
`28`	`28`	`* @return string[]`
`29`	`29`	`*/`
`30`		`- protected function getTestFiles($testFileBase)`
	`30`	`+ protected function getTestFiles(string $testFileBase)`
`31`	`31`	`{`
`32`	`32`	`$testFiles = [$testFileBase.'1.inc'];`
`33`	`33`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`
`10`	`10`	`namespace PHP_CodeSniffer\Standards\Generic\Tests\Commenting;`
`11`	`11`
	`12`	`+use PHP_CodeSniffer\Config;`
`12`	`13`	`use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;`
`13`	`14`
`14`	`15`	`/**`
`@@ -28,7 +29,7 @@ final class DocCommentUnitTest extends AbstractSniffTestCase`
`28`	`29`	`*`
`29`	`30`	`* @return void`
`30`	`31`	`*/`
`31`		`- public function setCliValues($testFile, $config)`
	`32`	`+ public function setCliValues(string $testFile, Config $config)`
`32`	`33`	`{`
`33`	`34`	`$config->tabWidth = 4;`
`34`	`35`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ final class LowercasedFilenameUnitTest extends AbstractSniffTestCase`
`30`	`30`	`*`
`31`	`31`	`* @return string[]`
`32`	`32`	`*/`
`33`		`- protected function getTestFiles($testFileBase)`
	`33`	`+ protected function getTestFiles(string $testFileBase)`
`34`	`34`	`{`
`35`	`35`	`$testFileDir = dirname($testFileBase);`
`36`	`36`	`$testFiles = parent::getTestFiles($testFileBase);`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ final class DisallowShortOpenTagUnitTest extends AbstractSniffTestCase`
`27`	`27`	`*`
`28`	`28`	`* @return string[]`
`29`	`29`	`*/`
`30`		`- protected function getTestFiles($testFileBase)`
	`30`	`+ protected function getTestFiles(string $testFileBase)`
`31`	`31`	`{`
`32`	`32`	`$testFiles = [$testFileBase.'1.inc'];`
`33`	`33`