class ValidLogicalOperatorsSniff
Hierarchy
- class \PHP_CodeSniffer\Standards\Squiz\Sniffs\Operators\ValidLogicalOperatorsSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of ValidLogicalOperatorsSniff
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Standards/ Squiz/ Sniffs/ Operators/ ValidLogicalOperatorsSniff.php, line 15
Namespace
PHP_CodeSniffer\Standards\Squiz\Sniffs\OperatorsView source
class ValidLogicalOperatorsSniff implements Sniff {
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public function register() {
return [
T_LOGICAL_AND,
T_LOGICAL_OR,
];
}
//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being scanned.
* @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();
$replacements = [
'and' => '&&',
'or' => '||',
];
$operator = strtolower($tokens[$stackPtr]['content']);
if (isset($replacements[$operator]) === false) {
return;
}
$error = 'Logical operator "%s" is prohibited; use "%s" instead';
$data = [
$operator,
$replacements[$operator],
];
$phpcsFile->addError($error, $stackPtr, 'NotAllowed', $data);
}
//end process()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
ValidLogicalOperatorsSniff::process | public | function | Processes this test, when one of its tokens is encountered. | Overrides Sniff::process |
ValidLogicalOperatorsSniff::register | public | function | Returns an array of tokens this test wants to listen for. | Overrides Sniff::register |