TYPO3\CMS\Extbase\Validation\ValidatorResolver Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Validation\ValidatorResolver:

Public Member Functions
	createValidator ($validatorType, array $validatorOptions=array())
	getBaseValidatorConjunction ($targetClassName)
	buildMethodArgumentsValidatorConjunctions ($className, $methodName, array $methodParameters=NULL, array $methodValidateAnnotations=NULL)
	getMethodValidateAnnotations ($className, $methodName)

Public Attributes
const	PATTERN_MATCH_VALIDATORS
const	PATTERN_MATCH_VALIDATOROPTIONS

Protected Member Functions
	buildSubObjectValidator (array $objectPath, \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface $propertyValidator)
	addCustomValidators ($targetClassName, ConjunctionValidator &$conjunctionValidator)
	parseValidatorAnnotation ($validateValue)
	parseValidatorOptions ($rawValidatorOptions)
	unquoteString (&$quotedValue)
	resolveValidatorObjectName ($validatorName)
	getValidatorType ($type)

Protected Attributes
	$objectManager
	$reflectionService
	$baseValidatorConjunctions = array()

Detailed Description

Validator resolver to automatically find a appropriate validator for a given subject

Definition at line 26 of file ValidatorResolver.php.

Member Function Documentation

addCustomValidators()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::addCustomValidators (   $targetClassName, ConjunctionValidator &  $conjunctionValidator  )

protected

This adds custom validators to the passed $conjunctionValidator.

A custom validator is found if it follows the naming convention "Replace '\Model\' by '\Validator\' and append 'Validator'". If found, it will be added to the $conjunctionValidator.

In addition canValidate() will be called on all implementations of the ObjectValidatorInterface to find all validators that could validate the target. The one with the highest priority will be added as well. If multiple validators have the same priority, which one will be added is not deterministic.

Parameters

string	$targetClassName
ConjunctionValidator	$conjunctionValidator

Returns

NULL|Validator

Definition at line 328 of file ValidatorResolver.php.

References TYPO3\CMS\Extbase\Validation\Validator\AbstractCompositeValidator\addValidator(), TYPO3\CMS\Extbase\Validation\ValidatorResolver\createValidator(), and TYPO3\CMS\Core\Utility\ClassNamingUtility\translateModelNameToValidatorName().

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

buildMethodArgumentsValidatorConjunctions()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::buildMethodArgumentsValidatorConjunctions	(		$className,
			$methodName,
		array	$methodParameters = NULL,
		array	$methodValidateAnnotations = NULL
	)

Detects and registers any validators for arguments:

• by the data type specified in the param annotations
• additional validators specified in the validate annotations of a method

Parameters

string	$className
string	$methodName
array	$methodParameters	Optional pre-compiled array of method parameters
array	$methodValidateAnnotations	Optional pre-compiled array of validate annotations (as array)

Returns

array An Array of ValidatorConjunctions for each method parameters.

Exceptions

Definition at line 139 of file ValidatorResolver.php.

References TYPO3\CMS\Extbase\Validation\ValidatorResolver\buildSubObjectValidator(), TYPO3\CMS\Extbase\Validation\ValidatorResolver\createValidator(), and TYPO3\CMS\Extbase\Validation\ValidatorResolver\getMethodValidateAnnotations().

buildSubObjectValidator()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::buildSubObjectValidator ( array  $objectPath, \TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface  $propertyValidator  )

protected

Builds a chain of nested object validators by specification of the given object path.

Parameters

array	$objectPath	The object path
\TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface	$propertyValidator	The validator which should be added to the property specified by objectPath

Returns

Definition at line 207 of file ValidatorResolver.php.

References TYPO3\CMS\Extbase\Validation\ValidatorResolver\addCustomValidators(), TYPO3\CMS\Extbase\Validation\ValidatorResolver\createValidator(), TYPO3\CMS\Extbase\Validation\ValidatorResolver\getBaseValidatorConjunction(), TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\isCollectionType(), TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\isCoreType(), TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\isSimpleType(), TYPO3\CMS\Extbase\Utility\TypeHandlingUtility\parseType(), TYPO3\CMS\Extbase\Validation\ValidatorResolver\parseValidatorAnnotation(), and TYPO3\CMS\Extbase\Object\Container\Container\SCOPE_PROTOTYPE.

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

createValidator()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::createValidator	(		$validatorType,
		array	$validatorOptions = array()
	)

Get a validator for a given data type. Returns a validator implementing the or NULL if no validator could be resolved.

Parameters

string	$validatorName	Either one of the built-in data types or fully qualified validator class name
array	$validatorOptions	Options to be passed to the validator

Returns

Validator or NULL if none found.

todo: remove throwing Exceptions in resolveValidatorObjectName

Definition at line 88 of file ValidatorResolver.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\devLog(), TYPO3\CMS\Extbase\Validation\ValidatorResolver\resolveValidatorObjectName(), and TYPO3\CMS\Core\Utility\GeneralUtility\SYSLOG_SEVERITY_INFO.

