class SemicolonSpacingSniff
Same name in this branch
- 11.1.x vendor/squizlabs/php_codesniffer/src/Standards/Squiz/Sniffs/WhiteSpace/SemicolonSpacingSniff.php \PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\SemicolonSpacingSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Squiz\Sniffs\CSS\SemicolonSpacingSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of SemicolonSpacingSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Squiz/ Sniffs/ CSS/ SemicolonSpacingSniff.php, line 18
Namespace
PHP_CodeSniffer\Standards\Squiz\Sniffs\CSSView source
class SemicolonSpacingSniff implements Sniff {
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = [
'CSS',
];
/**
* Returns the token types that this sniff is interested in.
*
* @return array<int|string>
*/
public function register() {
return [
T_STYLE,
];
}
//end 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
* the token was found.
*
* @return void
*/
public function process(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
$nextStatement = $phpcsFile->findNext([
T_STYLE,
T_CLOSE_CURLY_BRACKET,
], $stackPtr + 1);
if ($nextStatement === false) {
return;
}
$ignore = Tokens::$emptyTokens;
if ($tokens[$nextStatement]['code'] === T_STYLE) {
// Allow for star-prefix hack.
$ignore[] = T_MULTIPLY;
}
$endOfThisStatement = $phpcsFile->findPrevious($ignore, $nextStatement - 1, null, true);
if ($tokens[$endOfThisStatement]['code'] !== T_SEMICOLON) {
$error = 'Style definitions must end with a semicolon';
$phpcsFile->addError($error, $endOfThisStatement, 'NotAtEnd');
return;
}
if ($tokens[$endOfThisStatement - 1]['code'] !== T_WHITESPACE) {
return;
}
// There is a semicolon, so now find the last token in the statement.
$prevNonEmpty = $phpcsFile->findPrevious(Tokens::$emptyTokens, $endOfThisStatement - 1, null, true);
$found = $tokens[$endOfThisStatement - 1]['length'];
if ($tokens[$prevNonEmpty]['line'] !== $tokens[$endOfThisStatement]['line']) {
$found = 'newline';
}
$error = 'Expected 0 spaces before semicolon in style definition; %s found';
$data = [
$found,
];
$fix = $phpcsFile->addFixableError($error, $prevNonEmpty, 'SpaceFound', $data);
if ($fix === true) {
$phpcsFile->fixer
->beginChangeset();
$phpcsFile->fixer
->addContent($prevNonEmpty, ';');
$phpcsFile->fixer
->replaceToken($endOfThisStatement, '');
for ($i = $endOfThisStatement - 1; $i > $prevNonEmpty; $i--) {
if ($tokens[$i]['code'] !== T_WHITESPACE) {
break;
}
$phpcsFile->fixer
->replaceToken($i, '');
}
$phpcsFile->fixer
->endChangeset();
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
SemicolonSpacingSniff::$supportedTokenizers | public | property | A list of tokenizers this sniff supports. | |
SemicolonSpacingSniff::process | public | function | Processes the tokens that this sniff is interested in. | Overrides Sniff::process |
SemicolonSpacingSniff::register | public | function | Returns the token types that this sniff is interested in. | Overrides Sniff::register |