TYPO3 CMS  TYPO3_6-2
TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator Class Reference
Inheritance diagram for TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator:
TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator TYPO3\CMS\Extbase\Validation\Validator\ObjectValidatorInterface TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface Tx_Extbase_Validation_Validator_GenericObjectValidator TYPO3\CMS\Extbase\Validation\Validator\CollectionValidator

Public Member Functions

 validate ($value)
 
 isValid ($object)
 
 canValidate ($object)
 
 isPropertyValid ($object, $propertyName)
 
 addPropertyValidator ($propertyName, \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $validator)
 
 getPropertyValidators ($propertyName=NULL)
 
 injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
 
 setValidatedInstancesContainer (\SplObjectStorage $validatedInstancesContainer)
 
- Public Member Functions inherited from TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
 __construct (array $options=array())
 
 validate ($value)
 
 setOptions (array $options)
 
 getErrors ()
 
 getOptions ()
 

Protected Member Functions

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

Protected Attributes

 $propertyValidators = array()
 
 $configurationManager
 
 $validatedInstancesContainer
 
- Protected Attributes inherited from TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator
 $acceptsEmptyValues = TRUE
 
 $supportedOptions = array()
 
 $options = array()
 
 $errors = array()
 
 $result
 

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! A generic object validator which allows for specifying property validators

Definition at line 19 of file GenericObjectValidator.php.

Member Function Documentation

◆ addErrorsForProperty()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::addErrorsForProperty (   $errors,
  $propertyName 
)
protected
Parameters
array$errorsArray of
string$propertyNameName of the property to add errors
Returns
void
Deprecated:
since Extbase 1.4.0, will be removed two versions after Extbase 6.1

Definition at line 179 of file GenericObjectValidator.php.

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

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

◆ addPropertyValidator()

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

Adds the given validator for validation of the specified property.

Parameters
string$propertyNameName of the property to validate
\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface$validatorThe property validator
Returns
void

Definition at line 194 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
object$objectThe object to be checked
Returns
boolean TRUE if the given value is an object

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

Definition at line 139 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$valueThe value to be validated
array$validatorsThe validators to be called on the value
string$propertyNameName of ther property to check
Returns
void

Definition at line 74 of file GenericObjectValidator.php.

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

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

◆ getPropertyValidators()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::getPropertyValidators (   $propertyName = NULL)

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

Parameters
string$propertyNameName of the property to return validators for
Returns
array An array of validators

Definition at line 224 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 56 of file GenericObjectValidator.php.

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

◆ injectConfigurationManager()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::injectConfigurationManager ( \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface  $configurationManager)
Parameters
\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface$configurationManager
Returns
void

Definition at line 241 of file GenericObjectValidator.php.

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

◆ isPropertyValid()

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

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

Definition at line 155 of file GenericObjectValidator.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractValidator\$result, and TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator\addErrorsForProperty().

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

◆ isValid()

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

◆ isValidatedAlready()

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

◆ setValidatedInstancesContainer()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::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 258 of file GenericObjectValidator.php.

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

◆ validate()

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::validate (   $value)

Member Data Documentation

◆ $configurationManager

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::$configurationManager
protected

◆ $propertyValidators

TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator::$propertyValidators = array()
protected

◆ $validatedInstancesContainer

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