BCFile::getMemberProperties(): sync with PHPCS 4.0 / remove parse error warning + PHP 8.4 interface properties

jrfnl · jrfnl · commit 8471a1c92996 · 2025-06-04T22:02:14.000+02:00
As of PHPCS 4.0, the `File::getMemberProperties()` method:
* ... will handle properties in interfaces to support PHP 8.4, in which this is now allowed.
* ... will no longer throw a parse error warning.

This commit makes the necessary updates in PHPCSUtils for the same:
* Adds `T_INTERFACE` to the `Collections::ooPropertyScopes()` for PHP 8.4 properties in interfaces support.
* Updates the test expectations for the `Scopes::isOOProperty()` method to allow for PHP 8.4 properties in interfaces.
* Updates the `BCFile::getMemberProperties()` polyfill to mirror the PHPCS 4.0 version of the method.
* Updates various tests for both the `BCFile::getMemberProperties()` and the `Variables::getMemberProperties()` methods to be in line with the changes.

Ref: PHPCSStandards/PHP_CodeSniffer 991
diff --git a/PHPCSUtils/BackCompat/BCFile.php b/PHPCSUtils/BackCompat/BCFile.php
@@ -512,7 +512,8 @@ public static function getMethodProperties(File $phpcsFile, $stackPtr)
      *
      * Changelog for the PHPCS native function:
      * - Introduced in PHPCS 0.0.5.
-     * - The upstream method has received no significant updates since PHPCS 3.13.0.
+     * - PHPCS 4.0: properties in interfaces (PHP 8.4+) are accepted.
+     * - PHPCS 4.0: will no longer throw a parse error warning.
      *
      * @see \PHP_CodeSniffer\Files\File::getMemberProperties() Original source.
      * @see \PHPCSUtils\Utils\Variables::getMemberProperties() PHPCSUtils native improved version.
