Improved fixer for when there are multiple blank lines after the open bracket

Author: gsherwood

package.xml

@@ -126,6 +126,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
     -- If you don't want this new behaviour, exclude the SpacingAfterReference error message in a ruleset.xml file
   - Squiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a variadic operator
     -- If you don't want this new behaviour, exclude the SpacingAfterVariadic error message in a ruleset.xml file
+  - Squiz.Functions.MultiLineFunctionDeclaration now has improved fixing for the FirstParamSpacing and UseFirstParamSpacing errors
   - Squiz.Operators.IncrementDecrementUsage now suggests pre-increment of variables instead of post-increment
     -- This change does not enforce pre-increment over post-increment; only the suggestion has changed
     -- Thanks to Juliette Reinders Folmer for the patch

src/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff.php

@@ -204,10 +204,25 @@ public function processBracket($phpcsFile, $openBracket, $tokens, $type='functio
                 $error = 'The first parameter of a multi-line '.$type.' declaration must be on the line after the opening bracket';
                 $fix   = $phpcsFile->addFixableError($error, $next, $errorPrefix.'FirstParamSpacing');
                 if ($fix === true) {
-                    $phpcsFile->fixer->addNewline($openBracket);
+                    if ($tokens[$next]['line'] === $tokens[$openBracket]['line']) {
+                        $phpcsFile->fixer->addNewline($openBracket);
+                    } else {
+                        $phpcsFile->fixer->beginChangeset();
+                        for ($x = $openBracket; $x < $next; $x++) {
+                            if ($tokens[$x]['line'] === $tokens[$openBracket]['line']) {
+                                continue;
+                            }
+
+                            if ($tokens[$x]['line'] === $tokens[$next]['line']) {
+                                break;
+                            }
+                        }
+
+                        $phpcsFile->fixer->endChangeset();
+                    }
                 }
-            }
-        }
+            }//end if
+        }//end if
 
         // Each line between the brackets should contain a single parameter.
         $lastComma = null;

src/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTest.inc

@@ -189,3 +189,11 @@ public function hello(string $greeting // cant fix this
 public function hello(string $greeting // phpcs:ignore Standard.Category.Sniff -- for reasons.
 ) {
 }
+
+function foo(
+
+
+    $foo,
+    $bar
+) {
+}

src/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTest.inc.fixed

@@ -203,3 +203,9 @@ public function hello(string $greeting // phpcs:ignore Standard.Category.Sniff -
 )
 {
 }
+
+function foo(
+    $foo,
+    $bar
+) {
+}

src/Standards/Squiz/Tests/Functions/MultiLineFunctionDeclarationUnitTest.php

@@ -53,6 +53,9 @@ public function getErrorList($testFile='MultiLineFunctionDeclarationUnitTest.inc
                 182 => 2,
                 186 => 2,
                 190 => 2,
+                194 => 1,
+                195 => 1,
+                196 => 1,
             ];
         } else {
             $errors = [