EndFileNewlineSniff.php

<?php


/**
 * Ensures the file ends with a newline character.
 *
 * @author    Greg Sherwood <gsherwood@squiz.net>
 * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
 * @license   https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
 */
namespace PHP_CodeSniffer\Standards\PSR2\Sniffs\Files;

use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
class EndFileNewlineSniff implements Sniff {
    
    /**
     * Returns an array of tokens this test wants to listen for.
     *
     * @return array<int|string>
     */
    public function register() {
        return [
            T_OPEN_TAG,
            T_OPEN_TAG_WITH_ECHO,
        ];
    }
    
    //end register()
    
    /**
     * Processes this sniff, 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.
     *
     * @return int
     */
    public function process(File $phpcsFile, $stackPtr) {
        if ($phpcsFile->findNext(T_INLINE_HTML, $stackPtr + 1) !== false) {
            return $phpcsFile->numTokens;
        }
        // Skip to the end of the file.
        $tokens = $phpcsFile->getTokens();
        $lastToken = $phpcsFile->numTokens - 1;
        if ($tokens[$lastToken]['content'] === '') {
            $lastToken--;
        }
        // Hard-coding the expected \n in this sniff as it is PSR-2 specific and
        // PSR-2 enforces the use of unix style newlines.
        if (substr($tokens[$lastToken]['content'], -1) !== "\n") {
            $error = 'Expected 1 newline at end of file; 0 found';
            $fix = $phpcsFile->addFixableError($error, $lastToken, 'NoneFound');
            if ($fix === true) {
                $phpcsFile->fixer
                    ->addNewline($lastToken);
            }
            $phpcsFile->recordMetric($stackPtr, 'Number of newlines at EOF', '0');
            return $phpcsFile->numTokens;
        }
        // Go looking for the last non-empty line.
        $lastLine = $tokens[$lastToken]['line'];
        if ($tokens[$lastToken]['code'] === T_WHITESPACE || $tokens[$lastToken]['code'] === T_DOC_COMMENT_WHITESPACE) {
            $lastCode = $phpcsFile->findPrevious([
                T_WHITESPACE,
                T_DOC_COMMENT_WHITESPACE,
            ], $lastToken - 1, null, true);
        }
        else {
            $lastCode = $lastToken;
        }
        $lastCodeLine = $tokens[$lastCode]['line'];
        $blankLines = $lastLine - $lastCodeLine + 1;
        $phpcsFile->recordMetric($stackPtr, 'Number of newlines at EOF', $blankLines);
        if ($blankLines > 1) {
            $error = 'Expected 1 blank line at end of file; %s found';
            $data = [
                $blankLines,
            ];
            $fix = $phpcsFile->addFixableError($error, $lastCode, 'TooMany', $data);
            if ($fix === true) {
                $phpcsFile->fixer
                    ->beginChangeset();
                $phpcsFile->fixer
                    ->replaceToken($lastCode, rtrim($tokens[$lastCode]['content']));
                for ($i = $lastCode + 1; $i < $lastToken; $i++) {
                    $phpcsFile->fixer
                        ->replaceToken($i, '');
                }
                $phpcsFile->fixer
                    ->replaceToken($lastToken, $phpcsFile->eolChar);
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
        // Skip the rest of the file.
        return $phpcsFile->numTokens;
    }
    
    //end process()

}

//end class