Source for file ClassDefinitionClosingBraceSpaceSniff.php
Documentation is available at ClassDefinitionClosingBraceSpaceSniff.php
* Ensure there is a single blank line after the closing brace of a class definition.
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600)
* @license https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
namespace PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Util\Tokens;
class ClassDefinitionClosingBraceSpaceSniff implements Sniff
* A list of tokenizers this sniff supports.
public $supportedTokenizers = array ('CSS');
* Returns the token types that this sniff is interested in.
public function register ()
* Processes the tokens that this sniff is interested in.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file where the token was found.
* @param int $stackPtr The position in the stack where
public function process (File $phpcsFile, $stackPtr)
$tokens = $phpcsFile->getTokens ();
$next = $phpcsFile->findNext (T_WHITESPACE , ($stackPtr + 1 ), null , true );
if ($tokens[$next]['code'] !== T_CLOSE_TAG ) {
$found = (($tokens[$next]['line'] - $tokens[$stackPtr]['line']) - 1 );
$error = 'Expected one blank line after closing brace of class definition; %s found';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'SpacingAfterClose', $data);
$phpcsFile->fixer ->addNewline ($stackPtr);
$nextContent = $phpcsFile->findNext (T_WHITESPACE , ($stackPtr + 1 ), null , true );
$phpcsFile->fixer ->beginChangeset ();
for ($i = ($stackPtr + 1 ); $i < ($nextContent - 1 ); $i++ ) {
$phpcsFile->fixer ->replaceToken ($i, '');
$phpcsFile->fixer ->addNewline ($i);
$phpcsFile->fixer ->endChangeset ();
// Ignore nested style definitions from here on. The spacing before the closing brace
// (a single blank line) will be enforced by the above check, which ensures there is a
// blank line after the last nested class.
$found = $phpcsFile->findPrevious (
$tokens[$stackPtr]['bracket_opener']
$prev = $phpcsFile->findPrevious (Tokens ::$emptyTokens, ($stackPtr - 1 ), null , true );
if ($tokens[$prev]['line'] === $tokens[$stackPtr]['line']) {
$error = 'Closing brace of class definition must be on new line';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'ContentBeforeClose');
$phpcsFile->fixer ->addNewlineBefore ($stackPtr);
Documentation generated on Mon, 11 Mar 2019 15:27:17 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|