0 follower

Final Class Yiisoft\Validator\Rule\InEnum

All Classes | Methods

Inheritance	Yiisoft\Validator\Rule\InEnum
Implements	Yiisoft\Validator\DumpedRuleInterface, Yiisoft\Validator\SkipOnEmptyInterface, Yiisoft\Validator\SkipOnErrorInterface, Yiisoft\Validator\WhenInterface
Uses Traits	Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait, Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait, Yiisoft\Validator\Rule\Trait\WhenTrait

Defines validation options to check that the value is one of the values (or names) contained in an enum of the specified class.

If the \Yiisoft\Validator\Rule\In::$not is set, the validation logic is inverted and the rule will ensure that the value is NOT one of them.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Validator\Rule\InEnum
getHandler()		Yiisoft\Validator\Rule\InEnum
getMessage()	Get error message when the value is not in a set of $values.	Yiisoft\Validator\Rule\InEnum
getName()		Yiisoft\Validator\Rule\InEnum
getOptions()		Yiisoft\Validator\Rule\InEnum
getSkipOnEmpty()	A getter for `$skipOnEmpty` property.	Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
getValues()	Get a set of values to check against.	Yiisoft\Validator\Rule\InEnum
getWhen()	A getter for `$when` property.	Yiisoft\Validator\Rule\Trait\WhenTrait
isNot()	Whether to invert the validation logic. Defaults to `false`. If set to `true`, the value must NOT be among the list of $values.	Yiisoft\Validator\Rule\InEnum
isStrict()	Whether the comparison is strict (both type and value must be the same).	Yiisoft\Validator\Rule\InEnum
shouldSkipOnError()	A getter for `$skipOnError` property.	Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait
skipOnEmpty()	An immutable setter to change `$skipOnEmpty` property.	Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
skipOnError()	An immutable setter to change `$skipOnError` property.	Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait
when()	An immutable setter to change `$when` property.	Yiisoft\Validator\Rule\Trait\WhenTrait

Method Details

Hide inherited methods

__construct() public method

public __construct( string $class, boolean $useNames = false, boolean $strict = false, boolean $not = false, string $message = '{Property} is not in the list of acceptable values.', boolean\|callable\|null $skipOnEmpty = null, boolean $skipOnError = false, Closure\|null $when = null ): mixed
$class	string	Class of the enum to user.
$useNames	boolean	Whether to use names for backed enums instead of value.
$strict	boolean	Whether the comparison to each value in the set is strict: Strict mode meaning the type and the value must both match. Non-strict mode meaning that type juggling is performed first before the comparison. You can read more in the PHP docs: https://www.php.net/manual/en/language.operators.comparison.php https://www.php.net/manual/en/types.comparisons.php https://www.php.net/manual/en/language.types.type-juggling.php Defaults to `false` meaning non-strict mode is used.
$not	boolean	Whether to invert the validation logic. Defaults to `false`. If set to `true`, the value must NOT be among the list of $values.
$message	string	Error message when the value is not in a set of value. You may use the following placeholders in the message: `{property}`: the name of the attribute. `{Property}`: the capitalized name of the attribute.
$skipOnEmpty	boolean\|callable\|null	Whether to skip this rule if the value validated is empty. See Yiisoft\Validator\SkipOnEmptyInterface.
$skipOnError	boolean	Whether to skip this rule if any of the previous rules gave an error. See Yiisoft\Validator\SkipOnErrorInterface.
$when	Closure\|null	A callable to define a condition for applying the rule. See Yiisoft\Validator\WhenInterface.

Source code

                public function __construct(
    private string $class,
    private bool $useNames = false,
    private bool $strict = false,
    private bool $not = false,
    private string $message = '{Property} is not in the list of acceptable values.',
    bool|callable|null $skipOnEmpty = null,
    private bool $skipOnError = false,
    private ?Closure $when = null,
) {
    $this->skipOnEmpty = $skipOnEmpty;
    if (!is_subclass_of($this->class, UnitEnum::class)) {
        throw new InvalidArgumentException(
            sprintf('Class should be an enum class string, %s provided.', get_debug_type($this->class)),
        );
    }
}

