Yiisoft\Validator\Rule\StopOnErrorHandler

Complexity

Total Complexity

8

Size/Duplication

Total Lines	39
Duplicated Lines	0 %

Test Coverage

Coverage

94.12%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	validate()	0	33	7
A	__construct()	0	2	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use InvalidArgumentException;
use Yiisoft\Validator\Exception\UnexpectedRuleException;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\RuleHandlerInterface;
use Yiisoft\Validator\ValidationContext;

/**
 * Can be used for early stopping the validation process of the value when the validation on the stage was failed.
 *
 * For example, we have several rules, but we want not to process the rest rules when fail was ocurred:
 *
 * ```php
 * $request = [
 *     'username' => 'yiisoft',
 * ];
 * ```
 *
 * So to make validation we can configure it like this:
 *
 * ```php
 * $rule = new StopOnError([
 *      new HasLength(min: 3),
 *      new ExistInDatabase(), // Heavy operation. It would be great not to call it if the previous rule was failed.
 *     )];
 * ]);
 * ```
 */
final class StopOnErrorHandler implements RuleHandlerInterface
{
    public function __construct()
    {
    }

    public function validate(mixed $value, object $rule, ValidationContext $context): Result
    {
        if (!$rule instanceof StopOnError) {
            throw new UnexpectedRuleException(StopOnError::class, $rule);
        }

        if ($rule->getRules() === []) {
            throw new InvalidArgumentException(
                'Rules for StopOnError rule are required.'
            );
        }

        $compoundResult = new Result();
        $validator = $context->getValidator();

        foreach ($rule->getRules() as $rule) {
            $rules = [$rule];

            if (is_iterable($rule)) {
                $rules = [new StopOnError($rule)];
            }

            $result = $validator->validate($value, $rules);
            foreach ($result->getErrors() as $error) {
                $compoundResult->addError($error->getMessage(), $error->getValuePath(), $error->getParameters());
            }

            if (!$result->isValid()) {
                break;
            }
        }

        return $compoundResult;
    }
}