function EndFileNewlineSniff::process

Same name in this branch

1. 11.1.x vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/Files/EndFileNewlineSniff.php \Drupal\Sniffs\Files\EndFileNewlineSniff::process()
2. 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/PSR2/Sniffs/Files/EndFileNewlineSniff.php \PHP_CodeSniffer\Standards\PSR2\Sniffs\Files\EndFileNewlineSniff::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/EndFileNewlineSniff.php, line 54

Class

EndFileNewlineSniff

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) {
        $phpcsFile->recordMetric($stackPtr, 'Newline at EOF', 'no');
        $error = 'File must end with a newline character';
        $fix = $phpcsFile->addFixableError($error, $stackPtr, 'NotFound');
        if ($fix === true) {
            $phpcsFile->fixer
                ->addNewline($stackPtr);
        }
    }
    else {
        $phpcsFile->recordMetric($stackPtr, 'Newline at EOF', 'yes');
    }
    // Ignore the rest of the file.
    return $phpcsFile->numTokens;
}