getHandler() public method

public getHandler( ): string

Source code

                public function getHandler(): string
{
    return InEnumHandler::class;
}

getMessage() public method

Get error message when the value is not in a set of $values.

public getMessage( ): string
return	string	Error message.

Source code

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

getName() public method

public getName( ): string

Source code

                public function getName(): string
{
    return 'inEnum';
}

getOptions() public method

public getOptions( ): array

Source code

                public function getOptions(): array
{
    return [
        'values' => $this->getValues(),
        'strict' => $this->strict,
        'not' => $this->not,
        'message' => [
            'template' => $this->message,
            'parameters' => [],
        ],
        'skipOnEmpty' => $this->getSkipOnEmptyOption(),
        'skipOnError' => $this->skipOnError,
    ];
}

getSkipOnEmpty() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait::getSkipOnEmpty()

A getter for $skipOnEmpty property.

public getSkipOnEmpty( ): boolean\|callable\|null
return	boolean\|callable\|null	A current raw (non-normalized) value.

Source code

                public function getSkipOnEmpty(): bool|callable|null
{
    return $this->skipOnEmpty;
}

getValues() public method

Get a set of values to check against.

public getValues( ): array
return	array	A set of values.

Source code

                public function getValues(): array
{
    if (is_subclass_of($this->class, BackedEnum::class) && !$this->useNames) {
        return array_column($this->class::cases(), 'value');
    }
    /**
     * @psalm-suppress InvalidStringClass
     * @psalm-var array<array-key, mixed> $cases
     */
    $cases = $this->class::cases();
    return array_column($cases, 'name');
}

getWhen() public method

Defined in: Yiisoft\Validator\Rule\Trait\WhenTrait::getWhen()

A getter for $when property.

public getWhen( ): Closure\|null
return	Closure\|null	Current value: `null` - always apply the validation. `callable` - apply the validation depending on a return value: `true` - apply, `false` - do not apply.

Source code

                public function getWhen(): ?Closure
{
    return $this->when;
}

isNot() public method

Whether to invert the validation logic. Defaults to false. If set to true, the value must NOT be among the list of $values.

public isNot( ): boolean
return	boolean	Whether to invert the validation logic.

Source code

                public function isNot(): bool
{
    return $this->not;
}

isStrict() public method

Whether the comparison is strict (both type and value must be the same).

public isStrict( ): boolean
return	boolean	Whether the comparison is strict.

Source code

                public function isStrict(): bool
{
    return $this->strict;
}

shouldSkipOnError() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait::shouldSkipOnError()

A getter for $skipOnError property.

public shouldSkipOnError( ): boolean
return	boolean	Current value. `true` means to skip the current rule when the previous one errored and `false` - do not skip.

Source code

                public function shouldSkipOnError(): bool
{
    return $this->skipOnError;
}

skipOnEmpty() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait::skipOnEmpty()

An immutable setter to change $skipOnEmpty property.

public skipOnEmpty( boolean\|callable\|null $value ): $this
$value	boolean\|callable\|null	A new value.
return	$this	The new instance with a changed value.

Source code

                public function skipOnEmpty(bool|callable|null $value): static
{
    $new = clone $this;
    $new->skipOnEmpty = $value;
    return $new;
}

skipOnError() public method

Defined in: Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait::skipOnError()

An immutable setter to change $skipOnError property.

public skipOnError( boolean $value ): $this
$value	boolean	A new value. `true` means to skip the current rule when the previous one errored and `false` - do not skip.
return	$this	The new instance with a changed value.

Source code

                public function skipOnError(bool $value): static
{
    $new = clone $this;
    $new->skipOnError = $value;
    return $new;
}

when() public method

Defined in: Yiisoft\Validator\Rule\Trait\WhenTrait::when()

An immutable setter to change $when property.

public when( Closure\|null $value ): $this
$value	Closure\|null	A new value: `null` - always apply the validation. `callable` - apply the validation depending on a return value: `true` - apply, `false` - do not apply.
return	$this	The new instance with a changed value.

Source code

                public function when(?Closure $value): static
{
    $new = clone $this;
    $new->when = $value;
    return $new;
}