Yiisoft\Validator\Rules

Complexity

Total Complexity

20

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Test Coverage

Coverage

88.89%

Importance

Changes	2
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	2
A	add()	0	7	3
A	addFormatterToRules()	0	5	3
A	asArray()	0	9	3
A	withFormatter()	0	6	1
A	normalizeRule()	0	15	3
A	validate()	0	17	5

<?php

declare(strict_types=1);

namespace Yiisoft\Validator;

use InvalidArgumentException;
use Yiisoft\Validator\Rule\Callback;
use function is_callable;

/**
 * Rules represents multiple rules for a single value
 */
final class Rules
{
    private ?FormatterInterface $formatter = null;

    /**
     * @var RuleInterface[]
     */
    private array $rules = [];

    public function __construct(iterable $rules = [])
    {
        foreach ($rules as $rule) {
            $this->add($rule);
        }
    }

    /**
     * @param callable|RuleInterface $rule
     */
    public function add($rule): void
    {
        $rule = $this->normalizeRule($rule);
        if ($this->formatter !== null && $rule instanceof FormattableRuleInterface) {
            $rule = $rule->withFormatter($this->formatter);
        }
        $this->rules[] = $rule;
    }

    public function validate($value, ValidationContext $context = null): Result
    {
        $context = $context ?? new ValidationContext();

        $compoundResult = new Result();
        foreach ($this->rules as $rule) {
            $ruleResult = $rule->validate($value, $context);
            if ($ruleResult->isValid() === false) {
                if (!$context->isPreviousRulesErrored()) {
                    $context = $context->withPreviousRulesErrored(true);
                }
                foreach ($ruleResult->getErrors() as $message) {
                    $compoundResult->addError($message);
                }
            }
        }
        return $compoundResult;
    }

    private function normalizeRule($rule): RuleInterface
    {
        if (is_callable($rule)) {
            $rule = new Callback($rule);
        }

        if (!$rule instanceof RuleInterface) {
            throw new InvalidArgumentException(sprintf(
                'Rule should be either an instance of %s or a callable, %s given.',
                RuleInterface::class,
                gettype($rule)
            ));
        }

        return $rule;
    }

    public function withFormatter(?FormatterInterface $formatter): self
    {
        $new = clone $this;
        $new->formatter = $formatter;
        $new->addFormatterToRules($formatter);
        return $new;
    }

    /**
     * Return rules as array.
     *
     * @return array
     */
    public function asArray(): array
    {
        $arrayOfRules = [];
        foreach ($this->rules as $rule) {
            if ($rule instanceof ParametrizedRuleInterface) {
                $arrayOfRules[] = array_merge([$rule->getName()], $rule->getOptions());
            }
        }
        return $arrayOfRules;
    }

    private function addFormatterToRules(?FormatterInterface $formatter): void
    {
        foreach ($this->rules as &$rule) {
            if ($rule instanceof FormattableRuleInterface) {
                $rule = $rule->withFormatter($formatter);
            }
        }
    }
}