Merge pull request #359 from cakephp/object-arrays

Add option to skip legacy generics
cakephp · May 21, 2022 · 4bca0b8 · 4bca0b8
2 parents 3f42885 + 9f8feb4
commit 4bca0b8
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/CakePHP/Sniffs/Commenting/TypeHintSniff.php b/CakePHP/Sniffs/Commenting/TypeHintSniff.php
@@ -43,6 +43,13 @@ class TypeHintSniff implements Sniff
      */
     public bool $convertArraysToGenerics = true;
 
+    /**
+     * Keeps types in the form: \ClassName|Type[].
+     *
+     * @var bool
+     */
+    public bool $ignoreLegacyGenerics = false;
+
     /**
      * @var array<string>
      */
@@ -102,6 +109,10 @@ public function process(File $phpcsFile, $stackPtr)
                 continue;
             }
 
+            if ($this->ignoreLegacyGenerics && $this->isLegacyGenericType($types)) {
+                continue;
+            }
+
             $originalTypeHint = $this->renderUnionTypes($types);
             $sortedTypeHint = $this->getSortedTypeHint($types);
             if ($sortedTypeHint === $originalTypeHint) {
@@ -152,6 +163,21 @@ public function process(File $phpcsFile, $stackPtr)
         }
     }
 
+    /**
+     * @param array $types node types
+     * @return bool
+     */
+    protected function isLegacyGenericType(array $types): bool
+    {
+        if (count($types) != 2) {
+            return false;
+        }
+
+        return $types[0] instanceof IdentifierTypeNode &&
+            $types[1] instanceof ArrayTypeNode &&
+            $types[0]->name[0] === '\\';
+    }
+
     /**
      * @param array $types node types
      * @return string