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

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

Public Member Functions
	__construct (array $options=[])
TYPO3 CMS Extbase Error Result	validate ($value)
‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator
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
array	getOptions ()

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

Protected Attributes
array	$supportedOptions
ValidatorResolver	$validatorResolver
‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator
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 collection validator.

Definition at line 27 of file CollectionValidator.php.

Constructor & Destructor Documentation

__construct()

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

(

array

$options = []

)

Constructs the validator and sets validation options

Parameters

array

$options

‪Options for the validator

Exceptions

InvalidValidationOptionsException

Todo:

‪: __construct() will vanish in v12, this abstract will implement setOptions() to set and initialize default options.

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

Definition at line 41 of file CollectionValidator.php.

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

Member Function Documentation

isValid()

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

protected

Checks for a collection and if needed validates the items in the collection. This is done with the specified element validator or a validator based on the given element type and validation group.

Either elementValidator or elementType must be given, otherwise validation will be skipped.

Parameters

mixed

$value

‪A collection to be validated

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

Definition at line 88 of file CollectionValidator.php.

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

validate()

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

Definition at line 55 of file CollectionValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$result, TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\addError(), TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\isCollectionType(), TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\isEmpty(), TYPO3\CMS\Extbase\Persistence\Generic\LazyObjectStorage\isInitialized(), TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator\isValid(), TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\isValidatedAlready(), and TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\markInstanceAsValidated().

Member Data Documentation

$supportedOptions

array TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator::$supportedOptions

protected

Initial value:

= array( 
        'elementValidator' => [null, 'The validator type to use for the collection elements', 'string'],
        'elementType' => [null, 'The type of the elements in the collection', 'string'],
        'validationGroups' => [null, 'The validation groups to link to', 'string'],
     )

Definition at line 31 of file CollectionValidator.php.

$validatorResolver

ValidatorResolver TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator::$validatorResolver

protected

Definition at line 39 of file CollectionValidator.php.