PHPSA\Analyzer\Pass\Statement\YodaCondition

Complexity

Total Complexity

10

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	2

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
D	pass()	0	26	9
A	getRegister()	0	11	1

<?php
/**
 * @author Alexey Kolpakov https://github.com/alhimik45 <alhimik45@gmail.com>
 */

namespace PHPSA\Analyzer\Pass\Statement;

use PhpParser\Node\Expr;
use PhpParser\Node\Expr\BinaryOp\Equal;
use PhpParser\Node\Expr\BinaryOp\Identical;
use PhpParser\Node\Expr\BinaryOp\NotEqual;
use PhpParser\Node\Expr\BinaryOp\NotIdentical;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Scalar;
use PhpParser\Node\Stmt;
use PhpParser\Node\Stmt\Case_;
use PhpParser\Node\Stmt\Do_;
use PhpParser\Node\Stmt\ElseIf_;
use PhpParser\Node\Stmt\For_;
use PhpParser\Node\Stmt\If_;
use PhpParser\Node\Stmt\While_;
use PHPSA\Analyzer\Pass;
use PHPSA\Context;

class YodaCondition implements Pass\AnalyzerPassInterface
{
    /**
     * @param $stmt
     * @param Context $context
     * @return bool
     */
    public function pass($stmt, Context $context)
    {
        $condition = $stmt->cond;

        if ($stmt instanceof For_ && count($stmt->cond) > 0) { // For is the only one that has an array as condition
            $condition = $condition[0];
        }

        if ($condition instanceof Equal ||
            $condition instanceof NotEqual ||
            $condition instanceof Identical ||
            $condition instanceof NotIdentical
        ) {
            if ($condition->left instanceof Scalar &&
                $condition->right instanceof Variable) {
                $context->notice(
                    'yoda_condition',
                    'Avoid Yoda conditions, where constants are placed first in comparisons',
                    $stmt
                );
                return true;
            }
        }

        return false;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            If_::class,
            ElseIf_::class,
            For_::class,
            While_::class,
            Do_::class,
            Case_::class,
        ];
    }
}