PHP 8.4 | Add tokenizer support for asymmetric visibility (#871)

Author: DanielEScherzer

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

@@ -160,3 +160,15 @@ class SkipOverPHP84FinalProperties {
     final MyType|FALSE $propA;
     private static final NULL|MyClass $propB;
 }
+
+// PHP 8.4 asymmetric visibility
+class WithAsym {
+
+    private(set) NULL|TRUE $asym1 = TRUE;
+
+    public private(set) ?bool $asym2 = FALSE;
+
+    protected(set) FALSE|string|null $asym3 = NULL;
+
+    public protected(set) Type|NULL|bool $asym4 = TRUE;
+}

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

@@ -160,3 +160,15 @@ class SkipOverPHP84FinalProperties {
     final MyType|FALSE $propA;
     private static final NULL|MyClass $propB;
 }
+
+// PHP 8.4 asymmetric visibility
+class WithAsym {
+
+    private(set) NULL|TRUE $asym1 = true;
+
+    public private(set) ?bool $asym2 = false;
+
+    protected(set) FALSE|string|null $asym3 = null;
+
+    public protected(set) Type|NULL|bool $asym4 = true;
+}

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

@@ -66,6 +66,10 @@ public function getErrorList($testFile='')
                 129 => 1,
                 149 => 1,
                 153 => 1,
+                167 => 1,
+                169 => 1,
+                171 => 1,
+                173 => 1,
             ];
 
         case 'LowerCaseConstantUnitTest.js':

src/Standards/PSR12/Sniffs/Properties/ConstantVisibilitySniff.php

@@ -50,8 +50,14 @@ public function process(File $phpcsFile, $stackPtr)
         $ignore   = Tokens::$emptyTokens;
         $ignore[] = T_FINAL;
 
+        $validVisibility = [
+            T_PRIVATE   => T_PRIVATE,
+            T_PUBLIC    => T_PUBLIC,
+            T_PROTECTED => T_PROTECTED,
+        ];
+
         $prev = $phpcsFile->findPrevious($ignore, ($stackPtr - 1), null, true);
-        if (isset(Tokens::$scopeModifiers[$tokens[$prev]['code']]) === true) {
+        if (isset($validVisibility[$tokens[$prev]['code']]) === true) {
             return;
         }
 

src/Standards/PSR12/Tests/Properties/ConstantVisibilityUnitTest.inc renamed to src/Standards/PSR12/Tests/Properties/ConstantVisibilityUnitTest.1.inc

@@ -0,0 +1,7 @@
+<?php
+
+// Intentional parse error - unsupported asym visibility used on class constant.
+// Testing that the sniff will flags this as the constant doesn't have a valid visibility.
+class Foo {
+    public(set) const BAR = 'bar';
+}

src/Standards/PSR12/Tests/Properties/ConstantVisibilityUnitTest.2.inc

@@ -41,15 +41,28 @@ public function getErrorList()
      * 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()
+    public function getWarningList($testFile='')
     {
-        return [
-            4  => 1,
-            12 => 1,
-            21 => 1,
-        ];
+        switch ($testFile) {
+        case 'ConstantVisibilityUnitTest.1.inc':
+            return [
+                4  => 1,
+                12 => 1,
+                21 => 1,
+            ];
+
+        case 'ConstantVisibilityUnitTest.2.inc':
+            return [
+                6 => 1,
+            ];
+
+        default:
+            return [];
+        }
 
     }//end getWarningList()
 

src/Standards/PSR12/Tests/Properties/ConstantVisibilityUnitTest.php

@@ -96,3 +96,17 @@ class FinalProperties {
     public FINAL ?int $wrongOrder1;
     static protected final ?string $wrongOrder2;
 }
+
+class AsymmetricVisibility {
+    private(set) int $foo,
+        $bar,
+        $var = 5;
+
+    public private(set) readonly ?string    $spaces;
+
+    protected(set) array $unfixed;
+
+    protected(set) public int $wrongOrder1;
+
+    private(set) protected ?string $wrongOrder2;
+}

src/Standards/PSR2/Tests/Classes/PropertyDeclarationUnitTest.inc

@@ -93,3 +93,17 @@ class FinalProperties {
     FINAL public ?int $wrongOrder1;
     final protected static ?string $wrongOrder2;
 }
+
+class AsymmetricVisibility {
+    private(set) int $foo,
+        $bar,
+        $var = 5;
+
+    public private(set) readonly ?string $spaces;
+
+    protected(set) array $unfixed;
+
+    protected(set) public int $wrongOrder1;
+
+    private(set) protected ?string $wrongOrder2;
+}

src/Standards/PSR2/Tests/Classes/PropertyDeclarationUnitTest.inc.fixed

@@ -31,36 +31,41 @@ final class PropertyDeclarationUnitTest extends AbstractSniffUnitTest
     public function getErrorList()
     {
         return [
-            7  => 1,
-            9  => 2,
-            10 => 1,
-            11 => 1,
-            17 => 1,
-            18 => 1,
-            23 => 1,
-            38 => 1,
-            41 => 1,
-            42 => 1,
-            50 => 2,
-            51 => 1,
-            55 => 1,
-            56 => 1,
-            61 => 1,
-            62 => 1,
-            68 => 1,
-            69 => 1,
-            71 => 1,
-            72 => 1,
-            76 => 1,
-            80 => 1,
-            82 => 1,
-            84 => 1,
-            86 => 1,
-            90 => 1,
-            94 => 1,
-            95 => 1,
-            96 => 1,
-            97 => 2,
+            7   => 1,
+            9   => 2,
+            10  => 1,
+            11  => 1,
+            17  => 1,
+            18  => 1,
+            23  => 1,
+            38  => 1,
+            41  => 1,
+            42  => 1,
+            50  => 2,
+            51  => 1,
+            55  => 1,
+            56  => 1,
+            61  => 1,
+            62  => 1,
+            68  => 1,
+            69  => 1,
+            71  => 1,
+            72  => 1,
+            76  => 1,
+            80  => 1,
+            82  => 1,
+            84  => 1,
+            86  => 1,
+            90  => 1,
+            94  => 1,
+            95  => 1,
+            96  => 1,
+            97  => 2,
+            101 => 2,
+            105 => 1,
+            107 => 1,
+            109 => 1,
+            111 => 1,
         ];
 
     }//end getErrorList()