@@ -531,7 +532,137 @@ public static function getMethodProperties(File $phpcsFile, $stackPtr)
      */
     public static function getMemberProperties(File $phpcsFile, $stackPtr)
     {
-        return $phpcsFile->getMemberProperties($stackPtr);
+        $tokens = $phpcsFile->getTokens();
+
+        if ($tokens[$stackPtr]['code'] !== T_VARIABLE) {
+            throw new RuntimeException('$stackPtr must be of type T_VARIABLE');
+        }
+
+        $conditions = $tokens[$stackPtr]['conditions'];
+        $conditions = array_keys($conditions);
+        $ptr        = array_pop($conditions);
+        if (isset($tokens[$ptr]) === false
+            || isset(Tokens::$ooScopeTokens[$tokens[$ptr]['code']]) === false
+            || $tokens[$ptr]['code'] === T_ENUM
+        ) {
+            throw new RuntimeException('$stackPtr is not a class member var');
+        }
+
+        // Make sure it's not a method parameter.
+        if (empty($tokens[$stackPtr]['nested_parenthesis']) === false) {
+            $parenthesis = array_keys($tokens[$stackPtr]['nested_parenthesis']);
+            $deepestOpen = array_pop($parenthesis);
+            if ($deepestOpen > $ptr
+                && isset($tokens[$deepestOpen]['parenthesis_owner']) === true
+                && $tokens[$tokens[$deepestOpen]['parenthesis_owner']]['code'] === T_FUNCTION
+            ) {
+                throw new RuntimeException('$stackPtr is not a class member var');
+            }
+        }
+
+        $valid = [
+            T_PUBLIC    => T_PUBLIC,
+            T_PRIVATE   => T_PRIVATE,
+            T_PROTECTED => T_PROTECTED,
+            T_STATIC    => T_STATIC,
+            T_VAR       => T_VAR,
+            T_READONLY  => T_READONLY,
+            T_FINAL     => T_FINAL,
+        ];
+
+        $valid += Tokens::$emptyTokens;
+
+        $scope          = 'public';
+        $scopeSpecified = false;
+        $isStatic       = false;
+        $isReadonly     = false;
+        $isFinal        = false;
+
+        $startOfStatement = $phpcsFile->findPrevious(
+            [
+                T_SEMICOLON,
+                T_OPEN_CURLY_BRACKET,
+                T_CLOSE_CURLY_BRACKET,
+                T_ATTRIBUTE_END,
+            ],
+            ($stackPtr - 1)
+        );
+
+        for ($i = ($startOfStatement + 1); $i < $stackPtr; $i++) {
+            if (isset($valid[$tokens[$i]['code']]) === false) {
+                break;
+            }
+
+            switch ($tokens[$i]['code']) {
+                case T_PUBLIC:
+                    $scope          = 'public';
+                    $scopeSpecified = true;
+                    break;
+                case T_PRIVATE:
+                    $scope          = 'private';
+                    $scopeSpecified = true;
+                    break;
+                case T_PROTECTED:
+                    $scope          = 'protected';
+                    $scopeSpecified = true;
+                    break;
+                case T_STATIC:
+                    $isStatic = true;
+                    break;
+                case T_READONLY:
+                    $isReadonly = true;
+                    break;
+                case T_FINAL:
+                    $isFinal = true;
+                    break;
+            }
+        }
+
+        $type         = '';
+        $typeToken    = false;
+        $typeEndToken = false;
+        $nullableType = false;
+
+        if ($i < $stackPtr) {
+            // We've found a type.
+            $valid = Collections::propertyTypeTokens();
+
+            for ($i; $i < $stackPtr; $i++) {
+                if ($tokens[$i]['code'] === T_VARIABLE) {
+                    // Hit another variable in a group definition.
+                    break;
+                }
+
+                if ($tokens[$i]['code'] === T_NULLABLE) {
+                    $nullableType = true;
+                }
+
+                if (isset($valid[$tokens[$i]['code']]) === true) {
+                    $typeEndToken = $i;
+                    if ($typeToken === false) {
+                        $typeToken = $i;
+                    }
+
+                    $type .= $tokens[$i]['content'];
+                }
+            }
+
+            if ($type !== '' && $nullableType === true) {
+                $type = '?' . $type;
+            }
+        }
+
+        return [
+            'scope'           => $scope,
+            'scope_specified' => $scopeSpecified,
+            'is_static'       => $isStatic,
+            'is_readonly'     => $isReadonly,
+            'is_final'        => $isFinal,
+            'type'            => $type,
+            'type_token'      => $typeToken,
+            'type_end_token'  => $typeEndToken,
+            'nullable_type'   => $nullableType,
+        ];
     }
 
     /**
diff --git a/PHPCSUtils/Tokens/Collections.php b/PHPCSUtils/Tokens/Collections.php
@@ -415,7 +415,7 @@ final class Collections
     /**
      * OO scopes in which properties can be declared.
      *
-     * Note: interfaces can not declare properties.
+     * - PHP 8.4 added support for properties in interfaces.
      *
      * @since 1.0.0 Use the {@see Collections::ooPropertyScopes()} method for access.
      *
@@ -424,6 +424,7 @@ final class Collections
     private static $ooPropertyScopes = [
         \T_CLASS      => \T_CLASS,
         \T_ANON_CLASS => \T_ANON_CLASS,
+        \T_INTERFACE  => \T_INTERFACE,
         \T_TRAIT      => \T_TRAIT,
     ];
 
diff --git a/PHPCSUtils/Utils/Variables.php b/PHPCSUtils/Utils/Variables.php
@@ -80,7 +80,7 @@ final class Variables
      * Retrieve the visibility and implementation properties of a class member variable.
      *
      * Main differences with the PHPCS version:
-     * - Removed the parse error warning for properties in interfaces.
+     * - Removed the parse error warning for properties in enums (PHPCS 4.0 makes the same change).
      *   This will now throw the same _"$stackPtr is not a class member var"_ runtime exception as
      *   other non-property variables passed to the method.
      * - Defensive coding against incorrect calls to this method.
diff --git a/Tests/BackCompat/BCFile/GetMemberPropertiesTest.php b/Tests/BackCompat/BCFile/GetMemberPropertiesTest.php
@@ -636,9 +636,19 @@ public static function dataGetMemberProperties()
                     'nullable_type'   => false,
                 ],
             ],
-            'invalid-property-in-interface' => [
+            'property-in-interface' => [
                 'identifier' => '/* testInterfaceProperty */',
-                'expected'   => [],
+                'expected'   => [
+                    'scope'           => 'protected',
+                    'scope_specified' => true,
+                    'is_static'       => false,
+                    'is_readonly'     => false,
+                    'is_final'        => false,
+                    'type'            => '',
+                    'type_token'      => false,
+                    'type_end_token'  => false,
+                    'nullable_type'   => false,
+                ],
             ],
             'property-in-nested-class-1' => [
                 'identifier' => '/* testNestedProperty 1 */',
@@ -1033,10 +1043,6 @@ public static function dataGetMemberProperties()
                     'nullable_type'   => false,
                 ],
             ],
-            'invalid-property-in-enum' => [
-                'identifier' => '/* testEnumProperty */',
-                'expected'   => [],
-            ],
             'php8.1-single-intersection-type' => [
                 'identifier' => '/* testPHP81IntersectionTypes */',
                 'expected'   => [
@@ -1400,6 +1406,7 @@ public static function dataNotClassProperty()
             'method parameter in anon class nested in ternary'       => ['/* testNestedMethodParam 1 */'],
             'method parameter in anon class nested in function call' => ['/* testNestedMethodParam 2 */'],
             'method parameter in enum'                               => ['/* testEnumMethodParamNotProperty */'],
+            'property in enum (parse error)'                         => ['/* testEnumProperty */'],
         ];
     }
 
