PHP 8.0 | Squiz.Commenting.FunctionComment: add support for mixed param

squizlabs · Mar 31, 2021 · cf92acd · cf92acd
1 parent 1030040
commit cf92acd
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
@@ -444,6 +444,12 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
                     }
                 }
 
+                if ($this->phpVersion >= 80000) {
+                    if ($suggestedName === 'mixed') {
+                        $suggestedTypeHint = 'mixed';
+                    }
+                }
+
                 if ($suggestedTypeHint !== '' && isset($realParams[$pos]) === true) {
                     $typeHint = $realParams[$pos]['type_hint'];
 

diff --git a/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc b/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc
@@ -1012,3 +1012,12 @@ public function foo($a, $b) {}
  * {@inheritDoc}
  */
 public function foo($a, $b) {}
+
+/**
+ * Foo.
+ *
+ * @param mixed $a Comment.
+ *
+ * @return mixed
+ */
+public function foo(mixed $a): mixed {}
diff --git a/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed b/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed
@@ -1012,3 +1012,12 @@ public function foo($a, $b) {}
  * {@inheritDoc}
  */
 public function foo($a, $b) {}
+
+/**
+ * Foo.
+ *
+ * @param mixed $a Comment.
+ *
+ * @return mixed
+ */
+public function foo(mixed $a): mixed {}
diff --git a/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.php b/src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.php
@@ -144,6 +144,15 @@ public function getErrorList()
             $errors[992] = 2;
         }
 
+        // Mixed type hints only work from PHP 8.0 onwards.
+        if (PHP_VERSION_ID >= 80000) {
+            $errors[265] = 1;
+            $errors[459] = 1;
+            $errors[893] = 3;
+        } else {
+            $errors[1023] = 1;
+        }
+
         return $errors;
 
     }//end getErrorList()