Source for file ClassDefinitionOpeningBraceSpaceSniff.php
Documentation is available at ClassDefinitionOpeningBraceSpaceSniff.php
* Ensure a single space before, and a newline after, the class opening brace
* @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 ClassDefinitionOpeningBraceSpaceSniff 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 ();
if ($tokens[($stackPtr - 1 )]['code'] !== T_WHITESPACE ) {
$error = 'Expected 1 space before opening brace of class definition; 0 found';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'NoneBefore');
$phpcsFile->fixer ->addContentBefore ($stackPtr, ' ');
$content = $tokens[($stackPtr - 1 )]['content'];
if ($tokens[($stackPtr - 1 )]['line'] < $tokens[$stackPtr]['line']) {
$error = 'Expected 1 space before opening brace of class definition; %s found';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'Before', $data);
$phpcsFile->fixer ->replaceToken (($stackPtr - 1 ), ' ');
$next = $phpcsFile->findNext (Tokens ::$emptyTokens, ($stackPtr + 1 ), null , true );
// Check for nested class definitions.
$found = $phpcsFile->findNext (
$tokens[$stackPtr]['bracket_closer']
if ($tokens[$next]['line'] === $tokens[$stackPtr]['line']) {
$error = 'Opening brace should be the last content on the line';
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'ContentBefore');
$phpcsFile->fixer ->addNewline ($stackPtr);
$foundLines = ($tokens[$next]['line'] - $tokens[$stackPtr]['line'] - 1 );
$error = 'Expected 1 blank line after opening brace of nesting class definition; %s found';
$data = array ($foundLines);
$fix = $phpcsFile->addFixableError ($error, $stackPtr, 'AfterNesting', $data);
$phpcsFile->fixer ->addNewline ($stackPtr);
$next = $phpcsFile->findNext (T_WHITESPACE , ($stackPtr + 1 ), null , true );
$phpcsFile->fixer ->beginChangeset ();
for ($i = ($stackPtr + 1 ); $i < ($next + 1 ); $i++ ) {
$phpcsFile->fixer ->replaceToken ($i, '');
$phpcsFile->fixer ->addNewline ($stackPtr);
$phpcsFile->fixer ->endChangeset ();
Documentation generated on Mon, 11 Mar 2019 15:27:17 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|