Yiisoft\Validator\Rule\Subset

Complexity

Total Complexity

6

Size/Duplication

Total Lines	54
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	strict()	0	5	1
A	validateValue()	0	16	3
A	__construct()	0	3	1
A	getOptions()	0	9	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;
use Yiisoft\Validator\ValidationContext;

class Subset extends Rule
{
    /**
     * @var iterable
     */
    private iterable $values;
    /**
     * @var bool whether the comparison is strict (both type and value must be the same)
     */
    private bool $strict = false;

    private string $iterableMessage = 'Value must be iterable';

    private string $subsetMessage = 'Values must be ones of {values}.';

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

    protected function validateValue($value, ValidationContext $context = null): Result
    {
        $result = new Result();

        if (!is_iterable($value)) {
            $result->addError($this->formatMessage($this->iterableMessage));
            return $result;
        }

        if (!ArrayHelper::isSubset($value, $this->values, $this->strict)) {
            $result->addError($this->formatMessage($this->subsetMessage, [
                'values' => '"' . implode('", "', iterator_to_array($this->values)) . '"',
            ]));
        }

        return $result;
    }

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

    public function getOptions(): array
    {
        return array_merge(
            parent::getOptions(),
            [
                'iterableMessage' => $this->formatMessage($this->iterableMessage),
                'subsetMessage' => $this->formatMessage($this->subsetMessage),
                'values' => $this->values,
                'strict' => $this->strict,
            ],
        );
    }
}