TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator:
TYPO3\CMS\Extbase\Validation\Validator\ObjectValidatorInterface TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface Tx_Extbase_Validation_Validator_AbstractCompositeValidator TYPO3\CMS\Extbase\Tests\Unit\Validation\Validator\Fixture\AbstractCompositeValidatorClass TYPO3\CMS\Extbase\Validation\Validator\ConjunctionValidator TYPO3\CMS\Extbase\Validation\Validator\DisjunctionValidator Tx_Extbase_Validation_Validator_ConjunctionValidator Tx_Extbase_Validation_Validator_DisjunctionValidator

Public Member Functions

 __construct (array $options=array())
 
 setOptions (array $options)
 
 getErrors ()
 
 addValidator (\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator)
 
 removeValidator (\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator)
 
 count ()
 
 getValidators ()
 
 getOptions ()
 
 setValidatedInstancesContainer (\SplObjectStorage $validatedInstancesContainer)
 
 canValidate ($object)
 
 isPropertyValid ($object, $propertyName)
 

Protected Attributes

 $supportedOptions = array()
 
 $options = array()
 
 $validators
 
 $validatedInstancesContainer
 
 $errors = array()
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! An abstract composite validator consisting of other validators

Definition at line 22 of file AbstractCompositeValidator.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructs the composite validator and sets validation options

Parameters
array$optionsOptions for the validator

Definition at line 57 of file AbstractCompositeValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator\$options, and TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator\$supportedOptions.

Member Function Documentation

◆ addValidator()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::addValidator ( \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface  $validator)

Adds a new validator to the conjunction.

Parameters
\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface$validatorThe validator that should be added
Returns
void

Definition at line 114 of file AbstractCompositeValidator.php.

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

Referenced by TYPO3\CMS\Extbase\Validation\ValidatorResolver\addCustomValidators().

◆ canValidate()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::canValidate (   $object)

Checks the given object can be validated by the validator implementation

Parameters
object$objectThe object to be checked
Returns
boolean TRUE if this validator can validate instances of the given object or FALSE if it can't
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

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

Definition at line 183 of file AbstractCompositeValidator.php.

◆ count()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::count ( )

Returns the number of validators contained in this conjunction.

Returns
integer The number of validators

Definition at line 142 of file AbstractCompositeValidator.php.

◆ getErrors()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::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

Definition at line 103 of file AbstractCompositeValidator.php.

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

◆ getOptions()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::getOptions ( )

Returns the options for this validator

Returns
array

Definition at line 160 of file AbstractCompositeValidator.php.

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

◆ getValidators()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::getValidators ( )

◆ isPropertyValid()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::isPropertyValid (   $object,
  $propertyName 
)

Checks if the specified property of the given object is valid.

If at least one error occurred, the result is FALSE.

Parameters
object$objectThe object containing the property to validate
string$propertyNameName of the property to validate
Returns
boolean TRUE if the property value is valid, FALSE if an error occurred
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

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

Definition at line 198 of file AbstractCompositeValidator.php.

◆ removeValidator()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::removeValidator ( \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface  $validator)

Removes the specified validator.

Parameters
\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface$validatorThe validator to remove
Exceptions

Definition at line 129 of file AbstractCompositeValidator.php.

◆ setOptions()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::setOptions ( array  $options)

Does nothing.

Parameters
array$optionsNot used
Returns
void
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

Definition at line 94 of file AbstractCompositeValidator.php.

◆ setValidatedInstancesContainer()

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::setValidatedInstancesContainer ( \SplObjectStorage  $validatedInstancesContainer)

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

Parameters
\SplObjectStorage$validatedInstancesContainerA container to keep track of validated instances
Returns
void

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

Definition at line 171 of file AbstractCompositeValidator.php.

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

Member Data Documentation

◆ $errors

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

◆ $options

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

◆ $supportedOptions

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

◆ $validatedInstancesContainer

TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator::$validatedInstancesContainer
protected

◆ $validators