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

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

Public Member Functions
	setOptions (array $options)
	validate (mixed $value)
	getOptions ()

Protected Member Functions
	isValid (mixed $value)
	addError (string $message, int $code, array $arguments=[], string $title='')
	addErrorForProperty (string|array $propertyPath, string $message, int $code, array $arguments=[], string $title='')
	isEmpty (mixed $value)
	translateErrorMessage (string $translateKey, string $extensionName, array $arguments=[])
	initializeDefaultOptions (array $options)

Protected Attributes
bool	$acceptsEmptyValues = true
array	$supportedOptions = array( )
array	$options = []
Result	$result

Detailed Description

Abstract validator. Mother af most validators.

Definition at line 28 of file AbstractValidator.php.

Member Function Documentation

addError()

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

protected

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

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

Definition at line 82 of file AbstractValidator.php.

Referenced by TYPO3Tests\ActionControllerArgumentTest\Domain\Validation\Validator\FailingValidator\isValid(), TYPO3\CMS\Form\Tests\Unit\Mvc\Fixtures\AnotherTestValidator\isValid(), TYPO3\CMS\Form\Tests\Unit\Mvc\Fixtures\TestValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NumberValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\UrlValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\FloatValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\TextValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NumberRangeValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\EmptyValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\DateRangeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\CountValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\FileSizeValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\MimeTypeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\AbstractGenericObjectValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate().

addErrorForProperty()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::addErrorForProperty ( string|array  $propertyPath, string  $message, int  $code, array  $arguments = [], string  $title = ''  )

protected

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

Parameters

string | array	$propertyPath	‪The property path (string or array)
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

Definition at line 96 of file AbstractValidator.php.

getOptions()

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

(

)

Returns the options of this validator

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

Definition at line 106 of file AbstractValidator.php.

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

initializeDefaultOptions()

TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::initializeDefaultOptions ( array  $options )

protected

Initialize default options.

Exceptions

InvalidValidationOptionsException

Definition at line 135 of file AbstractValidator.php.

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

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

isEmpty()

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

finalprotected

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

Definition at line 114 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\AbstractGenericObjectValidator\validate(), TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\validate().

isValid()

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

abstractprotected

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

Reimplemented in TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator, TYPO3\CMS\Form\Mvc\Validation\CountValidator, TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator, TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator, TYPO3\CMS\Form\Mvc\Validation\DateRangeValidator, TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator, TYPO3Tests\TestValidators\Validation\Validator\CustomValidator, TYPO3\CMS\Form\Mvc\Validation\EmptyValidator, TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator, TYPO3\CMS\Extbase\Validation\Validator\NumberRangeValidator, TYPO3Tests\BlogExample\Domain\Validator\PostValidator, TYPO3\CMS\Extbase\Tests\Unit\Validation\Validator\Fixture\AbstractValidatorClass, TYPO3\CMS\Extbase\Validation\Validator\TextValidator, TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator, TYPO3\CMS\Extbase\Validation\Validator\FloatValidator, TYPO3\CMS\Extbase\Validation\Validator\UrlValidator, TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator, TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator, TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator, TYPO3\CMS\Extbase\Validation\Validator\NumberValidator, TYPO3\CMS\Extbase\Validation\Validator\StringValidator, TYPO3Tests\ActionControllerArgumentTest\Domain\Validation\Validator\FailingValidator, TYPO3\CMS\Extbase\Tests\Functional\Mvc\Controller\Fixture\Validation\Validator\CustomValidator, TYPO3\CMS\Form\Tests\Unit\Mvc\Fixtures\AnotherTestValidator, TYPO3\CMS\Form\Tests\Unit\Mvc\Fixtures\TestValidator, TYPO3\CMS\Extbase\Tests\Unit\Validation\Fixtures\Validation\Validator\CustomValidator, TYPO3\CMS\Form\Mvc\Validation\MimeTypeValidator, TYPO3\CMS\Form\Mvc\Validation\FileSizeValidator, and TYPO3\CMS\Extbase\Validation\Validator\AbstractGenericObjectValidator.

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

setOptions()

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

(

array

$options

)

Receive validator options from framework.

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

Definition at line 49 of file AbstractValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\initializeDefaultOptions().

translateErrorMessage()

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

protected

Wrap static call to LocalizationUtility to simplify unit testing.

Definition at line 122 of file AbstractValidator.php.

References TYPO3\CMS\Extbase\Utility\LocalizationUtility\translate().

Referenced by TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator\getErrorMessage(), TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NumberValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\FloatValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\UrlValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\TextValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NumberRangeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NotEmptyValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\EmptyValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringLengthValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\DateRangeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\CountValidator\isValid(), TYPO3\CMS\Form\Mvc\Validation\FileSizeValidator\isValid(), and TYPO3\CMS\Form\Mvc\Validation\MimeTypeValidator\isValid().

validate()

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

(

mixed

$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

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

Reimplemented in TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator, and TYPO3\CMS\Extbase\Validation\Validator\AbstractGenericObjectValidator.

Definition at line 60 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

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

protected

Specifies whether this validator accepts empty values.

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.

Definition at line 38 of file AbstractValidator.php.

$options

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

protected

Definition at line 46 of file AbstractValidator.php.

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

$result

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

protected

Definition at line 47 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\AbstractGenericObjectValidator\checkProperty(), TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\AbstractGenericObjectValidator\validate(), TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\validate().

$supportedOptions

array TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator::$supportedOptions = array( )

protected

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

Definition at line 44 of file AbstractValidator.php.