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

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

Public Member Functions
TYPO3 CMS Extbase Error Result	validate ($value)
bool	canValidate ($object)
	addPropertyValidator ($propertyName, ValidatorInterface $validator)
array	getPropertyValidators ($propertyName=null)
	setValidatedInstancesContainer (\SplObjectStorage $validatedInstancesContainer)
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
	__construct (array $options=[])
array	getOptions ()

Protected Member Functions
mixed	getPropertyValue ($object, $propertyName)
	checkProperty ($value, $validators, $propertyName)
	isValid ($object)
bool	isValidatedAlready ($object)
	markInstanceAsValidated ($object)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
	addError ($message, $code, array $arguments=[], $title='')
bool	isEmpty ($value)
string null	translateErrorMessage ($translateKey, $extensionName, $arguments=[])

Protected Attributes
SplObjectStorage[]	$propertyValidators = array( )
SplObjectStorage	$validatedInstancesContainer
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
bool	$acceptsEmptyValues = true
array	$supportedOptions = array( )
array	$options = array( )
TYPO3 CMS Extbase Error Result	$result

Detailed Description

A generic object validator which allows for specifying property validators

Definition at line 24 of file GenericObjectValidator.php.

Member Function Documentation

addPropertyValidator()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::addPropertyValidator	(		$propertyName,
		ValidatorInterface	$validator
	)

Adds the given validator for validation of the specified property.

Parameters

string	$propertyName	‪Name of the property to validate
ValidatorInterface	$validator	‪The property validator

Definition at line 142 of file GenericObjectValidator.php.

References $validator.

canValidate()

bool TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::canValidate

(

$object

)

Checks the given object can be validated by the validator implementation

Parameters

mixed

$object

‪The object to be checked

Returns

‪bool TRUE if the given value is an object

Definition at line 131 of file GenericObjectValidator.php.

checkProperty()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::checkProperty (   $value,   $validators,   $propertyName  )

protected

Checks if the specified property of the given object is valid, and adds found errors to the $messages object.

Parameters

mixed	$value	‪The value to be validated
\Traversable	$validators	‪The validators to be called on the value
string	$propertyName	‪Name of the property to check

Definition at line 90 of file GenericObjectValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$result, and $validator.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\isValid().

getPropertyValidators()

array TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::getPropertyValidators

(

$propertyName = null

)

Returns all property validators - or only validators of the specified property

Parameters

string

$propertyName

‪Name of the property to return validators for

Returns

‪array An array of validators

Definition at line 180 of file GenericObjectValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\$propertyValidators.

getPropertyValue()

mixed TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::getPropertyValue (   $object,   $propertyName  )

protected

Load the property value to be used for validation.

In case the object is a doctrine proxy, we need to load the real instance first.

Parameters

object	$object
string	$propertyName

Returns

‪mixed

Definition at line 65 of file GenericObjectValidator.php.

References TYPO3\CMS\Extbase\Reflection\ObjectAccess\getProperty(), and TYPO3\CMS\Extbase\Reflection\ObjectAccess\isPropertyGettable().

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\isValid().

isValid()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::isValid (   $object )

protected

Checks if the given value is valid according to the property validators.

Parameters

mixed

$object

‪The value that should be validated

Reimplemented from TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator.

Reimplemented in TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator.

Definition at line 117 of file GenericObjectValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\checkProperty(), and TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\getPropertyValue().

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

isValidatedAlready()

bool TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::isValidatedAlready (   $object )

protected

Parameters

object

$object

Returns

‪bool

Definition at line 154 of file GenericObjectValidator.php.

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

markInstanceAsValidated()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::markInstanceAsValidated (   $object )

protected

Parameters

object

$object

Definition at line 169 of file GenericObjectValidator.php.

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

setValidatedInstancesContainer()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::setValidatedInstancesContainer

(

\SplObjectStorage

$validatedInstancesContainer

)

Allows to set a container to keep track of validated instances.

Parameters

\SplObjectStorage

$validatedInstancesContainer

‪A container to keep track of validated instances

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

Definition at line 197 of file GenericObjectValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\$validatedInstancesContainer.

validate()

TYPO3 CMS Extbase Error Result TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::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

‪\TYPO3\CMS\Extbase\Error\Result

Reimplemented from TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator.

Reimplemented in TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator.

Definition at line 37 of file GenericObjectValidator.php.

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

Member Data Documentation

$propertyValidators

SplObjectStorage [] TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::$propertyValidators = array( )

protected

Definition at line 28 of file GenericObjectValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\getPropertyValidators().

$validatedInstancesContainer

SplObjectStorage TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::$validatedInstancesContainer

protected

Definition at line 190 of file GenericObjectValidator.php.

Referenced by TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\setValidatedInstancesContainer().