updated docblocks for ValidatorBuilderInterface

This commit is contained in:
Andreas Hucks 2012-08-23 11:12:01 +02:00
parent b5aaf534ab
commit fec11aec01

View File

@ -26,6 +26,8 @@ interface ValidatorBuilderInterface
* Adds an object initializer to the validator. * Adds an object initializer to the validator.
* *
* @param ObjectInitializerInterface $initializer The initializer. * @param ObjectInitializerInterface $initializer The initializer.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addObjectInitializer(ObjectInitializerInterface $initializer); public function addObjectInitializer(ObjectInitializerInterface $initializer);
@ -33,6 +35,8 @@ interface ValidatorBuilderInterface
* Adds a list of object initializers to the validator. * Adds a list of object initializers to the validator.
* *
* @param array $initializers The initializer. * @param array $initializers The initializer.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addObjectInitializers(array $initializers); public function addObjectInitializers(array $initializers);
@ -40,6 +44,8 @@ interface ValidatorBuilderInterface
* Adds an XML constraint mapping file to the validator. * Adds an XML constraint mapping file to the validator.
* *
* @param string $path The path to the mapping file. * @param string $path The path to the mapping file.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addXmlMapping($path); public function addXmlMapping($path);
@ -47,6 +53,8 @@ interface ValidatorBuilderInterface
* Adds a list of XML constraint mapping files to the validator. * Adds a list of XML constraint mapping files to the validator.
* *
* @param array $paths The paths to the mapping files. * @param array $paths The paths to the mapping files.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addXmlMappings(array $paths); public function addXmlMappings(array $paths);
@ -54,6 +62,8 @@ interface ValidatorBuilderInterface
* Adds a YAML constraint mapping file to the validator. * Adds a YAML constraint mapping file to the validator.
* *
* @param string $path The path to the mapping file. * @param string $path The path to the mapping file.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addYamlMapping($path); public function addYamlMapping($path);
@ -61,6 +71,8 @@ interface ValidatorBuilderInterface
* Adds a list of YAML constraint mappings file to the validator. * Adds a list of YAML constraint mappings file to the validator.
* *
* @param array $paths The paths to the mapping files. * @param array $paths The paths to the mapping files.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addYamlMappings(array $paths); public function addYamlMappings(array $paths);
@ -68,6 +80,8 @@ interface ValidatorBuilderInterface
* Enables constraint mapping using the given static method. * Enables constraint mapping using the given static method.
* *
* @param string $methodName The name of the method. * @param string $methodName The name of the method.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addMethodMapping($methodName); public function addMethodMapping($methodName);
@ -75,6 +89,8 @@ interface ValidatorBuilderInterface
* Enables constraint mapping using the given static methods. * Enables constraint mapping using the given static methods.
* *
* @param array $methodNames The names of the methods. * @param array $methodNames The names of the methods.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function addMethodMappings(array $methodNames); public function addMethodMappings(array $methodNames);
@ -82,11 +98,15 @@ interface ValidatorBuilderInterface
* Enables annotation based constraint mapping. * Enables annotation based constraint mapping.
* *
* @param Reader $annotationReader The annotation reader to be used. * @param Reader $annotationReader The annotation reader to be used.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function enableAnnotationMapping(Reader $annotationReader = null); public function enableAnnotationMapping(Reader $annotationReader = null);
/** /**
* Disables annotation based constraint mapping. * Disables annotation based constraint mapping.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function disableAnnotationMapping(); public function disableAnnotationMapping();
@ -94,6 +114,8 @@ interface ValidatorBuilderInterface
* Sets the class metadata factory used by the validator. * Sets the class metadata factory used by the validator.
* *
* @param ClassMetadataFactoryInterface $metadataFactory The metadata factory. * @param ClassMetadataFactoryInterface $metadataFactory The metadata factory.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function setMetadataFactory(ClassMetadataFactoryInterface $metadataFactory); public function setMetadataFactory(ClassMetadataFactoryInterface $metadataFactory);
@ -101,6 +123,8 @@ interface ValidatorBuilderInterface
* Sets the cache for caching class metadata. * Sets the cache for caching class metadata.
* *
* @param CacheInterface $cache The cache instance. * @param CacheInterface $cache The cache instance.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function setMetadataCache(CacheInterface $cache); public function setMetadataCache(CacheInterface $cache);
@ -108,6 +132,8 @@ interface ValidatorBuilderInterface
* Sets the constraint validator factory used by the validator. * Sets the constraint validator factory used by the validator.
* *
* @param ConstraintValidatorFactoryInterface $validatorFactory The validator factory. * @param ConstraintValidatorFactoryInterface $validatorFactory The validator factory.
*
* @return ValidatorBuilderInterface The builder object.
*/ */
public function setConstraintValidatorFactory(ConstraintValidatorFactoryInterface $validatorFactory); public function setConstraintValidatorFactory(ConstraintValidatorFactoryInterface $validatorFactory);