ZenifyCodingStandard\Sniffs\ControlStructures\YodaConditionSniff

Complexity

Total Complexity

7

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

92.59%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	register()	0	13	1
A	process()	0	17	3
A	getPreviousNonEmptyToken()	0	10	2
A	isExpressionToken()	0	4	1

<?php

declare(strict_types = 1);

/*
 * This file is part of Zenify
 * Copyright (c) 2012 Tomas Votruba (http://tomasvotruba.cz)
 */

namespace ZenifyCodingStandard\Sniffs\ControlStructures;

use PHP_CodeSniffer_File;
use PHP_CodeSniffer_Sniff;


/**
 * Rules:
 * - Yoda condition should not be used; switch expression order
 */
final class YodaConditionSniff implements PHP_CodeSniffer_Sniff
{

	/**
	 * @var string
	 */
	const NAME = 'ZenifyCodingStandard.ControlStructures.YodaCondition';

	/**
	 * @var int
	 */
	private $position;

	/**
	 * @var PHP_CodeSniffer_File
	 */
	private $file;


	/**
	 * @return int[]
	 */
	public function register() : array
	{
		return [
			T_IS_IDENTICAL,
			T_IS_NOT_IDENTICAL,
			T_IS_EQUAL,
			T_IS_NOT_EQUAL,
			T_GREATER_THAN,
			T_LESS_THAN,
			T_IS_GREATER_OR_EQUAL,
			T_IS_SMALLER_OR_EQUAL
		];
	}


	/**
	 * @param PHP_CodeSniffer_File $file
	 * @param int $position
	 */
	public function process(PHP_CodeSniffer_File $file, $position)
	{
		$this->file = $file;
		$this->position = $position;

		$previousNonEmptyToken = $this->getPreviousNonEmptyToken();

		if ( ! $previousNonEmptyToken) {
			return;
		}

		if ( ! $this->isExpressionToken($previousNonEmptyToken)) {

It seems like $previousNonEmptyToken defined by $this->getPreviousNonEmptyToken() on line 66 can also be of type boolean; however, ZenifyCodingStandard\Sniffs\ControlStructures\YodaConditionSniff::isExpressionToken() does only seem to accept array, maybe add an additional type check?

			return;
		}

		$file->addError('Yoda condition should not be used; switch expression order', $position);
	}


	/**
	 * @return array|bool
	 */
	private function getPreviousNonEmptyToken()
	{
		$leftTokenPosition = $this->file->findPrevious(T_WHITESPACE, ($this->position - 1), NULL, TRUE);
		$tokens = $this->file->getTokens();
		if ($leftTokenPosition) {
			return $tokens[$leftTokenPosition];
		}

		return FALSE;
	}


	private function isExpressionToken(array $token) : bool
	{
		return in_array($token['code'], [T_MINUS, T_NULL, T_FALSE, T_TRUE, T_LNUMBER, T_CONSTANT_ENCAPSED_STRING]);
	}

}