RegularExpressionValidator extends AbstractValidator

Validator based on regular expressions.

Table of Contents

Properties

$acceptsEmptyValues  : bool
Specifies whether this validator accepts empty values.
$options  : array<string|int, mixed>
$result  : Result
$supportedOptions  : array<string|int, mixed>
This contains the supported options, their default values, types and descriptions.

Methods

__construct()  : mixed
Constructs the validator and sets validation options
getOptions()  : array<string|int, mixed>
Returns the options of this validator
isValid()  : mixed
Checks if the given value matches the specified regular expression.
validate()  : Result
Checks if the given value is valid according to the validator, and returns the error messages object which occurred.
addError()  : mixed
Creates a new validation error object and adds it to $this->result
addErrorForProperty()  : mixed
Creates a new validation error object for a property and adds it to the proper sub result of $this->result
getErrorMessage()  : string
initializeDefaultOptions()  : void
Initialize default options.
isEmpty()  : bool
translateErrorMessage()  : string
Wrap static call to LocalizationUtility to simplify unit testing

Properties

$acceptsEmptyValues

Specifies whether this validator accepts empty values.

protected bool $acceptsEmptyValues = true

If this is TRUE, the validators isValid() method is not called in case of an empty value Note: A value is considered empty if it is NULL or an empty string! By default all validators except for NotEmpty and the Composite Validators accept empty values

$options

protected array<string|int, mixed> $options = []

$supportedOptions

This contains the supported options, their default values, types and descriptions.

protected array<string|int, mixed> $supportedOptions = ['regularExpression' => ['', 'The regular expression to use for validation, used as given', 'string', true], 'errorMessage' => ['', 'Error Message to show when validation fails', 'string', false]]

Methods

__construct()

Constructs the validator and sets validation options

public __construct([array<string|int, mixed> $options = [] ]) : mixed
Parameters
$options : array<string|int, mixed> = []

Options for the validator

Tags
throws
InvalidValidationOptionsException
todo:

__construct() will vanish in v12, this abstract will implement setOptions() to set and initialize default options.

getOptions()

Returns the options of this validator

public getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

isValid()

Checks if the given value matches the specified regular expression.

public isValid(mixed $value) : mixed
Parameters
$value : mixed

The value that should be validated

Tags
throws
InvalidValidationOptionsException

validate()

Checks if the given value is valid according to the validator, and returns the error messages object which occurred.

public validate(mixed $value) : Result
Parameters
$value : mixed

The value that should be validated

Return values
Result

addError()

Creates a new validation error object and adds it to $this->result

protected addError(string $message, int $code[, array<string|int, mixed> $arguments = [] ][, string $title = '' ]) : mixed
Parameters
$message : string

The error message

$code : int

The error code (a unix timestamp)

$arguments : array<string|int, mixed> = []

Arguments to be replaced in message

$title : string = ''

title of the error

addErrorForProperty()

Creates a new validation error object for a property and adds it to the proper sub result of $this->result

protected addErrorForProperty(mixed $propertyPath, string $message, int $code[, array<string|int, mixed> $arguments = [] ][, string $title = '' ]) : mixed
Parameters
$propertyPath : mixed
$message : string

The error message

$code : int

The error code (a unix timestamp)

$arguments : array<string|int, mixed> = []

Arguments to be replaced in message

$title : string = ''

title of the error

getErrorMessage()

protected getErrorMessage() : string
Return values
string

initializeDefaultOptions()

Initialize default options.

protected initializeDefaultOptions(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>
Tags
throws
InvalidValidationOptionsException

isEmpty()

protected final isEmpty(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

TRUE if the given $value is NULL or an empty string ('')

translateErrorMessage()

Wrap static call to LocalizationUtility to simplify unit testing

protected translateErrorMessage(string $translateKey, string $extensionName[, array<string|int, mixed> $arguments = [] ]) : string
Parameters
$translateKey : string
$extensionName : string
$arguments : array<string|int, mixed> = []
Return values
string

        
On this page

Search results