Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. EndFileNoNewlineSniff.php

class EndFileNoNewlineSniff

Hierarchy

  • class \PHP_CodeSniffer\Standards\Generic\Sniffs\Files\EndFileNoNewlineSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of EndFileNoNewlineSniff

File

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

Namespace

PHP_CodeSniffer\Standards\Generic\Sniffs\Files
View source
class EndFileNoNewlineSniff implements Sniff {
    
    /**
     * A list of tokenizers this sniff supports.
     *
     * @var array
     */
    public $supportedTokenizers = [
        'PHP',
        'JS',
        'CSS',
    ];
    
    /**
     * 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) {
        // 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;
    }
    
    //end process()

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
EndFileNoNewlineSniff::$supportedTokenizers public property A list of tokenizers this sniff supports.
EndFileNoNewlineSniff::process public function Processes this sniff, when one of its tokens is encountered. Overrides Sniff::process
EndFileNoNewlineSniff::register public function Returns an array of tokens this test wants to listen for. Overrides Sniff::register
RSS feed
Powered by Drupal