Merge pull request #609 from PHPCSStandards/feature/608-squiz-multilinefunctiondeclarations-bug-fix-param-attributes

Squiz/MultiLineFunctionDeclaration: bug fix - skip over attributes

Author: jrfnl

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

@@ -227,16 +227,21 @@ public function processBracket($phpcsFile, $openBracket, $tokens, $type='functio
         // Each line between the brackets should contain a single parameter.
         for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
             // Skip brackets, like arrays, as they can contain commas.
-            if (isset($tokens[$i]['bracket_opener']) === true) {
+            if (isset($tokens[$i]['bracket_closer']) === true) {
                 $i = $tokens[$i]['bracket_closer'];
                 continue;
             }
 
-            if (isset($tokens[$i]['parenthesis_opener']) === true) {
+            if (isset($tokens[$i]['parenthesis_closer']) === true) {
                 $i = $tokens[$i]['parenthesis_closer'];
                 continue;
             }
 
+            if (isset($tokens[$i]['attribute_closer']) === true) {
+                $i = $tokens[$i]['attribute_closer'];
+                continue;
+            }
+
             if ($tokens[$i]['code'] !== T_COMMA) {
                 continue;
             }

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

@@ -302,3 +302,55 @@ new ExceptionMessage(),
     ) {
     }
 }
+
+// Issue #608 - multi-attributes are not handled correctly.
+function ParamWithMultiAttributeOnSameLine(
+    #[AttributeA, AttributeB] string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnSameLineWithParamsShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA(10, 'test'), AttributeB([1, 2, 3,])] string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnSameLine(
+    #[AttributeA, AttributeB] string $paramA, int $paramB
+) {
+}
+
+function ParamWithMultiAttributeOnSameLineWithParamsShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA(10, 'test'), AttributeB([1, 2, 3,])] string $param, int $paramB
+) {
+}
+
+function ParamWithAttributeOnOwnLineShouldNotBeSeenAsMultipleFnParams(
+    #[Attribute]
+    string $param,
+) {
+}
+
+function ParamWithMultipleAttributesOnOwnLineShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA]
+    #[AttributeB]
+    string $param,
+) {
+}
+
+function ParamWithAttributeOnOwnLineWithParamsShouldNotBeSeenAsMultipleFnParamse(
+    #[Attribute(10, 20)]
+    string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnOwnLineShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA, AttributeB]
+    string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnOwnLineWithParamsShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA(10, 'test'), AttributeB([1, 2, 3,])]
+    string $param,
+) {
+}

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

@@ -314,3 +314,57 @@ new ExceptionMessage(),
     ) {
     }
 }
+
+// Issue #608 - multi-attributes are not handled correctly.
+function ParamWithMultiAttributeOnSameLine(
+    #[AttributeA, AttributeB] string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnSameLineWithParamsShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA(10, 'test'), AttributeB([1, 2, 3,])] string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnSameLine(
+    #[AttributeA, AttributeB] string $paramA,
+    int $paramB
+) {
+}
+
+function ParamWithMultiAttributeOnSameLineWithParamsShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA(10, 'test'), AttributeB([1, 2, 3,])] string $param,
+    int $paramB
+) {
+}
+
+function ParamWithAttributeOnOwnLineShouldNotBeSeenAsMultipleFnParams(
+    #[Attribute]
+    string $param,
+) {
+}
+
+function ParamWithMultipleAttributesOnOwnLineShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA]
+    #[AttributeB]
+    string $param,
+) {
+}
+
+function ParamWithAttributeOnOwnLineWithParamsShouldNotBeSeenAsMultipleFnParamse(
+    #[Attribute(10, 20)]
+    string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnOwnLineShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA, AttributeB]
+    string $param,
+) {
+}
+
+function ParamWithMultiAttributeOnOwnLineWithParamsShouldNotBeSeenAsMultipleFnParams(
+    #[AttributeA(10, 'test'), AttributeB([1, 2, 3,])]
+    string $param,
+) {
+}

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

@@ -75,6 +75,8 @@ public function getErrorList($testFile='')
                 252 => 1,
                 253 => 1,
                 254 => 1,
+                318 => 1,
+                323 => 1,
             ];
         } else {
             $errors = [