Source for file MultiLineAssignmentSniff.php
Documentation is available at MultiLineAssignmentSniff.php
* If an assignment goes over two lines, ensure the equal sign is indented.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\PEAR\Sniffs\Formatting;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
class MultiLineAssignmentSniff implements Sniff
* The number of spaces code should be indented.
* Returns an array of tokens this test wants to listen for.
public function register ()
* Processes this test, when one of its tokens is encountered.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
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 ($tokens[$next]['line'] !== $tokens[$stackPtr]['line']) {
$error = 'Multi-line assignments must have the equal sign on the second line';
$phpcsFile->addError ($error, $stackPtr, 'EqualSignLine');
// Make sure it is the first thing on the line, otherwise we ignore it.
$prev = $phpcsFile->findPrevious (T_WHITESPACE , ($stackPtr - 1 ), false , true );
if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
// Find the required indent based on the ident of the previous line.
$prevLine = $tokens[$prev]['line'];
for ($i = ($prev - 1 ); $i >= 0; $i-- ) {
if ($tokens[$i]['line'] !== $prevLine) {
if ($tokens[$i]['code'] === T_WHITESPACE ) {
$assignmentIndent = strlen($tokens[$i]['content']);
// Find the actual indent.
$prev = $phpcsFile->findPrevious (T_WHITESPACE , ($stackPtr - 1 ));
$expectedIndent = ($assignmentIndent + $this->indent);
$foundIndent = strlen($tokens[$prev]['content']);
if ($foundIndent !== $expectedIndent) {
$error = 'Multi-line assignment not indented correctly; expected %s spaces but found %s';
$phpcsFile->addError ($error, $stackPtr, 'Indent', $data);
Documentation generated on Mon, 11 Mar 2019 15:27:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|