function EndFileNoNewlineSniff::process

Processes this sniff, 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

int

Overrides Sniff::process

File

vendor/squizlabs/php_codesniffer/src/Standards/Generic/Sniffs/Files/EndFileNoNewlineSniff.php, line 54

Class

EndFileNoNewlineSniff

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Files

Code

public function process(File $phpcsFile, $stackPtr) {
    // Skip to the end of the file.
    $tokens = $phpcsFile->getTokens();
    $stackPtr = $phpcsFile->numTokens - 1;
    if ($tokens[$stackPtr]['content'] === '') {
        --$stackPtr;
    }
    $eolCharLen = strlen($phpcsFile->eolChar);
    $lastChars = substr($tokens[$stackPtr]['content'], $eolCharLen * -1);
    if ($lastChars === $phpcsFile->eolChar) {
        $error = 'File must not end with a newline character';
        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'Found');
        if ($fix === true) {
            $phpcsFile->fixer
                ->beginChangeset();
            for ($i = $stackPtr; $i > 0; $i--) {
                $newContent = rtrim($tokens[$i]['content'], $phpcsFile->eolChar);
                $phpcsFile->fixer
                    ->replaceToken($i, $newContent);
                if ($newContent !== '') {
                    break;
                }
            }
            $phpcsFile->fixer
                ->endChangeset();
        }
    }
    // Ignore the rest of the file.
    return $phpcsFile->numTokens;
}