Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. DisallowEqualOperatorsSniff.php

class DisallowEqualOperatorsSniff

Hierarchy

  • class \SlevomatCodingStandard\Sniffs\Operators\DisallowEqualOperatorsSniff implements \PHP_CodeSniffer\Sniffs\Sniff

Expanded class hierarchy of DisallowEqualOperatorsSniff

File

vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowEqualOperatorsSniff.php, line 11

Namespace

SlevomatCodingStandard\Sniffs\Operators
View source
class DisallowEqualOperatorsSniff implements Sniff {
    public const CODE_DISALLOWED_EQUAL_OPERATOR = 'DisallowedEqualOperator';
    public const CODE_DISALLOWED_NOT_EQUAL_OPERATOR = 'DisallowedNotEqualOperator';
    
    /**
     * @return array<int, (int|string)>
     */
    public function register() : array {
        return [
            T_IS_EQUAL,
            T_IS_NOT_EQUAL,
        ];
    }
    
    /**
     * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
     * @param int $operatorPointer
     */
    public function process(File $phpcsFile, $operatorPointer) : void {
        $tokens = $phpcsFile->getTokens();
        if ($tokens[$operatorPointer]['code'] === T_IS_EQUAL) {
            $fix = $phpcsFile->addFixableError('Operator == is disallowed, use === instead.', $operatorPointer, self::CODE_DISALLOWED_EQUAL_OPERATOR);
            if ($fix) {
                $phpcsFile->fixer
                    ->beginChangeset();
                $phpcsFile->fixer
                    ->replaceToken($operatorPointer, '===');
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
        else {
            $fix = $phpcsFile->addFixableError(sprintf('Operator %s is disallowed, use !== instead.', $tokens[$operatorPointer]['content']), $operatorPointer, self::CODE_DISALLOWED_NOT_EQUAL_OPERATOR);
            if ($fix) {
                $phpcsFile->fixer
                    ->beginChangeset();
                $phpcsFile->fixer
                    ->replaceToken($operatorPointer, '!==');
                $phpcsFile->fixer
                    ->endChangeset();
            }
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
DisallowEqualOperatorsSniff::CODE_DISALLOWED_EQUAL_OPERATOR public constant
DisallowEqualOperatorsSniff::CODE_DISALLOWED_NOT_EQUAL_OPERATOR public constant
DisallowEqualOperatorsSniff::process public function * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
*
Overrides Sniff::process
DisallowEqualOperatorsSniff::register public function * Overrides Sniff::register
RSS feed
Powered by Drupal