diff --git a/Tests/Utils/Scopes/IsOOPropertyTest.inc b/Tests/Utils/Scopes/IsOOPropertyTest.inc
@@ -41,7 +41,7 @@ $a = new class {
 };
 
 interface MyInterface {
-    // Intentional parse error. Properties are not allowed in interfaces.
+    // Properties are allowed in interfaces since PHP 8.4 (with a property hook).
     /* testInterfaceProp */
     public $interfaceProp = false;
 
diff --git a/Tests/Utils/Scopes/IsOOPropertyTest.php b/Tests/Utils/Scopes/IsOOPropertyTest.php
@@ -125,7 +125,7 @@ public static function dataIsOOProperty()
             ],
             'interface-property' => [
                 'testMarker' => '/* testInterfaceProp */',
-                'expected'   => false,
+                'expected'   => true,
             ],
             'interface-method-param' => [
                 'testMarker' => '/* testInterfaceMethodParameter */',
diff --git a/Tests/Utils/Variables/GetMemberPropertiesDiffTest.inc b/Tests/Utils/Variables/GetMemberPropertiesDiffTest.inc
@@ -1,13 +1,3 @@
 <?php
 
-interface Base
-{
-    /* testInterfaceProperty */
-    protected $anonymous;
-}
-
-enum Suit
-{
-    /* testEnumProperty */
-    protected $anonymous;
-}
+// Placeholder file.
diff --git a/Tests/Utils/Variables/GetMemberPropertiesDiffTest.php b/Tests/Utils/Variables/GetMemberPropertiesDiffTest.php
@@ -55,37 +55,4 @@ public function testNonExistentToken()
 
         Variables::getMemberProperties(self::$phpcsFile, 10000);
     }
-
-    /**
-     * Test receiving an expected exception when an (invalid) interface or enum property is passed.
-     *
-     * @dataProvider dataNotClassPropertyException
-     *
-     * @param string $testMarker Comment which precedes the test case.
-     *
-     * @return void
-     */
-    public function testNotClassPropertyException($testMarker)
-    {
-        $this->expectException('PHPCSUtils\Exceptions\ValueError');
-        $this->expectExceptionMessage('The value of argument #2 ($stackPtr) must be the pointer to a class member var');
-
-        $variable = $this->getTargetToken($testMarker, \T_VARIABLE);
-        Variables::getMemberProperties(self::$phpcsFile, $variable);
-    }
-
-    /**
-     * Data provider.
-     *
-     * @see testNotClassPropertyException()
-     *
-     * @return array<string, array<string>>
-     */
-    public static function dataNotClassPropertyException()
-    {
-        return [
-            'interface property' => ['/* testInterfaceProperty */'],
-            'enum property'      => ['/* testEnumProperty */'],
-        ];
-    }
 }
diff --git a/Tests/Utils/Variables/GetMemberPropertiesTest.php b/Tests/Utils/Variables/GetMemberPropertiesTest.php
@@ -90,26 +90,6 @@ public function testNotAVariableException()
         Variables::getMemberProperties(self::$phpcsFile, $next);
     }
 
-    /**
-     * Data provider.
-     *
-     * @see testGetMemberProperties()
-     *
-     * @return array<string, array<string|array<string, string|int|bool>>>
-     */
-    public static function dataGetMemberProperties()
-    {
-        $data = parent::dataGetMemberProperties();
-
-        /*
-         * Remove the data sets related to the invalid interface/enum properties.
-         * These will now throw an exception instead.
-         */
-        unset($data['invalid-property-in-interface'], $data['invalid-property-in-enum']);
-
-        return $data;
-    }
-
     /**
      * Verify that the build-in caching is used when caching is enabled.
      *

Original file line number	Diff line number	Diff line change
`@@ -415,7 +415,7 @@ final class Collections`
`415`	`415`	`/**`
`416`	`416`	`* OO scopes in which properties can be declared.`
`417`	`417`	`*`
`418`		`- * Note: interfaces can not declare properties.`
	`418`	`+ * - PHP 8.4 added support for properties in interfaces.`
`419`	`419`	`*`
`420`	`420`	`* @since 1.0.0 Use the {@see Collections::ooPropertyScopes()} method for access.`
`421`	`421`	`*`
`@@ -424,6 +424,7 @@ final class Collections`
`424`	`424`	`private static $ooPropertyScopes = [`
`425`	`425`	`\T_CLASS => \T_CLASS,`
`426`	`426`	`\T_ANON_CLASS => \T_ANON_CLASS,`
	`427`	`+ \T_INTERFACE => \T_INTERFACE,`
`427`	`428`	`\T_TRAIT => \T_TRAIT,`
`428`	`429`	`];`
`429`	`430`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ final class Variables`
`80`	`80`	`* Retrieve the visibility and implementation properties of a class member variable.`
`81`	`81`	`*`
`82`	`82`	`* Main differences with the PHPCS version:`
`83`		`- * - Removed the parse error warning for properties in interfaces.`
	`83`	`+ * - Removed the parse error warning for properties in enums (PHPCS 4.0 makes the same change).`
`84`	`84`	`* This will now throw the same _"$stackPtr is not a class member var"_ runtime exception as`
`85`	`85`	`* other non-property variables passed to the method.`
`86`	`86`	`* - Defensive coding against incorrect calls to this method.`