0 follower

Final Class Yiisoft\Validator\Rule\Regex

All Classes | Methods

Inheritance	Yiisoft\Validator\Rule\Regex
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 matches the pattern specified in constructor.

If the {@see \Yiisoft\Validator\Rule\Regex::$not} is used, the rule will ensure the value do NOT match the pattern.

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Validator\Rule\Regex
getHandler()		Yiisoft\Validator\Rule\Regex
getIncorrectInputMessage()	Get a message used when the input is incorrect.	Yiisoft\Validator\Rule\Regex
getMessage()	Get a message used when the value does not match regular expression.	Yiisoft\Validator\Rule\Regex
getName()		Yiisoft\Validator\Rule\Regex
getOptions()		Yiisoft\Validator\Rule\Regex
getPattern()	Get the regular expression to be matched with.	Yiisoft\Validator\Rule\Regex
getSkipOnEmpty()	A getter for `$skipOnEmpty` property.	Yiisoft\Validator\Rule\Trait\SkipOnEmptyTrait
getWhen()	A getter for `$when` property.	Yiisoft\Validator\Rule\Trait\WhenTrait
isNot()	Get whether to invert the validation logic.	Yiisoft\Validator\Rule\Regex
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 mixed __construct ( string $pattern, boolean $not = false, string $incorrectInputMessage = '{Property} must be a string. {type} given.', string $message = '{Property} is invalid.', boolean\|callable\|null $skipOnEmpty = null, boolean $skipOnError = false, Closure\|null $when = null )
$pattern	string	The regular expression to be matched with.
$not	boolean	Whether to invert the validation logic. Defaults to `false`. If set to `true`, the regular expression defined via {@see $pattern} should NOT match the value.
$incorrectInputMessage	string	A message used when the input is incorrect. You may use the following placeholders in the message: `{property}`: the translated label of the property being validated. `{type}`: the type of the value being validated.
$message	string	A message used when the value does not match regular expression. You may use the following placeholders in the message: `{property}`: the translated label of the property being validated. `{value}`: the value of the property being validated.
$skipOnEmpty	boolean\|callable\|null	Whether to skip this rule if the value validated is empty. See {@see \Yiisoft\Validator\SkipOnEmptyInterface}.
$skipOnError	boolean	Whether to skip this rule if any of the previous rules gave an error. See {@see \Yiisoft\Validator\SkipOnErrorInterface}.
$when	Closure\|null	A callable to define a condition for applying the rule. See {@see \Yiisoft\Validator\WhenInterface}.

Source code

                public function __construct(
    #[Language('RegExp')]
    string $pattern,
    private bool $not = false,
    private string $incorrectInputMessage = '{Property} must be a string. {type} given.',
    private string $message = '{Property} is invalid.',
    bool|callable|null $skipOnEmpty = null,
    private bool $skipOnError = false,
    private ?Closure $when = null,
) {
    if ($pattern === '') {
        throw new InvalidArgumentException('Pattern can\'t be empty.');
    }
    $this->pattern = $pattern;
    $this->skipOnEmpty = $skipOnEmpty;
}

getHandler() public method

public string getHandler ( )

Source code

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

getIncorrectInputMessage() public method

Get a message used when the input is incorrect.

public string getIncorrectInputMessage ( )
return	string	Error message.

Source code

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

getMessage() public method

Get a message used when the value does not match regular expression.

public string getMessage ( )
return	string	Error message.

Source code

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

getName() public method

public string getName ( )

Source code

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

getOptions() public method

public array getOptions ( )

Source code

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

getPattern() public method

Get the regular expression to be matched with.

public string getPattern ( )
return	string	The regular expression.

Source code

                public function getPattern(): string
{
    return $this->pattern;
}

getSkipOnEmpty() public method

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

A getter for $skipOnEmpty property.

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

Source code

                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 Closure\|null getWhen ( )
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

Get whether to invert the validation logic.

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

Source code

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

shouldSkipOnError() public method

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

A getter for $skipOnError property.

public boolean shouldSkipOnError ( )
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 $this skipOnEmpty ( boolean\|callable\|null $value )
$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 $this skipOnError ( boolean $value )
$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 $this when ( Closure\|null $value )
$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;
}