function MultiLineAssignmentSniff::process

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Formatting/MultiLineAssignmentSniff.php \Drupal\Sniffs\Formatting\MultiLineAssignmentSniff::process()

Processes this test, when one of its tokens is encountered.

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.:

int $stackPtr The position of the current token: in the stack passed in $tokens.

Return value

void

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/PEAR/Sniffs/Formatting/MultiLineAssignmentSniff.php, line 47

Class

MultiLineAssignmentSniff

Namespace

PHP_CodeSniffer\Standards\PEAR\Sniffs\Formatting

Code

public function process(File $phpcsFile, $stackPtr) {
    $tokens = $phpcsFile->getTokens();
    // Equal sign can't be the last thing on the line.
    $next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
    if ($next === false) {
        // Bad assignment.
        return;
    }
    if ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
        $error = 'Multi-line assignments must have the equal sign on the second line';
        $phpcsFile->addError($error, $stackPtr, 'EqualSignLine');
        return;
    }
    // Make sure it is the first thing on the line, otherwise we ignore it.
    $prev = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, false, true);
    if ($prev === false) {
        // Bad assignment.
        return;
    }
    if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
        return;
    }
    // Find the required indent based on the ident of the previous line.
    $assignmentIndent = 0;
    $prevLine = $tokens[$prev]['line'];
    for ($i = $prev - 1; $i >= 0; $i--) {
        if ($tokens[$i]['line'] !== $prevLine) {
            $i++;
            break;
        }
    }
    if ($tokens[$i]['code'] === T_WHITESPACE) {
        $assignmentIndent = $tokens[$i]['length'];
    }
    // Find the actual indent.
    $prev = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1);
    $expectedIndent = $assignmentIndent + $this->indent;
    $foundIndent = $tokens[$prev]['length'];
    if ($foundIndent !== $expectedIndent) {
        $error = 'Multi-line assignment not indented correctly; expected %s spaces but found %s';
        $data = [
            $expectedIndent,
            $foundIndent,
        ];
        $phpcsFile->addError($error, $stackPtr, 'Indent', $data);
    }
}