Yiisoft\Db\QueryBuilder\Condition\InCondition

Complexity

Total Complexity

16

Size/Duplication

Total Lines	69
Duplicated Lines	0 %

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getOperator()	0	3	1
A	getValues()	0	3	1
A	__construct()	0	5	1
A	getColumn()	0	3	1
A	validateColumn()	0	7	5
A	validateValues()	0	8	5
A	fromArrayDefinition()	0	10	2

<?php

declare(strict_types=1);

namespace Yiisoft\Db\QueryBuilder\Condition;

use Iterator;
use Yiisoft\Db\Exception\InvalidArgumentException;
use Yiisoft\Db\Expression\ExpressionInterface;
use Yiisoft\Db\QueryBuilder\Condition\Interface\InConditionInterface;
use Yiisoft\Db\Query\QueryInterface;

/**
 * Condition that represents `IN` operator.
 */
final class InCondition implements InConditionInterface
{
    public function __construct(
        private array|string|Iterator|ExpressionInterface $column,
        private string $operator,
        private int|iterable|Iterator|QueryInterface $values
    ) {
    }

    public function getColumn(): array|string|ExpressionInterface|Iterator
    {
        return $this->column;
    }

    public function getOperator(): string
    {
        return $this->operator;
    }

    public function getValues(): int|iterable|Iterator|QueryInterface
    {
        return $this->values;
    }

    /**
     * Creates a condition based on the given operator and operands.
     *
     * @throws InvalidArgumentException If the number of operands isn't 2.
     */
    public static function fromArrayDefinition(string $operator, array $operands): self
    {
        if (!isset($operands[0], $operands[1])) {
            throw new InvalidArgumentException("Operator '$operator' requires two operands.");
        }

        return new self(
            self::validateColumn($operator, $operands[0]),
            $operator,
            self::validateValues($operator, $operands[1]),
        );
    }

    /**
     * Validates the given column to be `string`, `array` or `ExpressionInterface`.
     *
     * @throws InvalidArgumentException If the column isn't a `string`, `array` or `ExpressionInterface`.
     */
    private static function validateColumn(string $operator, mixed $column): array|string|Iterator|ExpressionInterface
    {
        if (is_string($column) || is_array($column) || $column instanceof Iterator || $column instanceof ExpressionInterface) {
            return $column;
        }

        throw new InvalidArgumentException("Operator '$operator' requires column to be string, array or Iterator.");
    }

    /**
     * Validates the given values to be `array`, `Iterator`, `int` or `QueryInterface`.
     *
     * @throws InvalidArgumentException If the values aren't an `array`, `Iterator`, `int` or `QueryInterface`.
     */
    private static function validateValues(string $operator, mixed $values): int|iterable|Iterator|QueryInterface
    {
        if (is_array($values) || $values instanceof Iterator || is_int($values) || $values instanceof QueryInterface) {
            return $values;
        }

        throw new InvalidArgumentException(
            "Operator '$operator' requires values to be array, Iterator, int or QueryInterface."
        );
    }
}