Yiisoft\Validator\Rule\RequiredHandler

Complexity

Total Complexity

5

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	validate()	0	22	4
A	__construct()	0	4	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Yiisoft\Validator\EmptyCondition\WhenEmpty;
use Yiisoft\Validator\Exception\UnexpectedRuleException;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\RuleHandlerInterface;
use Yiisoft\Validator\RuleHandlerResolver\SimpleRuleHandlerContainer;
use Yiisoft\Validator\ValidationContext;

/**
 * A handler for {@see Required} rule. Validates that the specified value is passed and is not empty.
 *
 * @psalm-import-type EmptyConditionType from Required
 */
final class RequiredHandler implements RuleHandlerInterface
{
    /**
     * @var callable An empty condition (either a callable or class implementing `__invoke()` method) used to
     * determine emptiness of the value. The signature must be like the following:
     *
     * ```php
     * function (mixed $value, bool $isAttributeMissing): bool
     * ```
     *
     * `$isAttributeMissing` is a flag defining whether the attribute is missing (not used / not passed at all).
     *
     * Used as a default when {@see Required::$emptyCondition} is not set. A customized handler can be added to
     * {@see SimpleRuleHandlerContainer::$instances} to be applied to all rules of this type without explicitly
     * specifying empty condition for each one of them.
     *
     * @psalm-var EmptyConditionType
     */
    private $defaultEmptyCondition;

    /**
     * @param callable|null $defaultEmptyCondition A default empty condition used to determine emptiness of the value.
     *
     * @psalm-param EmptyConditionType|null $defaultEmptyCondition
     */
    public function __construct(
        callable|null $defaultEmptyCondition = null,
    ) {
        $this->defaultEmptyCondition = $defaultEmptyCondition ?? new WhenEmpty(trimString: true);
    }

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

        $result = new Result();
        if ($context->isAttributeMissing()) {
            $result->addError($rule->getNotPassedMessage(), ['attribute' => $context->getTranslatedAttribute()]);

            return $result;
        }

        $emptyCondition = $rule->getEmptyCondition() ?? $this->defaultEmptyCondition;

        if (!$emptyCondition($value, $context->isAttributeMissing())) {
            return $result;
        }

        $result->addError($rule->getMessage(), ['attribute' => $context->getTranslatedAttribute()]);

        return $result;
    }
}