Do not juggle with stripping _. Just don't use it for prefixing. We have better ways of defining property visibility nowadays.

Author: simPod

src/Cdn77/Sniffs/NamingConventions/ValidVariableNameSniff.php

@@ -6,16 +6,12 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\AbstractVariableSniff;
-use PHP_CodeSniffer\Util\Tokens;
 
 use function assert;
 use function ltrim;
 use function preg_match;
 use function preg_match_all;
 use function sprintf;
-use function strpos;
-use function substr;
-use function ucfirst;
 
 use const T_DOUBLE_COLON;
 use const T_NULLSAFE_OBJECT_OPERATOR;
@@ -63,17 +59,9 @@ protected function processVariable(File $phpcsFile, $stackPtr): void
                 if ($tokens[$bracket]['code'] !== T_OPEN_PARENTHESIS) {
                     $objVarName = $tokens[$var]['content'];
 
-                    // There is no way for us to know if the var is public or
-                    // private, so we have to ignore a leading underscore if there is
-                    // one and just check the main part of the variable name.
-                    $originalVarName = $objVarName;
-                    if (strpos($objVarName, '_') === 0) {
-                        $objVarName = substr($objVarName, 1);
-                    }
-
                     if (! $this->matchesRegex($objVarName)) {
                         $error = 'Member variable "%s" is not in valid camel caps format';
-                        $data = [$originalVarName];
+                        $data = [$objVarName];
                         $phpcsFile->addError($error, $var, 'MemberNotCamelCaps', $data);
                     }
                 }
@@ -82,14 +70,7 @@ protected function processVariable(File $phpcsFile, $stackPtr): void
 
         $objOperator = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
         if ($tokens[$objOperator]['code'] === T_DOUBLE_COLON) {
-            // The variable lives within a class, and is referenced like
-            // this: MyClass::$_variable, so we don't know its scope.
-            $objVarName = $varName;
-            if (strpos($objVarName, '_') === 0) {
-                $objVarName = substr($objVarName, 1);
-            }
-
-            if (! $this->matchesRegex($objVarName)) {
+            if (! $this->matchesRegex($varName)) {
                 $error = 'Member variable "%s" is not in valid camel caps format';
                 $data = [$tokens[$stackPtr]['content']];
                 $phpcsFile->addError($error, $stackPtr, 'MemberNotCamelCaps', $data);
@@ -98,23 +79,12 @@ protected function processVariable(File $phpcsFile, $stackPtr): void
             return;
         }
 
-        // There is no way for us to know if the var is public or private,
-        // so we have to ignore a leading underscore if there is one and just
-        // check the main part of the variable name.
-        $originalVarName = $varName;
-        if (strpos($varName, '_') === 0) {
-            $inClass = $phpcsFile->hasCondition($stackPtr, Tokens::$ooScopeTokens);
-            if ($inClass === true) {
-                $varName = substr($varName, 1);
-            }
-        }
-
         if ($this->matchesRegex($varName)) {
             return;
         }
 
         $error = 'Variable "%s" is not in valid camel caps format';
-        $data = [$originalVarName];
+        $data = [$varName];
         $phpcsFile->addError($error, $stackPtr, 'NotCamelCaps', $data);
     }
 
@@ -141,21 +111,8 @@ protected function processMemberVar(File $phpcsFile, $stackPtr): void
             return;
         }
 
-        $public = ($memberProps['scope'] !== 'private');
         $errorData = [$varName];
 
-        if (($public === true) && strpos($varName, '_') === 0) {
-            $error = '%s member variable "%s" must not contain a leading underscore';
-            $data = [
-                ucfirst($memberProps['scope']),
-                $errorData[0],
-            ];
-            $phpcsFile->addError($error, $stackPtr, 'PublicHasUnderscore', $data);
-        }
-
-        // Remove a potential underscore prefix for testing CamelCaps.
-        $varName = ltrim($varName, '_');
-
         if ($this->matchesRegex($varName)) {
             return;
         }

tests/Sniffs/NamingConventions/ValidVariableNameSniffTest.php

@@ -27,12 +27,14 @@ public function testErrors(): void
             3 => self::CODE_NOT_CAMEL_CAPS,
             5 => self::CODE_NOT_CAMEL_CAPS,
             10 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
-            12 => self::CODE_PUBLIC_HAS_UNDERSCORE,
+            12 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             15 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
-            17 => self::CODE_PUBLIC_HAS_UNDERSCORE,
+            17 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             20 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
-            22 => self::CODE_PUBLIC_HAS_UNDERSCORE,
+            22 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            24 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             25 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            26 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             31 => self::CODE_NOT_CAMEL_CAPS,
             33 => self::CODE_NOT_CAMEL_CAPS,
             36 => self::CODE_STRING_NOT_CAMEL_CAPS,
@@ -41,19 +43,25 @@ public function testErrors(): void
             42 => self::CODE_NOT_CAMEL_CAPS,
             44 => self::CODE_NOT_CAMEL_CAPS,
             53 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            55 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             58 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            60 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             62 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             63 => self::CODE_NOT_CAMEL_CAPS,
             64 => self::CODE_NOT_CAMEL_CAPS,
             67 => self::CODE_NOT_CAMEL_CAPS,
             81 => self::CODE_STRING_NOT_CAMEL_CAPS,
-            106 => self::CODE_PUBLIC_HAS_UNDERSCORE,
-            107 => self::CODE_PUBLIC_HAS_UNDERSCORE,
-            108 => self::CODE_PUBLIC_HAS_UNDERSCORE,
-            123 => self::CODE_PUBLIC_HAS_UNDERSCORE,
+            106 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            107 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            108 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            123 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            124 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            134 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             138 => self::CODE_NOT_CAMEL_CAPS,
+            140 => self::CODE_NOT_CAMEL_CAPS,
             141 => self::CODE_NOT_CAMEL_CAPS,
             146 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
+            148 => self::CODE_MEMBER_NOT_CAMEL_CAPS,
             150 => [self::CODE_NOT_CAMEL_CAPS, self::CODE_NOT_CAMEL_CAPS],
             152 => self::CODE_NOT_CAMEL_CAPS,
         ];
@@ -73,6 +81,6 @@ public function testErrors(): void
             }
         }
 
-        self::assertSame(33, $file->getErrorCount());
+        self::assertSame(43, $file->getErrorCount());
     }
 }