Merge pull request #3785 from fredden/php-fatal/squiz-commeting-function-comment

Fix PHP Fatal error in `Squiz.Commenting.FunctionComment`

Author: jrfnl

src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php

@@ -405,6 +405,10 @@ protected function processParams(File $phpcsFile, $stackPtr, $commentStart)
             $suggestedTypeNames = [];
 
             foreach ($typeNames as $typeName) {
+                if ($typeName === '') {
+                    continue;
+                }
+
                 // Strip nullable operator.
                 if ($typeName[0] === '?') {
                     $typeName = substr($typeName, 1);

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc

@@ -1046,3 +1046,11 @@ public function ignored() {
  * @return void
  * @throws Exception If any other error occurs. */
 function throwCommentOneLine() {}
+
+/**
+ * When two adjacent pipe symbols are used (by mistake), the sniff should not throw a PHP Fatal error
+ *
+ * @param stdClass||null $object While invalid, this should not throw a PHP Fatal error.
+ * @return void
+ */
+function doublePipeFatalError(?stdClass $object) {}

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed

@@ -1046,3 +1046,11 @@ public function ignored() {
  * @return void
  * @throws Exception If any other error occurs. */
 function throwCommentOneLine() {}
+
+/**
+ * When two adjacent pipe symbols are used (by mistake), the sniff should not throw a PHP Fatal error
+ *
+ * @param stdClass|null $object While invalid, this should not throw a PHP Fatal error.
+ * @return void
+ */
+function doublePipeFatalError(?stdClass $object) {}

src/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.php

@@ -116,6 +116,7 @@ public function getErrorList()
             1004 => 2,
             1006 => 1,
             1029 => 1,
+            1053 => 1,
         ];
 
         // Scalar type hints only work from PHP 7 onwards.