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

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

Public Member Functions
	__construct (array $options=array())
	validate ($value)
	setOptions (array $options)
	getErrors ()
	getOptions ()

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

Protected Attributes
	$acceptsEmptyValues = TRUE
	$supportedOptions = array()
	$options = array()
	$errors = array()
	$result

Detailed Description

Abstract validator

Definition at line 21 of file AbstractValidator.php.

Constructor & Destructor Documentation

__construct()

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

(

array

$options = array()

)

Constructs the validator and sets validation options

Parameters

array

$options

Options for the validator

Exceptions

InvalidValidationOptionsException

Definition at line 64 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 = array(),   $title = ''  )

protected

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

Parameters

string	$message	The error message
integer	$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 148 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\AlphanumericValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\NumberValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\DateTimeValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\IntegerValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\FloatValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\StringValidator\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(), TYPO3\CMS\Extbase\Validation\Validator\BooleanValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate().

getErrors()

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

(

)

Returns an array of errors which occurred during the last isValid() call.

Returns

array An array of objects or an empty array if no errors occurred.

Deprecated:

since Extbase 1.4.0, will be removed two versions after Extbase 6.1. use validate() instead.

Definition at line 135 of file AbstractValidator.php.

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

getOptions()

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

(

)

Returns the options of this validator

Returns

array

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

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

Definition at line 170 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\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().

setOptions()

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

(

array

$options

)

Sets options for the validator

Parameters

array

$options

Options for the validator

Returns

void

Deprecated:

since Extbase 1.4.0, will be removed two versions after Extbase 6.1. use constructor instead.

Definition at line 125 of file AbstractValidator.php.

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

translateErrorMessage()

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

protected

Wrap static call to LocalizationUtility to simplify unit testing

Parameters

string	$translateKey
string	$extensionName
array	$arguments

Returns

NULL|string

Definition at line 183 of file AbstractValidator.php.

Referenced by 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\FloatValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\EmailAddressValidator\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\GenericObjectValidator\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

Definition at line 101 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 32 of file AbstractValidator.php.

$errors

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

protected

Definition at line 50 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\addErrorsForProperty(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\getErrors().

$options

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

protected

Definition at line 44 of file AbstractValidator.php.

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

$result

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

protected

Definition at line 55 of file AbstractValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\checkProperty(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\isPropertyValid(), TYPO3\CMS\Extbase\Mvc\Controller\ArgumentsValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\RegularExpressionValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\validate(), TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\validate(), and TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\validate().

$supportedOptions

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

protected

Definition at line 39 of file AbstractValidator.php.

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