Merge pull request #494 from PHPCSStandards/backcompat/bcfile-getdeclarationname-sync-with-upstream

BCFile::getDeclarationName(): sync with upstream

Author: jrfnl

PHPCSUtils/BackCompat/BCFile.php

@@ -50,6 +50,7 @@
  * any affected utility functions:
  * - `readonly` classes.
  * - Constructor property promotion with `readonly` without visibility.
+ * - OO methods called `self`, `parent` or `static`.
  *
  * Most functions in this class will have a related twin-function in the relevant
  * class in the `PHPCSUtils\Utils` namespace.
@@ -75,7 +76,7 @@ final class BCFile
  *
  * Changelog for the PHPCS native function:
  * - Introduced in PHPCS 0.0.5.
- * - The upstream method has received no significant updates since PHPCS 3.7.1.
+ * - PHPCS 3.8.0: OO methods called `self`, `parent` or `static` are now correctly recognized.
  *
  * @see \PHP_CodeSniffer\Files\File::getDeclarationName() Original source.
  * @see \PHPCSUtils\Utils\ObjectDeclarations::getName() PHPCSUtils native improved version.
@@ -97,7 +98,44 @@ final class BCFile
  */
  public static function getDeclarationName(File $phpcsFile, $stackPtr)
  {
- return $phpcsFile->getDeclarationName($stackPtr);
+ $tokens = $phpcsFile->getTokens();
+ $tokenCode = $tokens[$stackPtr]['code'];
+
+ if ($tokenCode === T_ANON_CLASS || $tokenCode === T_CLOSURE) {
+ return null;
+ }
+
+ if ($tokenCode !== T_FUNCTION
+ && $tokenCode !== T_CLASS
+ && $tokenCode !== T_INTERFACE
+ && $tokenCode !== T_TRAIT
+ && $tokenCode !== T_ENUM
+ ) {
+ throw new RuntimeException('Token type "' . $tokens[$stackPtr]['type'] . '" is not T_FUNCTION, T_CLASS, T_INTERFACE, T_TRAIT or T_ENUM');
+ }
+
+ if ($tokenCode === T_FUNCTION
+ && strtolower($tokens[$stackPtr]['content']) !== 'function'
+ ) {
+ // This is a function declared without the "function" keyword.
+ // So this token is the function name.
+ return $tokens[$stackPtr]['content'];
+ }
+
+ $content = null;
+ for ($i = ($stackPtr + 1); $i < $phpcsFile->numTokens; $i++) {
+ if ($tokens[$i]['code'] === T_STRING
+ // BC: PHPCS < 3.8.0.
+ || $tokens[$i]['code'] === T_SELF
+ || $tokens[$i]['code'] === T_PARENT
+ || $tokens[$i]['code'] === T_STATIC
+ ) {
+ $content = $tokens[$i]['content'];
+ break;
+ }
+ }
+
+ return $content;
  }
 
  /**

Tests/BackCompat/BCFile/GetDeclarationNameTest.inc

@@ -88,6 +88,15 @@ enum Suit: int implements Colorful, CardGame {}
 /* testFunctionReturnByRefWithReservedKeywordEach */
 function &each() {}
 
+/* testFunctionReturnByRefWithReservedKeywordParent */
+function &parent() {}
+
+/* testFunctionReturnByRefWithReservedKeywordSelf */
+function &self() {}
+
+/* testFunctionReturnByRefWithReservedKeywordStatic */
+function &static() {}
+
 /* testLiveCoding */
 // Intentional parse error. This has to be the last test in the file.
 function // Comment.

Tests/BackCompat/BCFile/GetDeclarationNameTest.php

@@ -196,6 +196,18 @@ public static function dataGetDeclarationName()
  '/* testFunctionReturnByRefWithReservedKeywordEach */',
  'each',
  ],
+ 'function-return-by-reference-with-reserved-keyword-parent' => [
+ '/* testFunctionReturnByRefWithReservedKeywordParent */',
+ 'parent',
+ ],
+ 'function-return-by-reference-with-reserved-keyword-self' => [
+ '/* testFunctionReturnByRefWithReservedKeywordSelf */',
+ 'self',
+ ],
+ 'function-return-by-reference-with-reserved-keyword-static' => [
+ '/* testFunctionReturnByRefWithReservedKeywordStatic */',
+ 'static',
+ ],
  ];
  }
 }

Tests/Utils/ObjectDeclarations/GetNameDiffTest.inc

@@ -12,15 +12,6 @@ interface switch{ // Intentional parse error.
  public function someFunction();
 }
 
-/* testFunctionReturnByRefWithReservedKeywordParent */
-function &parent() {}
-
-/* testFunctionReturnByRefWithReservedKeywordSelf */
-function &self() {}
-
-/* testFunctionReturnByRefWithReservedKeywordStatic */
-function &static() {}
-
 /* testLiveCoding */
 // Intentional parse error. Redundancy testing.
 abstract class

Tests/Utils/ObjectDeclarations/GetNameDiffTest.php

@@ -117,18 +117,6 @@ public static function dataGetName()
  'testMarker' => '/* testInvalidInterfaceName */',
  'expected' => 'switch',
  ],
- 'function-return-by-reference-with-reserved-keyword-parent' => [
- '/* testFunctionReturnByRefWithReservedKeywordParent */',
- 'parent',
- ],
- 'function-return-by-reference-with-reserved-keyword-self' => [
- '/* testFunctionReturnByRefWithReservedKeywordSelf */',
- 'self',
- ],
- 'function-return-by-reference-with-reserved-keyword-static' => [
- '/* testFunctionReturnByRefWithReservedKeywordStatic */',
- 'static',
- ],
  ];
  }
 }