Fixed bug #813 : PEAR FunctionCallSignature checks wrong indent when first token on line is part of a multi-line string

Author: gsherwood

CodeSniffer/Standards/PEAR/Sniffs/Functions/FunctionCallSignatureSniff.php

@@ -292,29 +292,40 @@ public function processMultiLineCall(PHP_CodeSniffer_File $phpcsFile, $stackPtr,
         // We need to work out how far indented the function
         // call itself is, so we can work out how far to
         // indent the arguments.
-        for ($i = ($stackPtr - 1); $i >= 0; $i--) {
-            if ($tokens[$i]['line'] !== $tokens[$stackPtr]['line']) {
-                $i++;
-                break;
+        $start = $phpcsFile->findStartOfStatement($stackPtr);
+        foreach (array('stackPtr', 'start') as $checkToken) {
+            $x = $$checkToken;
+            for ($i = ($x - 1); $i >= 0; $i--) {
+                if ($tokens[$i]['line'] !== $tokens[$x]['line']) {
+                    $i++;
+                    break;
+                }
             }
-        }
 
-        if ($i <= 0) {
-            $functionIndent = 0;
-        } else if ($tokens[$i]['code'] === T_WHITESPACE) {
-            $functionIndent = strlen($tokens[$i]['content']);
-        } else {
-            $trimmed = ltrim($tokens[$i]['content']);
-            if ($trimmed === '') {
-                if ($tokens[$i]['code'] === T_INLINE_HTML) {
-                    $functionIndent = strlen($tokens[$i]['content']);
+            if ($i <= 0) {
+                $functionIndent = 0;
+            } else if ($tokens[$i]['code'] === T_WHITESPACE) {
+                $functionIndent = strlen($tokens[$i]['content']);
+            } else if ($tokens[$i]['code'] === T_CONSTANT_ENCAPSED_STRING) {
+                $functionIndent = 0;
+            } else {
+                $trimmed = ltrim($tokens[$i]['content']);
+                if ($trimmed === '') {
+                    if ($tokens[$i]['code'] === T_INLINE_HTML) {
+                        $functionIndent = strlen($tokens[$i]['content']);
+                    } else {
+                        $functionIndent = ($tokens[$i]['column'] - 1);
+                    }
                 } else {
-                    $functionIndent = ($tokens[$i]['column'] - 1);
+                    $functionIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
                 }
-            } else {
-                $functionIndent = (strlen($tokens[$i]['content']) - strlen($trimmed));
             }
-        }
+
+            $varName  = $checkToken.'Indent';
+            $$varName = $functionIndent;
+        }//end foreach
+
+        $functionIndent = max($startIndent, $stackPtrIndent);
 
         $next = $phpcsFile->findNext(PHP_CodeSniffer_Tokens::$emptyTokens, ($openBracket + 1), null, true);
         if ($tokens[$next]['line'] === $tokens[$openBracket]['line']) {

CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.inc

@@ -259,3 +259,19 @@ $this->log(// ...
         ]
     ); ?>
 </div>
+
+<?php
+if (true) {
+    $test = '
+   ' . function_0(
+        $argument_0
+    );
+}
+
+if (true) {
+    $test = '
+   ' . function_0(
+    $argument_0,
+           $argument_1
+    );
+}

CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.inc.fixed

@@ -264,3 +264,19 @@ $this->log(// ...
         ]
     ); ?>
 </div>
+
+<?php
+if (true) {
+    $test = '
+   ' . function_0(
+        $argument_0
+    );
+}
+
+if (true) {
+    $test = '
+   ' . function_0(
+        $argument_0,
+        $argument_1
+    );
+}

CodeSniffer/Standards/PEAR/Tests/Functions/FunctionCallSignatureUnitTest.php

@@ -98,6 +98,8 @@ public function getErrorList($testFile='FunctionCallSignatureUnitTest.inc')
                 194 => 1,
                 213 => 2,
                 215 => 2,
+                274 => 1,
+                275 => 1,
                );
 
     }//end getErrorList()

package.xml

@@ -49,6 +49,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
   - Fixed bug #807 : Cannot fix line endings when open PHP tag is not on the first line
   - Fixed bug #808 : JS tokeniser incorrectly setting some function and class names to control structure tokens
   - Fixed bug #809 : PHPCBF can break a require_once statement with a space before the open parenthesis
+  - Fixed bug #813 : PEAR FunctionCallSignature checks wrong indent when first token on line is part of a multi-line string
  </notes>
  <contents>
   <dir name="/">