TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator:

Public Member Functions
	__construct (array $options=[])
	validate ($value)
	getOptions ()

Protected Member Functions
	isValid ($value)
	addError ($message, $code, array $arguments=[], $title='')
	isEmpty ($value)
	translateErrorMessage ($translateKey, $extensionName, $arguments=[])

Protected Attributes
	$acceptsEmptyValues = true
	$supportedOptions = []
	$options = []
	$result

Detailed Description

Abstract validator

Definition at line 22 of file AbstractValidator.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::__construct

(

array

$options = []

)

Constructs the validator and sets validation options

Parameters

array

$options

Options for the validator

Exceptions

InvalidValidationOptionsException

Definition at line 59 of file AbstractValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$options, and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$supportedOptions.

Member Function Documentation

addError()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::addError (   $message,   $code, array  $arguments = [],   $title = ''  )

protected

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

Parameters

string	$message	The error message
int	$code	The error code (a unix timestamp)
array	$arguments	Arguments to be replaced in message
string	$title	title of the error

Returns

void

Definition at line 124 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\NumberValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\FloatValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\FloatValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\UriValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\IntegerValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\DigitValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\IpValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\TextValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\RequiredValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\EmailValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NumberRangeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\LessThanValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\AlphabeticValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\AlphanumericValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\DateValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\GreaterThanValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\EqualsValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\RegExpValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\FileMinimumSizeValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\BetweenValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\FileMaximumSizeValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\FileAllowedTypesValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\LengthValidator\isValid(), TYPO3\CMS\Form\Domain\Validator\InArrayValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\validate(), TYPO3\CMS\Form\Domain\Validator\ValidationElementValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate().

getOptions()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::getOptions

(

)

Returns the options of this validator

Returns

array

Implements TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface.

Definition at line 134 of file AbstractValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$options.

isEmpty()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::isEmpty (   $value )

finalprotected

Parameters

mixed

$value

Returns

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

Definition at line 143 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\validate(), TYPO3\CMS\Form\Domain\Validator\ValidationElementValidator\validate(), TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\validate().

isValid()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::isValid (   $value )

abstractprotected

Check if $value is valid. If it is not valid, needs to add an error to result.

Parameters

mixed

$value

Returns

void

Referenced by TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\validate().

translateErrorMessage()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::translateErrorMessage (   $translateKey,   $extensionName,   $arguments = []  )

protected

Wrap static call to LocalizationUtility to simplify unit testing

Parameters

string	$translateKey
string	$extensionName
array	$arguments

Returns

NULL|string

Definition at line 157 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\NumberValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\FloatValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\TextValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NumberRangeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator\isValid(), and TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator\isValid().

validate()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::validate

(

$value

)

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

Parameters

mixed

$value

The value that should be validated

Returns

Implements TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface.

Definition at line 97 of file AbstractValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$result, TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\isEmpty(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\isValid().

Member Data Documentation

$acceptsEmptyValues

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::$acceptsEmptyValues = true

protected

Definition at line 33 of file AbstractValidator.php.

$options

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::$options = []

protected

Definition at line 45 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\__construct(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\getOptions().

$result

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::$result

protected

Definition at line 50 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\getPropertyValue(), TYPO3\CMS\Form\Domain\Validator\ValidationElementValidator\getPropertyValue(), TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\validate(), TYPO3\CMS\Form\Domain\Validator\ValidationElementValidator\validate(), TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\validate().

$supportedOptions

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::$supportedOptions = []

protected

Definition at line 40 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\__construct().