BestIt\Sniffs\Formatting\EqualOperatorSniff

Complexity

Total Complexity

6

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	findToken()	0	16	3
A	processToken()	0	4	1
A	register()	0	4	1
A	replaceToken()	0	6	1

<?php

declare(strict_types=1);

namespace BestIt\Sniffs\Formatting;

use BestIt\Sniffs\AbstractSniff;
use PHP_CodeSniffer\Files\File;

/**
 * Class EqualOperatorSniff.
 *
 * @author Mika Bertels <mika.bertels@bestit-online.de>
 * @package BestIt\Sniffs\Formatting
 */
class EqualOperatorSniff extends AbstractSniff
{
    /**
     * Code when an equal operator was found.
     *
     * @var CODE_EQUAL_OPERATOR_FOUND string
     */
    public const CODE_EQUAL_OPERATOR_FOUND = 'EqualOperatorFound';

    /**
     * Warning when an equal operator was found.
     *
     * @var WARNING_EQUAL_OPERATOR_FOUND string
     */
    public const WARNING_EQUAL_OPERATOR_FOUND = '
        An "Equal"-operator (==) was found. You should use the "Identical"-operator (===).
    ';

    /**
     * Find the T_IS_EQUAL token and add a warning.
     *
     * @param File $phpcsFile
     * @param int $stackPtr
     *
     * @return void
     */
    private function findToken(File $phpcsFile, int $stackPtr): void
    {
        $token = $phpcsFile->getTokens()[$stackPtr];

        if ($token['code'] === T_IS_EQUAL) {
            $isFixing = $phpcsFile->addFixableWarning(
                self::WARNING_EQUAL_OPERATOR_FOUND,
                $stackPtr,
                self::CODE_EQUAL_OPERATOR_FOUND
            );

            if ($isFixing) {
                $this->replaceToken($phpcsFile, $stackPtr);
            }
        }
    }

    /**
     * Processes the token.
     *
     * @param File $phpcsFile

There is no parameter named $phpcsFile. Was it maybe removed?

     * @param int $stackPtr

There is no parameter named $stackPtr. Was it maybe removed?

     *
     * @return void
     */
    protected function processToken(): void
    {
        $this->findToken($this->file, $this->stackPos);

It seems like $this->file can be null; however, findToken() does not accept null, maybe add an additional type check?

    }

    /**
     * Registers the tokens that this sniff wants to listen for.
     *
     * An example return value for a sniff that wants to listen for whitespace
     * and any comments would be:
     *
     * <code>
     *    return array(
     *            T_WHITESPACE,
     *            T_DOC_COMMENT,
     *            T_COMMENT,
     *           );
     * </code>
     *
     * @return int[]
     * @see    Tokens.php
     */
    public function register(): array
    {
        return [T_IS_EQUAL];
    }

    /**
     * Replace token with the T_IS_IDENTIAL token.
     *
     * @param File $phpcsFile
     * @param int $stackPtr
     *
     * @return void
     */
    private function replaceToken(File $phpcsFile, int $stackPtr): void
    {
        $phpcsFile->fixer->beginChangeset();
        $phpcsFile->fixer->replaceToken($stackPtr, '===');
        $phpcsFile->fixer->endChangeset();
    }
}