rector/packages/NodeCollector/BinaryOpConditionsCollector.php

<?php

declare (strict_types=1);
namespace Rector\NodeCollector;

use PhpParser\Node\Expr;
use PhpParser\Node\Expr\BinaryOp;
/**
 * @see \Rector\Tests\NodeCollector\BinaryOpConditionsCollectorTest
 */
final class BinaryOpConditionsCollector
{
    /**
     * Collects operands of a sequence of applications of a given left-associative binary operation.
     *
     * For example, for `a + b + c`, which is parsed as `(Plus (Plus a b) c)`, it will return `[a, b, c]`.
     * Note that parenthesization not matching the associativity (e.g. `a + (b + c)`) will return the parenthesized
     * nodes as standalone operands (`[a, b + c]`) even for associative operations.
     * Similarly, for right-associative operations (e.g. `a ?? b ?? c`), the result produced by
     * the implicit parenthesization (`[a, b ?? c]`) might not match the expectations.
     *
     * @api
     * @param class-string<BinaryOp> $binaryOpClass
     * @return array<int, Expr>
     */
    public function findConditions(Expr $expr, string $binaryOpClass) : array
    {
        if (\get_class($expr) !== $binaryOpClass) {
            // Different binary operators, as well as non-BinaryOp expressions
            // are considered trivial case of a single operand (no operators).
            return [$expr];
        }
        $conditions = [];
        /** @var BinaryOp|Expr $expr */
        while ($expr instanceof BinaryOp) {
            $conditions[] = $expr->right;
            $expr = $expr->left;
            if ($binaryOpClass !== \get_class($expr)) {
                $conditions[] = $expr;
                break;
            }
        }
        \krsort($conditions);
        return $conditions;
    }
}