0 follower

Final Class Yiisoft\Validator\Rule\Uuid

All Classes | Methods
InheritanceYiisoft\Validator\Rule\Uuid
ImplementsYiisoft\Validator\DumpedRuleInterface, Yiisoft\Validator\SkipOnEmptyInterface, Yiisoft\Validator\SkipOnErrorInterface, Yiisoft\Validator\WhenInterface
Uses TraitsYiisoft\Validator\Rule\Trait\SkipOnEmptyTrait, Yiisoft\Validator\Rule\Trait\SkipOnErrorTrait, Yiisoft\Validator\Rule\Trait\WhenTrait

Checks if the value is a valid UUID.

See also Yiisoft\Validator\Rule\UuidHandler.

Public Methods

Hide inherited methods

Method Description Defined By
__construct() Yiisoft\Validator\Rule\Uuid
getHandler() Yiisoft\Validator\Rule\Uuid
getIncorrectInputMessage() Get a message used when the input it incorrect. Yiisoft\Validator\Rule\Uuid
getMessage() Get an error message used when validation fails due to the wrong UUID format. Yiisoft\Validator\Rule\Uuid
getName() Yiisoft\Validator\Rule\Uuid
getOptions() Yiisoft\Validator\Rule\Uuid
getSkipOnEmpty() A getter for $skipOnEmpty property. Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
getWhen() A getter for $when property. Yiisoft\Validator\Rule\Trait\WhenTrait
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 $incorrectInputMessage = '{Property} must be a string. {type} given.', string $message = 'The value of {property} is not a valid UUID.', boolean|callable|null $skipOnEmpty = null, boolean $skipOnError = false, Closure|null $when = null ): mixed
$incorrectInputMessage string

A message used when the input is incorrect.
$message string

Error message used when validation fails due to the wrong UUID format.
$skipOnEmpty boolean|callable|null

Whether to skip this rule if the validated value is empty / not passed. 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.
throws InvalidArgumentException

If configuration is wrong.

 

                public function __construct(
    private string $incorrectInputMessage = '{Property} must be a string. {type} given.',
    private string $message = 'The value of {property} is not a valid UUID.',
    bool|callable|null $skipOnEmpty = null,
    private bool $skipOnError = false,
    private ?Closure $when = null,
) {
    $this->skipOnEmpty = $skipOnEmpty;
}
getHandler() public method

public getHandler( ): string

                public function getHandler(): string
{
    return UuidHandler::class;
}
getIncorrectInputMessage() public method

Get a message used when the input it incorrect.

public getIncorrectInputMessage( ): string
return string

Error message.

 

                public function getIncorrectInputMessage(): string
{
    return $this->incorrectInputMessage;
}
getMessage() public method

Get an error message used when validation fails due to the wrong UUID format.

public getMessage( ): string
return string

Error message.

 

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

public getName( ): string

                public function getName(): string
{
    return self::class;
}
getOptions() public method

public getOptions( ): array

                public function getOptions(): array
{
    return [
        'incorrectInputMessage' => [
            'template' => $this->incorrectInputMessage,
            'parameters' => [],
        ],
        '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.

 

                public function getSkipOnEmpty(): bool|callable|null
{
    return $this->skipOnEmpty;
}
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.
 

                public function getWhen(): ?Closure
{
    return $this->when;
}
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.

 

                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.

 

                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.

 

                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.

 

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