Referenced by TYPO3\CMS\Extbase\Validation\ValidatorResolver\addCustomValidators(), TYPO3\CMS\Extbase\Validation\ValidatorResolver\buildMethodArgumentsValidatorConjunctions(), and TYPO3\CMS\Extbase\Validation\ValidatorResolver\buildSubObjectValidator().

getBaseValidatorConjunction()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::getBaseValidatorConjunction

(

$targetClassName

)

Resolves and returns the base validator conjunction for the given data type.

If no validator could be resolved (which usually means that no validation is necessary), NULL is returned.

Parameters

string

$dataType

The data type to search a validator for. Usually the fully qualified object name

Returns

The validator conjunction or NULL

Definition at line 117 of file ValidatorResolver.php.

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

getMethodValidateAnnotations()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::getMethodValidateAnnotations	(		$className,
			$methodName
	)

Temporary replacement for $this->reflectionService->getMethodAnnotations()

Parameters

string	$className
string	$methodName

Returns

array

Definition at line 506 of file ValidatorResolver.php.

References TYPO3\CMS\Extbase\Validation\ValidatorResolver\parseValidatorAnnotation().

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

getValidatorType()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::getValidatorType (   $type )

protected

Used to map PHP types to validator types.

Parameters

string

$type

Data type to unify

Returns

string unified data type

Definition at line 475 of file ValidatorResolver.php.

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

parseValidatorAnnotation()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::parseValidatorAnnotation (   $validateValue )

protected

Parses the validator options given in annotations.

Parameters

string

$validateValue

Returns

array

Definition at line 349 of file ValidatorResolver.php.

References TYPO3\CMS\Extbase\Validation\ValidatorResolver\parseValidatorOptions().

Referenced by TYPO3\CMS\Extbase\Validation\ValidatorResolver\buildSubObjectValidator(), and TYPO3\CMS\Extbase\Validation\ValidatorResolver\getMethodValidateAnnotations().

parseValidatorOptions()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::parseValidatorOptions (   $rawValidatorOptions )

protected

Parses $rawValidatorOptions not containing quoted option values. $rawValidatorOptions will be an empty string afterwards (pass by ref!).

Parameters

string

$rawValidatorOptions

Returns

array An array of optionName/optionValue pairs

Definition at line 376 of file ValidatorResolver.php.

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

resolveValidatorObjectName()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::resolveValidatorObjectName (   $validatorName )

protected

Returns an object of an appropriate validator for the given class. If no validator is available FALSE is returned

Parameters

string

$validatorName

Either the fully qualified class name of the validator or the short name of a built-in validator

Exceptions

Exception

Found shorthand validator, either extbase or foreign extension NotEmpty or Acme.MyPck.Ext:MyValidator

Shorthand custom

Shorthand built in

Full qualified Tx_MyExt_Validation_Validator_MyValidator or

Definition at line 417 of file ValidatorResolver.php.

References TYPO3\CMS\Extbase\Validation\ValidatorResolver\getValidatorType().

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

unquoteString()

TYPO3\CMS\Extbase\Validation\ValidatorResolver::unquoteString ( &  $quotedValue )

protected

Removes escapings from a given argument string and trims the outermost quotes.

This method is meant as a helper for regular expression results.

Parameters

string

&$quotedValue

Value to unquote

Returns

void

Definition at line 396 of file ValidatorResolver.php.

Member Data Documentation

$baseValidatorConjunctions

TYPO3\CMS\Extbase\Validation\ValidatorResolver::$baseValidatorConjunctions = array()

protected

Definition at line 77 of file ValidatorResolver.php.

$objectManager

TYPO3\CMS\Extbase\Validation\ValidatorResolver::$objectManager

protected

Definition at line 66 of file ValidatorResolver.php.

$reflectionService

TYPO3\CMS\Extbase\Validation\ValidatorResolver::$reflectionService

protected

Definition at line 72 of file ValidatorResolver.php.

PATTERN_MATCH_VALIDATOROPTIONS

const TYPO3\CMS\Extbase\Validation\ValidatorResolver::PATTERN_MATCH_VALIDATOROPTIONS

Initial value:

= '/
            \s*
            (?P<optionName>[a-z0-9]+)
            \s*=\s*
            (?P<optionValue>
                "(?:\\\\"|[^"])*"
                |\'(?:\\\\\'|[^\'])*\'
                |(?:\s|[^,"\']*)
            )
        /ixS'

Definition at line 51 of file ValidatorResolver.php.

PATTERN_MATCH_VALIDATORS

const TYPO3\CMS\Extbase\Validation\ValidatorResolver::PATTERN_MATCH_VALIDATORS

Initial value:

= '/
            (?:^|,\s*)
            (?P<validatorName>[a-z0-9_:.\\\\]+)
            \s*
            (?:\(
                (?P<validatorOptions>(?:\s*[a-z0-9]+\s*=\s*(?:
                    "(?:\\\\"|[^"])*"
                    |\'(?:\\\\\'|[^\'])*\'
                    |(?:\s|[^,"\']*)
                )(?:\s|,)*)*)
            \))?
        /ixS'

Definition at line 34 of file ValidatorResolver.php.