A configurable builder for ValidatorInterface objects.
@author Bernhard Schussek <bschussek@gmail.com>
Expanded class hierarchy of ValidatorBuilderInterface
All classes that implement ValidatorBuilderInterface
interface ValidatorBuilderInterface {
/**
* Adds an object initializer to the validator.
*
* @param ObjectInitializerInterface $initializer The initializer.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addObjectInitializer(ObjectInitializerInterface $initializer);
/**
* Adds a list of object initializers to the validator.
*
* @param array $initializers The initializer.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addObjectInitializers(array $initializers);
/**
* Adds an XML constraint mapping file to the validator.
*
* @param string $path The path to the mapping file.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addXmlMapping($path);
/**
* Adds a list of XML constraint mapping files to the validator.
*
* @param array $paths The paths to the mapping files.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addXmlMappings(array $paths);
/**
* Adds a YAML constraint mapping file to the validator.
*
* @param string $path The path to the mapping file.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addYamlMapping($path);
/**
* Adds a list of YAML constraint mappings file to the validator.
*
* @param array $paths The paths to the mapping files.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addYamlMappings(array $paths);
/**
* Enables constraint mapping using the given static method.
*
* @param string $methodName The name of the method.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addMethodMapping($methodName);
/**
* Enables constraint mapping using the given static methods.
*
* @param array $methodNames The names of the methods.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function addMethodMappings(array $methodNames);
/**
* Enables annotation based constraint mapping.
*
* @param Reader $annotationReader The annotation reader to be used.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function enableAnnotationMapping(Reader $annotationReader = null);
/**
* Disables annotation based constraint mapping.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function disableAnnotationMapping();
/**
* Sets the class metadata factory used by the validator.
*
* @param MetadataFactoryInterface $metadataFactory The metadata factory.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function setMetadataFactory(MetadataFactoryInterface $metadataFactory);
/**
* Sets the cache for caching class metadata.
*
* @param CacheInterface $cache The cache instance.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function setMetadataCache(CacheInterface $cache);
/**
* Sets the constraint validator factory used by the validator.
*
* @param ConstraintValidatorFactoryInterface $validatorFactory The validator factory.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function setConstraintValidatorFactory(ConstraintValidatorFactoryInterface $validatorFactory);
/**
* Sets the translator used for translating violation messages.
*
* @param TranslatorInterface $translator The translator instance.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function setTranslator(TranslatorInterface $translator);
/**
* 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.
*
* @param string $translationDomain The translation domain of the violation messages.
*
* @return ValidatorBuilderInterface The builder object.
*/
public function setTranslationDomain($translationDomain);
/**
* Builds and returns a new validator object.
*
* @return ValidatorInterface The built validator.
*/
public function getValidator();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ValidatorBuilderInterface:: |
public | function | Enables constraint mapping using the given static method. | 1 |
ValidatorBuilderInterface:: |
public | function | Enables constraint mapping using the given static methods. | 1 |
ValidatorBuilderInterface:: |
public | function | Adds an object initializer to the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Adds a list of object initializers to the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Adds an XML constraint mapping file to the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Adds a list of XML constraint mapping files to the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Adds a YAML constraint mapping file to the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Adds a list of YAML constraint mappings file to the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Disables annotation based constraint mapping. | 1 |
ValidatorBuilderInterface:: |
public | function | Enables annotation based constraint mapping. | 1 |
ValidatorBuilderInterface:: |
public | function | Builds and returns a new validator object. | 1 |
ValidatorBuilderInterface:: |
public | function | Sets the constraint validator factory used by the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Sets the cache for caching class metadata. | 1 |
ValidatorBuilderInterface:: |
public | function | Sets the class metadata factory used by the validator. | 1 |
ValidatorBuilderInterface:: |
public | function | Sets the default translation domain of violation messages. | 1 |
ValidatorBuilderInterface:: |
public | function | Sets the translator used for translating violation messages. | 1 |