Yiisoft\Validator\Rule\Nested

Complexity

Total Complexity

26

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Test Coverage

Coverage

94.92%

Importance

Changes	9
Bugs	2	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	rule()	0	18	4
A	getOptions()	0	3	1
A	errorWhenPropertyPathIsNotFound()	0	5	1
A	propertyPathIsNotFoundMessage()	0	5	1
A	checkRules()	0	6	3
B	validateValue()	0	41	11
A	fetchOptions()	0	19	5

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use InvalidArgumentException;
use Traversable;
use Yiisoft\Arrays\ArrayHelper;
use Yiisoft\Validator\ParametrizedRuleInterface;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\RuleSet;
use Yiisoft\Validator\ValidationContext;
use function is_array;
use function is_object;

/**
 * Nested rule can be used for validation of nested structures.
 *
 * For example we have an inbound request with the following structure:
 *
 * ```php
 * $request = [
 *     'author' => [
 *         'name' => 'Dmitry',
 *         'age' => 18,
 *     ],
 * ];
 * ```
 *
 * So to make validation with Nested rule we can configure it like this:
 *
 * ```php
 * $rule = Nested::rule([
 *     'author' => Nested::rule([
 *         'name' => [HasLength::rule()->min(3)],
 *         'age' => [new Number(min: 18)],
 *     )];
 * ]);
 * ```
 */
final class Nested extends Rule
{
    /**
     * @var Rule[][]
     */
    private iterable $rules;

    private bool $errorWhenPropertyPathIsNotFound = false;
    private string $propertyPathIsNotFoundMessage = 'Property path "{path}" is not found.';

    public static function rule(iterable $rules): self
    {
        $rules = $rules instanceof Traversable ? iterator_to_array($rules) : $rules;
        if (empty($rules)) {
            throw new InvalidArgumentException('Rules should not be empty.');
        }

        $rule = new self();
        if ($rule->checkRules($rules)) {

It seems like $rules can also be of type iterable; however, parameter $rules of Yiisoft\Validator\Rule\Nested::checkRules() does only seem to accept array, maybe add an additional type check?

            throw new InvalidArgumentException(sprintf(
                'Each rule should be an instance of %s.',
                RuleInterface::class
            ));
        }

        $rule->rules = $rules;

It seems like $rules can also be of type iterable. However, the property $rules is declared as type array<mixed,Yiisoft\Validator\Rule[]>. Maybe add an additional type check?

        return $rule;
    }

    protected function validateValue($value, ?ValidationContext $context = null): Result
    {
        $result = new Result();
        if (!is_object($value) && !is_array($value)) {
            $result->addError(sprintf(
                'Value should be an array or an object. %s given.',
                gettype($value)
            ));

            return $result;
        }

        $value = (array) $value;

        foreach ($this->rules as $valuePath => $rules) {
            if ($this->errorWhenPropertyPathIsNotFound && !ArrayHelper::pathExists($value, $valuePath)) {
                $message = $this->formatMessage($this->propertyPathIsNotFoundMessage, ['path' => $valuePath]);
                $result->addError($message);

                continue;
            }

            $rules = is_array($rules) ? $rules : [$rules];
            $ruleSet = new RuleSet($rules);
            $validatedValue = ArrayHelper::getValueByPath($value, $valuePath);
            $itemResult = $ruleSet->validate($validatedValue);
            if ($itemResult->isValid()) {
                continue;
            }

            foreach ($itemResult->getErrors() as $error) {
                $errorValuePath = is_int($valuePath) ? [$valuePath] : explode('.', $valuePath);
                if ($error->getValuePath()) {
                    $errorValuePath = array_merge($errorValuePath, $error->getValuePath());
                }

                $result->addError($error->getMessage(), $errorValuePath);
            }
        }

        return $result;
    }

    /**
     * @param bool $value If absence of nested property should be considered an error. Default is `false`.
     *
     * @return self
     */
    public function errorWhenPropertyPathIsNotFound(bool $value): self
    {
        $new = clone $this;
        $new->errorWhenPropertyPathIsNotFound = $value;
        return $new;
    }

    /**
     * @param string $message A message to use when nested property is absent.
     *
     * @return $this
     */
    public function propertyPathIsNotFoundMessage(string $message): self
    {
        $new = clone $this;
        $new->propertyPathIsNotFoundMessage = $message;
        return $new;
    }

    public function getOptions(): array
    {
        return $this->fetchOptions($this->rules);

$this->rules of type iterable is incompatible with the type array expected by parameter $rules of Yiisoft\Validator\Rule\Nested::fetchOptions().

    }

    private function checkRules(array $rules): bool
    {
        return array_reduce(
            $rules,
            fn (bool $carry, $rule) => $carry || (is_array($rule) ? $this->checkRules($rule) : !$rule instanceof RuleInterface),
            false
        );
    }

    private function fetchOptions(array $rules): array
    {
        $result = [];
        foreach ($rules as $attribute => $rule) {
            if (is_array($rule)) {
                $result[$attribute] = $this->fetchOptions($rule);
            } elseif ($rule instanceof ParametrizedRuleInterface) {
                $result[$attribute] = $rule->getOptions();
            } elseif ($rule instanceof RuleInterface) {
                // Just skip the rule that doesn't support parametrizing
            } else {
                throw new \InvalidArgumentException(sprintf(
                    'Rules should be an array of rules that implements %s.',
                    ParametrizedRuleInterface::class,
                ));
            }
        }

        return $result;
    }
}