Merge branch '2.8' into 3.3

nicolas-grekas · nicolas-grekas · commit 8edde101a281 · 2017-10-24T16:05:06.000+02:00
* 2.8:
  [DI] minor docblock fixes
diff --git a/ConstraintValidatorFactoryInterface.php b/ConstraintValidatorFactoryInterface.php
@@ -21,8 +21,6 @@ interface ConstraintValidatorFactoryInterface
      * Given a Constraint, this returns the ConstraintValidatorInterface
      * object that should be used to verify its validity.
      *
-     * @param Constraint $constraint The source constraint
-     *
      * @return ConstraintValidatorInterface
      */
     public function getInstance(Constraint $constraint);
diff --git a/ConstraintViolation.php b/ConstraintViolation.php
@@ -18,54 +18,15 @@
  */
 class ConstraintViolation implements ConstraintViolationInterface
 {
-    /**
-     * @var string
-     */
     private $message;
-
-    /**
-     * @var string
-     */
     private $messageTemplate;
-
-    /**
-     * @var array
-     */
     private $parameters;
-
-    /**
-     * @var int|null
-     */
     private $plural;
-
-    /**
-     * @var mixed
-     */
     private $root;
-
-    /**
-     * @var string
-     */
     private $propertyPath;
-
-    /**
-     * @var mixed
-     */
     private $invalidValue;
-
-    /**
-     * @var Constraint|null
-     */
     private $constraint;
-
-    /**
-     * @var mixed
-     */
     private $code;
-
-    /**
-     * @var mixed
-     */
     private $cause;
 
     /**
diff --git a/ConstraintViolationListInterface.php b/ConstraintViolationListInterface.php
@@ -20,15 +20,11 @@ interface ConstraintViolationListInterface extends \Traversable, \Countable, \Ar
 {
     /**
      * Adds a constraint violation to this list.
-     *
-     * @param ConstraintViolationInterface $violation The violation to add
      */
     public function add(ConstraintViolationInterface $violation);
 
     /**
      * Merges an existing violation list into this list.
-     *
-     * @param ConstraintViolationListInterface $otherList The list to merge
      */
     public function addAll(ConstraintViolationListInterface $otherList);
 
diff --git a/Constraints/IbanValidator.php b/Constraints/IbanValidator.php
@@ -34,8 +34,6 @@ class IbanValidator extends ConstraintValidator
      * included within it, a bank identifier with a fixed position and a fixed length per country
      *
      * @see https://www.swift.com/sites/default/files/resources/iban_registry.pdf
-     *
-     * @var array
      */
     private static $formats = array(
         'AD' => 'AD\d{2}\d{4}\d{4}[\dA-Z]{12}', // Andorra
diff --git a/Mapping/Cache/CacheInterface.php b/Mapping/Cache/CacheInterface.php
@@ -38,8 +38,6 @@ public function read($class);
 
     /**
      * Stores a class metadata in the cache.
-     *
-     * @param ClassMetadata $metadata A Class Metadata
      */
     public function write(ClassMetadata $metadata);
 }
diff --git a/Mapping/Cache/DoctrineCache.php b/Mapping/Cache/DoctrineCache.php
@@ -23,21 +23,11 @@ final class DoctrineCache implements CacheInterface
 {
     private $cache;
 
-    /**
-     * Creates a new Doctrine cache.
-     *
-     * @param Cache $cache The cache to adapt
-     */
     public function __construct(Cache $cache)
     {
         $this->cache = $cache;
     }
 
-    /**
-     * Sets the cache to adapt.
-     *
-     * @param Cache $cache The cache to adapt
-     */
     public function setCache(Cache $cache)
     {
         $this->cache = $cache;
diff --git a/Mapping/ClassMetadata.php b/Mapping/ClassMetadata.php
@@ -334,8 +334,6 @@ public function addGetterMethodConstraints($property, $method, array $constraint
 
     /**
      * Merges the constraints of the given metadata into this object.
-     *
-     * @param ClassMetadata $source The source metadata
      */
     public function mergeConstraints(ClassMetadata $source)
     {
@@ -502,11 +500,6 @@ public function getCascadingStrategy()
         return CascadingStrategy::NONE;
     }
 
-    /**
-     * Adds a property metadata.
-     *
-     * @param PropertyMetadataInterface $metadata
-     */
     private function addPropertyMetadata(PropertyMetadataInterface $metadata)
     {
         $property = $metadata->getPropertyName();
diff --git a/Mapping/GenericMetadata.php b/Mapping/GenericMetadata.php
@@ -114,8 +114,6 @@ public function __clone()
      *  - {@link TraversalStrategy::IMPLICIT} if $traverse is enabled
      *  - {@link TraversalStrategy::NONE} if $traverse is disabled
      *
-     * @param Constraint $constraint The constraint to add
-     *
      * @return $this
      *
      * @throws ConstraintDefinitionException When trying to add the
diff --git a/Mapping/Loader/AbstractLoader.php b/Mapping/Loader/AbstractLoader.php
@@ -32,9 +32,6 @@ abstract class AbstractLoader implements LoaderInterface
      */
     const DEFAULT_NAMESPACE = '\\Symfony\\Component\\Validator\\Constraints\\';
 
-    /**
-     * @var array
-     */
     protected $namespaces = array();
 
     /**
diff --git a/Mapping/Loader/LoaderInterface.php b/Mapping/Loader/LoaderInterface.php
@@ -23,8 +23,6 @@ interface LoaderInterface
     /**
      * Loads validation metadata into a {@link ClassMetadata} instance.
      *
-     * @param ClassMetadata $metadata The metadata to load
-     *
      * @return bool Whether the loader succeeded
      */
     public function loadClassMetadata(ClassMetadata $metadata);
diff --git a/Tests/Validator/AbstractTest.php b/Tests/Validator/AbstractTest.php
@@ -37,9 +37,6 @@ abstract class AbstractTest extends AbstractValidatorTest
     protected $validator;
 
     /**
-     * @param MetadataFactoryInterface $metadataFactory
-     * @param array                    $objectInitializers
-     *
      * @return ValidatorInterface
      */
     abstract protected function createValidator(MetadataFactoryInterface $metadataFactory, array $objectInitializers = array());
diff --git a/Validator/ValidatorInterface.php b/Validator/ValidatorInterface.php
@@ -91,8 +91,6 @@ public function startContext();
      * The returned validator adds all generated violations to the given
      * context.
      *
-     * @param ExecutionContextInterface $context The execution context
-     *
      * @return ContextualValidatorInterface The validator for that context
      */
     public function inContext(ExecutionContextInterface $context);
diff --git a/ValidatorBuilderInterface.php b/ValidatorBuilderInterface.php
@@ -27,16 +27,14 @@ interface ValidatorBuilderInterface
     /**
      * Adds an object initializer to the validator.
      *
-     * @param ObjectInitializerInterface $initializer The initializer
-     *
      * @return $this
      */
     public function addObjectInitializer(ObjectInitializerInterface $initializer);
 
     /**
      * Adds a list of object initializers to the validator.
      *
-     * @param array $initializers The initializer
+     * @param ObjectInitializerInterface[] $initializers
      *
      * @return $this
      */
@@ -54,7 +52,7 @@ public function addXmlMapping($path);
     /**
      * Adds a list of XML constraint mapping files to the validator.
      *
-     * @param array $paths The paths to the mapping files
+     * @param string[] $paths The paths to the mapping files
      *
      * @return $this
      */
@@ -72,7 +70,7 @@ public function addYamlMapping($path);
     /**
      * Adds a list of YAML constraint mappings file to the validator.
      *
-     * @param array $paths The paths to the mapping files
+     * @param string[] $paths The paths to the mapping files
      *
      * @return $this
      */
@@ -90,7 +88,7 @@ public function addMethodMapping($methodName);
     /**
      * Enables constraint mapping using the given static methods.
      *
-     * @param array $methodNames The names of the methods
+     * @param string[] $methodNames The names of the methods
      *
      * @return $this
      */
@@ -99,8 +97,6 @@ public function addMethodMappings(array $methodNames);
     /**
      * Enables annotation based constraint mapping.
      *
-     * @param Reader $annotationReader The annotation reader to be used
-     *
      * @return $this
      */
     public function enableAnnotationMapping(Reader $annotationReader = null);
@@ -115,35 +111,27 @@ public function disableAnnotationMapping();
     /**
      * Sets the class metadata factory used by the validator.
      *
-     * @param MetadataFactoryInterface $metadataFactory The metadata factory
-     *
      * @return $this
      */
     public function setMetadataFactory(MetadataFactoryInterface $metadataFactory);
 
     /**
      * Sets the cache for caching class metadata.
      *
-     * @param CacheInterface $cache The cache instance
-     *
      * @return $this
      */
     public function setMetadataCache(CacheInterface $cache);
 
     /**
      * Sets the constraint validator factory used by the validator.
      *
-     * @param ConstraintValidatorFactoryInterface $validatorFactory The validator factory
-     *
      * @return $this
      */
     public function setConstraintValidatorFactory(ConstraintValidatorFactoryInterface $validatorFactory);
 
     /**
      * Sets the translator used for translating violation messages.
      *
-     * @param TranslatorInterface $translator The translator instance
-     *
      * @return $this
      */
     public function setTranslator(TranslatorInterface $translator);

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,6 @@ interface ConstraintValidatorFactoryInterface`
`21`	`21`	`* Given a Constraint, this returns the ConstraintValidatorInterface`
`22`	`22`	`* object that should be used to verify its validity.`
`23`	`23`	`*`
`24`		`- * @param Constraint $constraint The source constraint`
`25`		`- *`
`26`	`24`	`* @return ConstraintValidatorInterface`
`27`	`25`	`*/`
`28`	`26`	`public function getInstance(Constraint $constraint);`
Original file line number	Diff line number	Diff line change
`@@ -34,8 +34,6 @@ class IbanValidator extends ConstraintValidator`
`34`	`34`	`* included within it, a bank identifier with a fixed position and a fixed length per country`
`35`	`35`	`*`
`36`	`36`	`* @see https://www.swift.com/sites/default/files/resources/iban_registry.pdf`
`37`		`- *`
`38`		`- * @var array`
`39`	`37`	`*/`
`40`	`38`	`private static $formats = array(`
`41`	`39`	`'AD' => 'AD\d{2}\d{4}\d{4}[\dA-Z]{12}', // Andorra`
Original file line number	Diff line number	Diff line change
`@@ -38,8 +38,6 @@ public function read($class);`
`38`	`38`
`39`	`39`	`/**`
`40`	`40`	`* Stores a class metadata in the cache.`
`41`		`- *`
`42`		`- * @param ClassMetadata $metadata A Class Metadata`
`43`	`41`	`*/`
`44`	`42`	`public function write(ClassMetadata $metadata);`
`45`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,21 +23,11 @@ final class DoctrineCache implements CacheInterface`
`23`	`23`	`{`
`24`	`24`	`private $cache;`
`25`	`25`
`26`		`- /**`
`27`		`- * Creates a new Doctrine cache.`
`28`		`- *`
`29`		`- * @param Cache $cache The cache to adapt`
`30`		`- */`
`31`	`26`	`public function __construct(Cache $cache)`
`32`	`27`	`{`
`33`	`28`	`$this->cache = $cache;`
`34`	`29`	`}`
`35`	`30`
`36`		`- /**`
`37`		`- * Sets the cache to adapt.`
`38`		`- *`
`39`		`- * @param Cache $cache The cache to adapt`
`40`		`- */`
`41`	`31`	`public function setCache(Cache $cache)`
`42`	`32`	`{`
`43`	`33`	`$this->cache = $cache;`
Original file line number	Diff line number	Diff line change
`@@ -334,8 +334,6 @@ public function addGetterMethodConstraints($property, $method, array $constraint`
`334`	`334`
`335`	`335`	`/**`
`336`	`336`	`* Merges the constraints of the given metadata into this object.`
`337`		`- *`
`338`		`- * @param ClassMetadata $source The source metadata`
`339`	`337`	`*/`
`340`	`338`	`public function mergeConstraints(ClassMetadata $source)`
`341`	`339`	`{`
`@@ -502,11 +500,6 @@ public function getCascadingStrategy()`
`502`	`500`	`return CascadingStrategy::NONE;`
`503`	`501`	`}`
`504`	`502`
`505`		`- /**`
`506`		`- * Adds a property metadata.`
`507`		`- *`
`508`		`- * @param PropertyMetadataInterface $metadata`
`509`		`- */`
`510`	`503`	`private function addPropertyMetadata(PropertyMetadataInterface $metadata)`
`511`	`504`	`{`
`512`	`505`	`$property = $metadata->getPropertyName();`
Original file line number	Diff line number	Diff line change
`@@ -114,8 +114,6 @@ public function __clone()`
`114`	`114`	`* - {@link TraversalStrategy::IMPLICIT} if $traverse is enabled`
`115`	`115`	`* - {@link TraversalStrategy::NONE} if $traverse is disabled`
`116`	`116`	`*`
`117`		`- * @param Constraint $constraint The constraint to add`
`118`		`- *`
`119`	`117`	`* @return $this`
`120`	`118`	`*`
`121`	`119`	`* @throws ConstraintDefinitionException When trying to add the`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,6 @@ interface LoaderInterface`
`23`	`23`	`/**`
`24`	`24`	`* Loads validation metadata into a {@link ClassMetadata} instance.`
`25`	`25`	`*`
`26`		`- * @param ClassMetadata $metadata The metadata to load`
`27`		`- *`
`28`	`26`	`* @return bool Whether the loader succeeded`
`29`	`27`	`*/`
`30`	`28`	`public function loadClassMetadata(ClassMetadata $metadata);`