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

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

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

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

Protected Attributes
	$propertyValidators = []
	$validatedInstancesContainer
Protected Attributes inherited from TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
	$acceptsEmptyValues = true
	$supportedOptions = []
	$options = []
	$result

Detailed Description

A generic object validator which allows for specifying property validators

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

Returns

void

Definition at line 136 of file GenericObjectValidator.php.

canValidate()

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 123 of file GenericObjectValidator.php.

getPropertyValidators()

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 168 of file GenericObjectValidator.php.

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

getPropertyValue()

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 60 of file GenericObjectValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$result, 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

Returns

void

Definition at line 108 of file GenericObjectValidator.php.

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

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

isValidatedAlready()

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

protected

Parameters

object

$object

Returns

bool

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

Returns

void

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

Definition at line 189 of file GenericObjectValidator.php.

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

validate()

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

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

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(), and TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\isValidatedAlready().

Member Data Documentation

$propertyValidators

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::$propertyValidators = []

protected

Definition at line 27 of file GenericObjectValidator.php.

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

$validatedInstancesContainer

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

protected

Definition at line 180 of file GenericObjectValidator.php.

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