Yiisoft\Validator\Rule\Each

Complexity

Total Complexity

11

Size/Duplication

Total Lines	103
Duplicated Lines	0 %

Test Coverage

Coverage

96.15%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	propagateOptions()	0	10	3
A	getOptions()	0	28	3
A	getRules()	0	3	1
A	__construct()	0	18	1
A	getHandlerClassName()	0	3	1
A	getMessage()	0	3	1
A	getIncorrectInputMessage()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Attribute;
use Closure;
use JetBrains\PhpStorm\ArrayShape;
use Yiisoft\Validator\BeforeValidationInterface;
use Yiisoft\Validator\PropagateOptionsInterface;
use Yiisoft\Validator\Rule\Trait\BeforeValidationTrait;
use Yiisoft\Validator\Rule\Trait\RuleNameTrait;
use Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait;
use Yiisoft\Validator\RuleInterface;
use Yiisoft\Validator\SerializableRuleInterface;
use Yiisoft\Validator\SkipOnEmptyInterface;
use Yiisoft\Validator\ValidationContext;

/**
 * Validates an array by checking each of its elements against a set of rules.
 */
#[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
final class Each implements
    SerializableRuleInterface,
    BeforeValidationInterface,
    SkipOnEmptyInterface,
    PropagateOptionsInterface
{
    use BeforeValidationTrait;
    use RuleNameTrait;
    use SkipOnEmptyTrait;

    public function __construct(
        /**
         * @var iterable<RuleInterface>
         */
        private iterable $rules = [],
        private string $incorrectInputMessage = 'Value must be array or iterable.',
        private string $message = '{error} {value} given.',

        /**
         * @var bool|callable|null
         */
        private $skipOnEmpty = null,
        private bool $skipOnError = false,
        /**
         * @var Closure(mixed, ValidationContext):bool|null
         */
        private ?Closure $when = null,
    ) {
    }

    public function propagateOptions(): void
    {
        foreach ($this->rules as $index => $rule) {
            $rule = $rule->skipOnEmpty($this->skipOnEmpty);
            $rule = $rule->skipOnError($this->skipOnError);

            $this->rules[$index] = $rule;

            if ($rule instanceof PropagateOptionsInterface) {
                $rule->propagateOptions();
            }
        }
    }

    /**
     * @return iterable<\Closure|\Closure[]|RuleInterface|RuleInterface[]>
     */
    public function getRules(): iterable
    {
        return $this->rules;
    }

    /**
     * @return string
     */
    public function getIncorrectInputMessage(): string
    {
        return $this->incorrectInputMessage;
    }

    /**
     * @return string
     */
    public function getMessage(): string
    {
        return $this->message;
    }

    #[ArrayShape([
        'incorrectInputMessage' => 'array',
        'message' => 'array',
        'skipOnEmpty' => 'bool',
        'skipOnError' => 'bool',
        'rules' => 'array',
    ])]
    public function getOptions(): array
    {
        $arrayOfRules = [];
        foreach ($this->rules as $rule) {
            if ($rule instanceof SerializableRuleInterface) {
                $arrayOfRules[] = array_merge([$rule->getName()], $rule->getOptions());
            } else {
                $arrayOfRules[] = [$rule->getName()];
            }
        }

        return [
            'incorrectInputMessage' => [
                'message' => $this->getIncorrectInputMessage(),
            ],
            'message' => [
                'message' => $this->getMessage(),
            ],
            'skipOnEmpty' => $this->getSkipOnEmptyOption(),
            'skipOnError' => $this->skipOnError,
            'rules' => $arrayOfRules,
        ];
    }

    public function getHandlerClassName(): string
    {
        return EachHandler::class;
    }
}