class LogicalOperatorSpacingSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\LogicalOperatorSpacingSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of LogicalOperatorSpacingSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Squiz/ Sniffs/ WhiteSpace/ LogicalOperatorSpacingSniff.php, line 16
Namespace
PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpaceView source
class LogicalOperatorSpacingSniff implements Sniff {
/**
* A list of tokenizers this sniff supports.
*
* @var array
*/
public $supportedTokenizers = [
'PHP',
'JS',
];
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return Tokens::$booleanOperators;
}
//end register()
/**
* Processes this sniff, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being checked.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
*
* @return void
*/
public function process(File $phpcsFile, $stackPtr) {
$tokens = $phpcsFile->getTokens();
// Check there is one space before the operator.
if ($tokens[$stackPtr - 1]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space before logical operator; 0 found';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceBefore');
if ($fix === true) {
$phpcsFile->fixer
->addContentBefore($stackPtr, ' ');
}
}
else {
$prev = $phpcsFile->findPrevious(T_WHITESPACE, $stackPtr - 1, null, true);
if ($tokens[$stackPtr]['line'] === $tokens[$prev]['line'] && $tokens[$stackPtr - 1]['length'] !== 1) {
$found = $tokens[$stackPtr - 1]['length'];
$error = 'Expected 1 space before logical operator; %s found';
$data = [
$found,
];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpaceBefore', $data);
if ($fix === true) {
$phpcsFile->fixer
->replaceToken($stackPtr - 1, ' ');
}
}
}
// Check there is one space after the operator.
if ($tokens[$stackPtr + 1]['code'] !== T_WHITESPACE) {
$error = 'Expected 1 space after logical operator; 0 found';
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'NoSpaceAfter');
if ($fix === true) {
$phpcsFile->fixer
->addContent($stackPtr, ' ');
}
}
else {
$next = $phpcsFile->findNext(T_WHITESPACE, $stackPtr + 1, null, true);
if ($tokens[$stackPtr]['line'] === $tokens[$next]['line'] && $tokens[$stackPtr + 1]['length'] !== 1) {
$found = $tokens[$stackPtr + 1]['length'];
$error = 'Expected 1 space after logical operator; %s found';
$data = [
$found,
];
$fix = $phpcsFile->addFixableError($error, $stackPtr, 'TooMuchSpaceAfter', $data);
if ($fix === true) {
$phpcsFile->fixer
->replaceToken($stackPtr + 1, ' ');
}
}
}
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
LogicalOperatorSpacingSniff::$supportedTokenizers | public | property | A list of tokenizers this sniff supports. | |
LogicalOperatorSpacingSniff::process | public | function | Processes this sniff, when one of its tokens is encountered. | Overrides Sniff::process |
LogicalOperatorSpacingSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |