Yiisoft\Validator\EmptyCriteria\WhenMissing

Complexity

Total Complexity

1

Size/Duplication

Total Lines	11
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	__invoke()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\EmptyCriteria;

/**
 * Empty criteria is a callable returning `true` if a value must be considered empty.
 *
 * With `WhenMissing` a rule is considered empty only when the value is missing. With regard to validation process, a
 * corresponding rule is skipped only if this condition is met and `WhenMissing` is set:
 *
 * - At a rule level via `$skipOnEmpty` property, but only for rules implementing {@see SkipOnEmptyTrait} / including
 * {@see SkipOnEmptyTrait}.
 * - At validator level ({@see Validator::$defaultSkipOnEmptyCriteria}).
 *
 * There is no shortcut for this criteria, because it's considered less used. Use new instance directly:
 * `new WhenMissing()`.
 */
final class WhenMissing
{
    /**
     * @param mixed $value The validated value.
     * @param bool $isAttributeMissing A flag defining whether the attribute is missing (not used / not passed at all).
     *
     * @return bool Whether the validated value is considered empty.
     */
    public function __invoke(mixed $value, bool $isAttributeMissing): bool
    {
        return $isAttributeMissing;
    }
}