class DisallowYodaComparisonSniff
Bigger value must be on the left side:
($variable, Foo::$class, Foo::bar(), foo()) > (Foo::BAR, BAR) > (true, false, null, 1, 1.0, arrays, 'foo')
Hierarchy
- class \SlevomatCodingStandard\Sniffs\ControlStructures\DisallowYodaComparisonSniff implements \PHP_CodeSniffer\Sniffs\Sniff
Expanded class hierarchy of DisallowYodaComparisonSniff
File
-
vendor/
slevomat/ coding-standard/ SlevomatCodingStandard/ Sniffs/ ControlStructures/ DisallowYodaComparisonSniff.php, line 24
Namespace
SlevomatCodingStandard\Sniffs\ControlStructuresView source
class DisallowYodaComparisonSniff implements Sniff {
public const CODE_DISALLOWED_YODA_COMPARISON = 'DisallowedYodaComparison';
/**
* @return array<int, (int|string)>
*/
public function register() : array {
return [
T_IS_IDENTICAL,
T_IS_NOT_IDENTICAL,
T_IS_EQUAL,
T_IS_NOT_EQUAL,
];
}
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $comparisonTokenPointer
*/
public function process(File $phpcsFile, $comparisonTokenPointer) : void {
$tokens = $phpcsFile->getTokens();
$leftSideTokens = YodaHelper::getLeftSideTokens($tokens, $comparisonTokenPointer);
$rightSideTokens = YodaHelper::getRightSideTokens($tokens, $comparisonTokenPointer);
$leftDynamism = YodaHelper::getDynamismForTokens($tokens, $leftSideTokens);
$rightDynamism = YodaHelper::getDynamismForTokens($tokens, $rightSideTokens);
if ($leftDynamism === null || $rightDynamism === null) {
return;
}
if ($leftDynamism >= $rightDynamism) {
return;
}
if ($leftDynamism >= 900 && $rightDynamism >= 900) {
return;
}
$errorParameters = [
'Yoda comparisons are disallowed.',
$comparisonTokenPointer,
self::CODE_DISALLOWED_YODA_COMPARISON,
];
$lastRightSideTokenPointer = array_keys($rightSideTokens)[count($rightSideTokens) - 1];
$nextPointer = TokenHelper::findNextEffective($phpcsFile, $lastRightSideTokenPointer + 1);
if ($tokens[$nextPointer]['code'] === T_EQUAL) {
$phpcsFile->addError(...$errorParameters);
return;
}
$fix = $phpcsFile->addFixableError(...$errorParameters);
if (!$fix) {
return;
}
YodaHelper::fix($phpcsFile, $leftSideTokens, $rightSideTokens);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
DisallowYodaComparisonSniff::CODE_DISALLOWED_YODA_COMPARISON | public | constant | ||
DisallowYodaComparisonSniff::process | public | function | * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * |
Overrides Sniff::process |
DisallowYodaComparisonSniff::register | public | function | * | Overrides Sniff::register |