Yiisoft\Data\Reader\Iterable\FilterHandler\Compare

Complexity

Total Complexity

2

Size/Duplication

Total Lines	23
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	match()	0	11	2

<?php

declare(strict_types=1);

namespace Yiisoft\Data\Reader\Iterable\FilterHandler;

use InvalidArgumentException;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Data\Reader\FilterAssert;
use Yiisoft\Data\Reader\Iterable\IterableFilterHandlerInterface;

use function count;

/**
 * Abstract `Compare` iterable filter handler compares item's field value with a given value.
 * The actual comparison is defined in {@see compare()} method implemented in child classes.
 */
abstract class Compare implements IterableFilterHandlerInterface
{
    /**
     * Compare item's field value with a given value.
     *
     * @param mixed $itemValue Value of the item to compare.
     * @param mixed $argumentValue Value to compare with.
     *
     * @return bool If the comparison is true.
     */
    abstract protected function compare(mixed $itemValue, mixed $argumentValue): bool;

    public function match(array|object $item, array $arguments, array $iterableFilterHandlers): bool
    {
        if (count($arguments) !== 2) {
            throw new InvalidArgumentException('$arguments should contain exactly two elements.');
        }

        [$field, $value] = $arguments;
        FilterAssert::fieldIsString($field);

        /** @var string $field */
        return $this->compare(ArrayHelper::getValue($item, $field), $value);
    }
}