Yiisoft\Data\Reader\Filter\Compare

Complexity

Total Complexity

4

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	setValue()	0	4	1
A	withValue()	0	5	1
A	toCriteriaArray()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Data\Reader\Filter;

use DateTimeInterface;
use Yiisoft\Data\Reader\FilterAssert;
use Yiisoft\Data\Reader\FilterInterface;

/**
 * `Compare` filter is a base class that defines a criteria for comparing field value with a given value.
 * The operator is defined by child classes.
 */
abstract class Compare implements FilterInterface
{
    private bool|DateTimeInterface|float|int|string $value;

    /**
     * @param string $field Name of the field to compare.
     * @param bool|DateTimeInterface|float|int|string $value Value to compare to.
     */
    public function __construct(private string $field, mixed $value)
    {
        $this->setValue($value);
    }

    /**
     * @param bool|DateTimeInterface|float|int|string $value Value to compare to.
     */
    final public function withValue(mixed $value): static
    {
        $new = clone $this;
        $new->setValue($value);
        return $new;
    }

    public function toCriteriaArray(): array
    {
        return [static::getOperator(), $this->field, $this->value];
    }

    private function setValue(mixed $value): void
    {
        FilterAssert::isScalarOrInstanceOfDateTimeInterface($value);
        $this->value = $value;
    }
}