Yiisoft\Validator\Rule\InRange

Complexity

Total Complexity

11

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	not()	0	5	1
A	validateValue()	0	22	6
A	__construct()	0	3	1
A	strict()	0	5	1
A	getName()	0	3	1
A	getOptions()	0	10	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Yiisoft\Validator\HasValidationErrorMessage;
use Yiisoft\Validator\Rule;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\DataSetInterface;

use function is_iterable;

/**
 * In validates that the attribute value is among a list of values.
 *
 * The range can be specified via the [[range]] property.
 * If the [[not]] property is set true, the validator will ensure the attribute value
 * is NOT among the specified range.
 *
 */
class InRange extends Rule
{
    use HasValidationErrorMessage;

    /**
     * @var iterable
     */
    private iterable $range;
    /**
     * @var bool whether the comparison is strict (both type and value must be the same)
     */
    private bool $strict = false;
    /**
     * @var bool whether to invert the validation logic. Defaults to false. If set to true,
     * the attribute value should NOT be among the list of values defined via [[range]].
     */
    private bool $not = false;

    private string $message = 'This value is invalid.';

    public function __construct(iterable $range)
    {
        $this->range = $range;
    }

    protected function validateValue($value, DataSetInterface $dataSet = null): Result
    {
        $in = false;

        if (
            (is_iterable($value)) &&
            ArrayHelper::isSubset($value, $this->range, $this->strict)
        ) {
            $in = true;
        }

        if (!$in && ArrayHelper::isIn($value, $this->range, $this->strict)) {
            $in = true;
        }

        $result = new Result();

        if ($this->not === $in) {
            $result->addError($this->translateMessage($this->message));
        }

        return $result;
    }

    public function strict(): self
    {
        $new = clone $this;
        $new->strict = true;
        return $new;
    }

    public function not(): self
    {
        $new = clone $this;
        $new->not = true;
        return $new;
    }

    public function getName(): string
    {
        return 'inRange';
    }

    public function getOptions(): array
    {
        return array_merge(
            [
                'message' => $this->translateMessage($this->message),
                'range' => $this->range,
                'strict' => $this->strict,
                'not' => $this->not,
            ],
            parent::getOptions()
        );
    }
}