TextValidator

final class \TYPO3\CMS\Extbase\Validation\Validator\TextValidator

Extends
AbstractValidator

Validator for "plain" text.

Table of Contents

Properties

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

Methods

getOptions()  : array
Returns the options of this validator
isValid()  : void
Checks if the given value is a valid text (contains no XML tags).
setOptions()  : void
Receive validator options from framework.
validate()  : Result
Checks if the given value is valid according to the validator, and returns the error messages object which occurred.
addError()  : void
Creates a new validation error object and adds it to $this->result
addErrorForProperty()  : void
Creates a new validation error object for a property and adds it to the proper sub result of $this->result
initializeDefaultOptions()  : void
Initialize default options.
isEmpty()  : bool
TRUE if the given $value is NULL or an empty string ('')
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.

$supportedOptions

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

protected array $supportedOptions = []

Methods

getOptions()

Returns the options of this validator

public getOptions() : array

Return values

array

isValid()

Checks if the given value is a valid text (contains no XML tags).

public isValid(mixed $value) : void

Be aware that the value of this check entirely depends on the output context. The validated text is not expected to be secure in every circumstance, if you want to be sure of that, use a customized regular expression or filter on output.

Parameters

$value : mixed

setOptions()

Receive validator options from framework.

public setOptions(array $options) : void

Parameters

$options : array

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 $arguments = [] ][, string $title = '' ]) : void

Parameters

$message : string

The error message

$code : int

The error code (a unix timestamp)

$arguments : array = []

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(string|array $propertyPath, string $message, int $code[, array $arguments = [] ][, string $title = '' ]) : void

Parameters

$propertyPath : string|array

The property path (string or array)

$message : string

The error message

$code : int

The error code (a unix timestamp)

$arguments : array = []

Arguments to be replaced in message

$title : string = ''

Title of the error

isEmpty()

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

protected final isEmpty(mixed $value) : bool

Parameters

$value : mixed

Return values

bool

translateErrorMessage()

Wrap static call to LocalizationUtility to simplify unit testing.

protected translateErrorMessage(string $translateKey, string $extensionName[, array $arguments = [] ]) : string

Parameters

$translateKey : string
$extensionName : string
$arguments : array = []

Return values

string
On this page