function DisallowSpaceIndentSniff::process

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

Parameters

\PHP_CodeSniffer\Files\File $phpcsFile All the tokens found in the document.:

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

Return value

int

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/WhiteSpace/DisallowSpaceIndentSniff.php, line 61

Class

DisallowSpaceIndentSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace

Code

public function process(File $phpcsFile, $stackPtr) {
    $tabsReplaced = false;
    if ($this->tabWidth === null) {
        if (isset($phpcsFile->config->tabWidth) === false || $phpcsFile->config->tabWidth === 0) {
            // We have no idea how wide tabs are, so assume 4 spaces for fixing.
            // It shouldn't really matter because indent checks elsewhere in the
            // standard should fix things up.
            $this->tabWidth = 4;
        }
        else {
            $this->tabWidth = $phpcsFile->config->tabWidth;
            $tabsReplaced = true;
        }
    }
    $checkTokens = [
        T_WHITESPACE => true,
        T_INLINE_HTML => true,
        T_DOC_COMMENT_WHITESPACE => true,
        T_COMMENT => true,
        T_END_HEREDOC => true,
        T_END_NOWDOC => true,
    ];
    $eolLen = strlen($phpcsFile->eolChar);
    $tokens = $phpcsFile->getTokens();
    for ($i = 0; $i < $phpcsFile->numTokens; $i++) {
        if ($tokens[$i]['column'] !== 1 || isset($checkTokens[$tokens[$i]['code']]) === false) {
            continue;
        }
        // If the tokenizer hasn't replaced tabs with spaces, we need to do it manually.
        $token = $tokens[$i];
        if ($tabsReplaced === false) {
            $phpcsFile->tokenizer
                ->replaceTabsInToken($token, ' ', ' ', $this->tabWidth);
            if (strpos($token['content'], $phpcsFile->eolChar) !== false) {
                // Newline chars are not counted in the token length.
                $token['length'] -= $eolLen;
            }
        }
        if (isset($tokens[$i]['orig_content']) === true) {
            $content = $tokens[$i]['orig_content'];
        }
        else {
            $content = $tokens[$i]['content'];
        }
        $expectedIndentSize = $token['length'];
        $recordMetrics = true;
        // If this is an inline HTML token or a subsequent line of a multi-line comment,
        // split the content into indentation whitespace and the actual HTML/text.
        $nonWhitespace = '';
        if (($tokens[$i]['code'] === T_INLINE_HTML || $tokens[$i]['code'] === T_COMMENT) && preg_match('`^(\\s*)(\\S.*)`s', $content, $matches) > 0) {
            if (isset($matches[1]) === true) {
                $content = $matches[1];
                // Tabs are not replaced in content, so the "length" is wrong.
                $matches[1] = str_replace("\t", str_repeat(' ', $this->tabWidth), $matches[1]);
                $expectedIndentSize = strlen($matches[1]);
            }
            if (isset($matches[2]) === true) {
                $nonWhitespace = $matches[2];
            }
        }
        else {
            if (isset($tokens[$i + 1]) === true && $tokens[$i]['line'] < $tokens[$i + 1]['line']) {
                // There is no content after this whitespace except for a newline.
                $content = rtrim($content, "\r\n");
                $nonWhitespace = $phpcsFile->eolChar;
                // Don't record metrics for empty lines.
                $recordMetrics = false;
            }
        }
        
        //end if
        $foundSpaces = substr_count($content, ' ');
        $foundTabs = substr_count($content, "\t");
        if ($foundSpaces === 0 && $foundTabs === 0) {
            // Empty line.
            continue;
        }
        if ($foundSpaces === 0 && $foundTabs > 0) {
            // All ok, nothing to do.
            if ($recordMetrics === true) {
                $phpcsFile->recordMetric($i, 'Line indent', 'tabs');
            }
            continue;
        }
        if (($tokens[$i]['code'] === T_DOC_COMMENT_WHITESPACE || $tokens[$i]['code'] === T_COMMENT) && $content === ' ') {
            // Ignore all non-indented comments, especially for recording metrics.
            continue;
        }
        // OK, by now we know there will be spaces.
        // We just don't know yet whether they need to be replaced or
        // are precision indentation, nor whether they are correctly
        // placed at the end of the whitespace.
        $tabAfterSpaces = strpos($content, "\t", strpos($content, ' '));
        // Calculate the expected tabs and spaces.
        $expectedTabs = (int) floor($expectedIndentSize / $this->tabWidth);
        $expectedSpaces = $expectedIndentSize % $this->tabWidth;
        if ($foundTabs === 0) {
            if ($recordMetrics === true) {
                $phpcsFile->recordMetric($i, 'Line indent', 'spaces');
            }
            if ($foundTabs === $expectedTabs && $foundSpaces === $expectedSpaces) {
                // Ignore: precision indentation.
                continue;
            }
        }
        else {
            if ($foundTabs === $expectedTabs && $foundSpaces === $expectedSpaces) {
                // Precision indentation.
                if ($recordMetrics === true) {
                    if ($tabAfterSpaces !== false) {
                        $phpcsFile->recordMetric($i, 'Line indent', 'mixed');
                    }
                    else {
                        $phpcsFile->recordMetric($i, 'Line indent', 'tabs');
                    }
                }
                if ($tabAfterSpaces === false) {
                    // Ignore: precision indentation is already at the
                    // end of the whitespace.
                    continue;
                }
            }
            else {
                if ($recordMetrics === true) {
                    $phpcsFile->recordMetric($i, 'Line indent', 'mixed');
                }
            }
        }
        
        //end if
        $error = 'Tabs must be used to indent lines; spaces are not allowed';
        $errorCode = 'SpacesUsed';
        // Report, but don't auto-fix space identation for a PHP 7.3+ flexible heredoc/nowdoc closer.
        // Auto-fixing this would cause parse errors as the indentation of the heredoc/nowdoc contents
        // needs to use the same type of indentation. Also see: https://3v4l.org/7OF3M .
        if ($tokens[$i]['code'] === T_END_HEREDOC || $tokens[$i]['code'] === T_END_NOWDOC) {
            $phpcsFile->addError($error, $i, $errorCode . 'HeredocCloser');
            continue;
        }
        $fix = $phpcsFile->addFixableError($error, $i, $errorCode);
        if ($fix === true) {
            $padding = str_repeat("\t", $expectedTabs);
            $padding .= str_repeat(' ', $expectedSpaces);
            $phpcsFile->fixer
                ->replaceToken($i, $padding . $nonWhitespace);
        }
    }
    
    //end for
    // Ignore the rest of the file.
    return $phpcsFile->numTokens;
}