ValidatorBuilder
class ValidatorBuilder implements ValidatorBuilderInterface
The default implementation of {@link ValidatorBuilderInterface}.
Methods
| ValidatorBuilderInterface | addObjectInitializer(ObjectInitializerInterface $initializer) Adds an object initializer to the validator. | |
| ValidatorBuilderInterface | addObjectInitializers(array $initializers) Adds a list of object initializers to the validator. | |
| ValidatorBuilderInterface | addXmlMapping(string $path) Adds an XML constraint mapping file to the validator. | |
| ValidatorBuilderInterface | addXmlMappings(array $paths) Adds a list of XML constraint mapping files to the validator. | |
| ValidatorBuilderInterface | addYamlMapping(string $path) Adds a YAML constraint mapping file to the validator. | |
| ValidatorBuilderInterface | addYamlMappings(array $paths) Adds a list of YAML constraint mappings file to the validator. | |
| ValidatorBuilderInterface | addMethodMapping(string $methodName) Enables constraint mapping using the given static method. | |
| ValidatorBuilderInterface | addMethodMappings(array $methodNames) Enables constraint mapping using the given static methods. | |
| ValidatorBuilderInterface | enableAnnotationMapping(Reader $annotationReader = null) Enables annotation based constraint mapping. | |
| ValidatorBuilderInterface | disableAnnotationMapping() Disables annotation based constraint mapping. | |
| ValidatorBuilderInterface | setMetadataFactory(MetadataFactoryInterface $metadataFactory) Sets the class metadata factory used by the validator. | |
| ValidatorBuilderInterface | setMetadataCache(CacheInterface $cache) Sets the cache for caching class metadata. | |
| ValidatorBuilderInterface | setConstraintValidatorFactory(ConstraintValidatorFactoryInterface $validatorFactory) Sets the constraint validator factory used by the validator. | |
| ValidatorBuilderInterface | setTranslator(TranslatorInterface $translator) Sets the translator used for translating violation messages. | |
| ValidatorBuilderInterface | setTranslationDomain(string $translationDomain) Sets the default translation domain of violation messages. | |
| ValidatorBuilderInterface | setPropertyAccessor(PropertyAccessorInterface $propertyAccessor) deprecated Sets the property accessor for resolving property paths. | |
| ValidatorBuilderInterface | setApiVersion(int $apiVersion) deprecated Sets the API version that the returned validator should support. | |
| ValidatorInterface | getValidator() Builds and returns a new validator object. |
Details
ValidatorBuilderInterface addObjectInitializer(ObjectInitializerInterface $initializer)
Adds an object initializer to the validator.
Parameters
| ObjectInitializerInterface | $initializer | The initializer |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface addObjectInitializers(array $initializers)
Adds a list of object initializers to the validator.
Parameters
| array | $initializers | The initializer |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface addXmlMapping(string $path)
Adds an XML constraint mapping file to the validator.
Parameters
| string | $path | The path to the mapping file |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface addXmlMappings(array $paths)
Adds a list of XML constraint mapping files to the validator.
Parameters
| array | $paths | The paths to the mapping files |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface addYamlMapping(string $path)
Adds a YAML constraint mapping file to the validator.
Parameters
| string | $path | The path to the mapping file |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface addYamlMappings(array $paths)
Adds a list of YAML constraint mappings file to the validator.
Parameters
| array | $paths | The paths to the mapping files |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface addMethodMapping(string $methodName)
Enables constraint mapping using the given static method.
Parameters
| string | $methodName | The name of the method |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface addMethodMappings(array $methodNames)
Enables constraint mapping using the given static methods.
Parameters
| array | $methodNames | The names of the methods |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface enableAnnotationMapping(Reader $annotationReader = null)
Enables annotation based constraint mapping.
Parameters
| Reader | $annotationReader | The annotation reader to be used |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface disableAnnotationMapping()
Disables annotation based constraint mapping.
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface setMetadataFactory(MetadataFactoryInterface $metadataFactory)
Sets the class metadata factory used by the validator.
Parameters
| MetadataFactoryInterface | $metadataFactory | The metadata factory |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface setMetadataCache(CacheInterface $cache)
Sets the cache for caching class metadata.
Parameters
| CacheInterface | $cache | The cache instance |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface setConstraintValidatorFactory(ConstraintValidatorFactoryInterface $validatorFactory)
Sets the constraint validator factory used by the validator.
Parameters
| ConstraintValidatorFactoryInterface | $validatorFactory | The validator factory |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface setTranslator(TranslatorInterface $translator)
Sets the translator used for translating violation messages.
Parameters
| TranslatorInterface | $translator | The translator instance |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface setTranslationDomain(string $translationDomain)
Sets the default translation domain of violation messages.
The same message can have different translations in different domains. Pass the domain that is used for violation messages by default to this method.
Parameters
| string | $translationDomain | The translation domain of the violation messages |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface setPropertyAccessor(PropertyAccessorInterface $propertyAccessor) deprecated
deprecated
Sets the property accessor for resolving property paths.
Parameters
| PropertyAccessorInterface | $propertyAccessor | The property accessor |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorBuilderInterface setApiVersion(int $apiVersion) deprecated
deprecated
Sets the API version that the returned validator should support.
Parameters
| int | $apiVersion | The required API version |
Return Value
| ValidatorBuilderInterface | The builder object |
ValidatorInterface getValidator()
Builds and returns a new validator object.
Return Value
| ValidatorInterface | The built validator. |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Validator/ValidatorBuilder.html