File::getMemberProperties(): removed parse error warning

The `File::getMemberProperties()` method used to be inconsistent in how it handled variable tokens which were not property declarations.
* In most cases ("normal" variable, function parameter), it would throw a `RuntimeException` _"'$stackPtr is not a class member var'"_.
* However, for "properties" declared in an `enum` or `interface` construct, it would register a warning about a possible parse error and return an empty array.

This parse error warning has now been removed.

As, as of PHP 8.4, declaring (hooked) properties in an interface is no longer a parse error (see the [Property Hooks RFC](https://wiki.php.net/rfc/property-hooks)), properties declared in interfaces will now be analyzed by the function, like any other property, and will return an array of information about the property.

For "properties" declared in enums, which is still not allowed in PHP, the method will throw the `RuntimeException` _"'$stackPtr is not a class member var'"_.

Includes updated unit tests for the `File::getMemberProperties()` method.

Includes a review of all uses of the `File::getMemberProperties()` method in PHPCS native sniffs and updating the code where necessary.
Includes adding/updating tests with properties in interfaces and enums for each of those sniffs.

Closes squizlabs/PHP_CodeSniffer 2455

Also related to 734

Co-authored-by: Greg Sherwood <[email protected]>

Author: jrfnl

src/Files/File.php

@@ -1791,34 +1791,15 @@ public function getMemberProperties($stackPtr)
             throw new RuntimeException('$stackPtr must be of type T_VARIABLE');
         }
 
-        $conditions = array_keys($this->tokens[$stackPtr]['conditions']);
+        $conditions = $this->tokens[$stackPtr]['conditions'];
+        $conditions = array_keys($conditions);
         $ptr        = array_pop($conditions);
         if (isset($this->tokens[$ptr]) === false
-            || ($this->tokens[$ptr]['code'] !== T_CLASS
-            && $this->tokens[$ptr]['code'] !== T_ANON_CLASS
-            && $this->tokens[$ptr]['code'] !== T_TRAIT)
+            || isset(Tokens::$ooScopeTokens[$this->tokens[$ptr]['code']]) === false
+            || $this->tokens[$ptr]['code'] === T_ENUM
         ) {
-            if (isset($this->tokens[$ptr]) === true
-                && ($this->tokens[$ptr]['code'] === T_INTERFACE
-                || $this->tokens[$ptr]['code'] === T_ENUM)
-            ) {
-                // T_VARIABLEs in interfaces/enums can actually be method arguments
-                // but they won't be seen as being inside the method because there
-                // are no scope openers and closers for abstract methods. If it is in
-                // parentheses, we can be pretty sure it is a method argument.
-                if (isset($this->tokens[$stackPtr]['nested_parenthesis']) === false
-                    || empty($this->tokens[$stackPtr]['nested_parenthesis']) === true
-                ) {
-                    $error = 'Possible parse error: %ss may not include member vars';
-                    $code  = sprintf('Internal.ParseError.%sHasMemberVar', ucfirst($this->tokens[$ptr]['content']));
-                    $data  = [strtolower($this->tokens[$ptr]['content'])];
-                    $this->addWarning($error, $stackPtr, $code, $data);
-                    return [];
-                }
-            } else {
-                throw new RuntimeException('$stackPtr is not a class member var');
-            }
-        }//end if
+            throw new RuntimeException('$stackPtr is not a class member var');
+        }
 
         // Make sure it's not a method parameter.
         if (empty($this->tokens[$stackPtr]['nested_parenthesis']) === false) {

src/Standards/Generic/Sniffs/PHP/LowerCaseTypeSniff.php

@@ -162,15 +162,10 @@ public function process(File $phpcsFile, $stackPtr)
                 try {
                     $props = $phpcsFile->getMemberProperties($i);
                 } catch (RuntimeException $e) {
-                    // Not an OO property.
+                    // Parse error: property in enum. Ignore.
                     continue;
                 }
 
-                if (empty($props) === true) {
-                    // Parse error - property in interface or enum. Ignore.
-                    return;
-                }
-
                 // Strip off potential nullable indication.
                 $type = ltrim($props['type'], '?');
 

src/Standards/Generic/Tests/PHP/LowerCaseTypeUnitTest.1.inc

@@ -139,7 +139,6 @@ class DNFTypes {
     function DNFReturnTypes ($var): object|(Self&\Package\Other_Class)|sTRINg|false {}
 }
 
-// Intentional error, should be ignored by the sniff.
-interface PropertiesNotAllowed {
-    public $notAllowed;
+interface PHP84HookedProperty {
+    public String $readable { get; }
 }

src/Standards/Generic/Tests/PHP/LowerCaseTypeUnitTest.1.inc.fixed

@@ -139,7 +139,6 @@ class DNFTypes {
     function DNFReturnTypes ($var): object|(self&\Package\Other_Class)|string|false {}
 }
 
-// Intentional error, should be ignored by the sniff.
-interface PropertiesNotAllowed {
-    public $notAllowed;
+interface PHP84HookedProperty {
+    public string $readable { get; }
 }

src/Standards/Generic/Tests/PHP/LowerCaseTypeUnitTest.2.inc

@@ -0,0 +1,8 @@
+<?php
+
+// Intentional parse error, should be ignored by the sniff.
+// This should be the only test in this test case file.
+
+enum PropertiesNotAllowed {
+    public STRING $notAllowed;
+}

src/Standards/Generic/Tests/PHP/LowerCaseTypeUnitTest.php

@@ -97,6 +97,7 @@ public function getErrorList($testFile='')
                 135 => 1,
                 136 => 1,
                 139 => 2,
+                143 => 1,
             ];
 
         default:
@@ -112,20 +113,11 @@ 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.
      *
-     * @param string $testFile The name of the file being tested.
-     *
      * @return array<int, int>
      */
-    public function getWarningList($testFile='')
+    public function getWarningList()
     {
-        switch ($testFile) {
-        case 'LowerCaseTypeUnitTest.1.inc':
-            // Warning from getMemberProperties() about parse error.
-            return [144 => 1];
-
-        default:
-            return [];
-        }//end switch
+        return [];
 
     }//end getWarningList()
 

src/Standards/PEAR/Sniffs/NamingConventions/ValidVariableNameSniff.php

@@ -9,6 +9,7 @@
 
 namespace PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions;
 
+use PHP_CodeSniffer\Exceptions\RuntimeException;
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
 
@@ -27,13 +28,14 @@ class ValidVariableNameSniff extends AbstractVariableSniff
      */
     protected function processMemberVar(File $phpcsFile, $stackPtr)
     {
-        $tokens = $phpcsFile->getTokens();
-
-        $memberProps = $phpcsFile->getMemberProperties($stackPtr);
-        if (empty($memberProps) === true) {
+        try {
+            $memberProps = $phpcsFile->getMemberProperties($stackPtr);
+        } catch (RuntimeException $e) {
+            // Parse error: property in enum. Ignore.
             return;
         }
 
+        $tokens         = $phpcsFile->getTokens();
         $memberName     = ltrim($tokens[$stackPtr]['content'], '$');
         $scope          = $memberProps['scope'];
         $scopeSpecified = $memberProps['scope_specified'];

src/Standards/PEAR/Tests/NamingConventions/ValidVariableNameUnitTest.1.inc

@@ -99,3 +99,8 @@ $util->setLogger(
         private $varName  = 'hello';
         private $_varName = 'hello';
 });
+
+interface PHP84HookedProperty {
+    public $thisisfine { get; }
+    public $_underscore { get; }
+}

src/Standards/PEAR/Tests/NamingConventions/ValidVariableNameUnitTest.2.inc

@@ -0,0 +1,8 @@
+<?php
+
+// Intentional parse error, should be ignored by the sniff.
+// This should be the only test in this test case file.
+
+enum PropertiesNotAllowed {
+    public $_notAllowed;
+}

src/Standards/PEAR/Tests/NamingConventions/ValidVariableNameUnitTest.php

@@ -35,13 +35,14 @@ public function getErrorList($testFile='')
         switch ($testFile) {
         case 'ValidVariableNameUnitTest.1.inc':
             return [
-                12 => 1,
-                17 => 1,
-                22 => 1,
-                92 => 1,
-                93 => 1,
-                94 => 1,
-                99 => 1,
+                12  => 1,
+                17  => 1,
+                22  => 1,
+                92  => 1,
+                93  => 1,
+                94  => 1,
+                99  => 1,
+                105 => 1,
             ];
 
         default: