ObjectOperatorIndentSniff.php

<?php


/**
 * \Drupal\Sniffs\WhiteSpace\ObjectOperatorIndentSniff.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
namespace Drupal\Sniffs\WhiteSpace;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Util\Tokens;

/**
 * \Drupal\Sniffs\WhiteSpace\ObjectOperatorIndentSniff.
 *
 * Checks that object operators are indented 2 spaces if they are the first
 * thing on a line.
 *
 * @category PHP
 * @package  PHP_CodeSniffer
 * @link     http://pear.php.net/package/PHP_CodeSniffer
 */
class ObjectOperatorIndentSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_OBJECT_OPERATOR,
        ];
    }
    
    //end register()
    
    /**
     * Processes this test, when one of its tokens is encountered.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile All the tokens found in the document.
     * @param int                         $stackPtr  The position of the current token
     *                                               in the stack passed in $tokens.
     *
     * @return void
     */
    public function process(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        // Check that there is only whitespace before the object operator and there
        // is nothing else on the line.
        if ($tokens[$stackPtr - 1]['code'] !== T_WHITESPACE || $tokens[$stackPtr - 1]['column'] !== 1) {
            return;
        }
        $previousLine = $phpcsFile->findPrevious(Tokens::$emptyTokens, $stackPtr - 2, null, true, null, true);
        if ($previousLine === false) {
            return;
        }
        // Check if the line before is in the same scope and go back if necessary.
        $scopeDiff = [
            $previousLine => $previousLine,
        ];
        $startOfLine = $stackPtr;
        while (empty($scopeDiff) === false) {
            // Find the first non whitespace character on the previous line.
            $startOfLine = $this->findStartOfline($phpcsFile, $previousLine);
            $startParenthesis = [];
            if (isset($tokens[$startOfLine]['nested_parenthesis']) === true) {
                $startParenthesis = $tokens[$startOfLine]['nested_parenthesis'];
            }
            $operatorParenthesis = [];
            if (isset($tokens[$stackPtr]['nested_parenthesis']) === true) {
                $operatorParenthesis = $tokens[$stackPtr]['nested_parenthesis'];
            }
            $scopeDiff = array_diff_assoc($startParenthesis, $operatorParenthesis);
            if (empty($scopeDiff) === false) {
                $previousLine = key($scopeDiff);
            }
        }
        // Closing parenthesis can be indented in several ways, so rather use the
        // line that opened the parenthesis.
        if ($tokens[$startOfLine]['code'] === T_CLOSE_PARENTHESIS) {
            $startOfLine = $this->findStartOfline($phpcsFile, $tokens[$startOfLine]['parenthesis_opener']);
        }
        if ($tokens[$startOfLine]['code'] === T_OBJECT_OPERATOR) {
            // If there is some wrapping in function calls then there should be an
            // additional level of indentation.
            if (isset($tokens[$stackPtr]['nested_parenthesis']) === true && (empty($tokens[$startOfLine]['nested_parenthesis']) === true || $tokens[$startOfLine]['nested_parenthesis'] !== $tokens[$stackPtr]['nested_parenthesis'])) {
                $additionalIndent = 2;
            }
            else {
                $additionalIndent = 0;
            }
        }
        else {
            $additionalIndent = 2;
        }
        if ($tokens[$stackPtr]['column'] !== $tokens[$startOfLine]['column'] + $additionalIndent) {
            $error = 'Object operator not indented correctly; expected %s spaces but found %s';
            $expectedIndent = $tokens[$startOfLine]['column'] + $additionalIndent - 1;
            $data = [
                $expectedIndent,
                $tokens[$stackPtr]['column'] - 1,
            ];
            $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Indent', $data);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->replaceToken($stackPtr - 1, str_repeat(' ', $expectedIndent));
            }
        }
    }
    
    //end process()
    
    /**
     * Returns the first non whitespace token on the line.
     *
     * @param \PHP_CodeSniffer\Files\File $phpcsFile All the tokens found in the document.
     * @param int                         $stackPtr  The position of the current token
     *                                               in the stack passed in $tokens.
     *
     * @return int
     */
    protected function findStartOfline(File $phpcsFile, $stackPtr) {
        $tokens = $phpcsFile->getTokens();
        // Find the first non whitespace character on the previous line.
        $startOfLine = $stackPtr;
        while ($tokens[$startOfLine - 1]['line'] === $tokens[$startOfLine]['line']) {
            $startOfLine--;
        }
        if ($tokens[$startOfLine]['code'] === T_WHITESPACE) {
            $startOfLine++;
        }
        return $startOfLine;
    }
    
    //end findStartOfline()

}

//end class