Yiisoft\Data\Reader\Filter\In

Complexity

Total Complexity

5

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	16	3
A	getValues()	0	3	1
A	getField()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Data\Reader\Filter;

use InvalidArgumentException;
use Yiisoft\Data\Reader\FilterInterface;

/**
 * `In` filter defines a criteria for ensuring field value matches one of the value provided.
 */
final class In implements FilterInterface
{
    /**
     * @var bool[]|float[]|int[]|string[] Values to check against.
     */
    private array $values;

    /**
     * @param string $field Name of the field to compare.
     * @param bool[]|float[]|int[]|string[] $values Values to check against.
     */
    public function __construct(
        private readonly string $field,
        array $values
    ) {
        foreach ($values as $value) {
            /** @psalm-suppress DocblockTypeContradiction */
            if (!is_scalar($value)) {
                throw new InvalidArgumentException(
                    sprintf(
                        'The value should be scalar. "%s" is received.',
                        get_debug_type($value),
                    )
                );
            }
        }
        $this->values = $values;
    }

    public function getField(): string
    {
        return $this->field;
    }

    /**
     * @return bool[]|float[]|int[]|string[]
     */
    public function getValues(): array
    {
        return $this->values;
    }
}