[Validator] Added deprecation notes

webmozart · webmozart · commit 85583779450d · 2014-03-30T18:28:57.000+02:00
diff --git a/src/Symfony/Component/Validator/ClassBasedInterface.php b/src/Symfony/Component/Validator/ClassBasedInterface.php
@@ -15,6 +15,9 @@
  * An object backed by a PHP class.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Mapping\ClassMetadataInterface} instead.
  */
 interface ClassBasedInterface
 {
diff --git a/src/Symfony/Component/Validator/Constraints/GroupSequence.php b/src/Symfony/Component/Validator/Constraints/GroupSequence.php
@@ -99,7 +99,7 @@ public function __construct(array $groups)
      * @see \IteratorAggregate::getIterator()
      *
      * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
-     *             To be removed in 3.0.
+     *             To be removed in Symfony 3.0.
      */
     public function getIterator()
     {
@@ -114,7 +114,7 @@ public function getIterator()
      * @return Boolean Whether the offset exists
      *
      * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
-     *             To be removed in 3.0.
+     *             To be removed in Symfony 3.0.
      */
     public function offsetExists($offset)
     {
@@ -131,7 +131,7 @@ public function offsetExists($offset)
      * @throws OutOfBoundsException If the object does not exist
      *
      * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
-     *             To be removed in 3.0.
+     *             To be removed in Symfony 3.0.
      */
     public function offsetGet($offset)
     {
@@ -152,7 +152,7 @@ public function offsetGet($offset)
      * @param string  $value  The group name
      *
      * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
-     *             To be removed in 3.0.
+     *             To be removed in Symfony 3.0.
      */
     public function offsetSet($offset, $value)
     {
@@ -171,7 +171,7 @@ public function offsetSet($offset, $value)
      * @param integer $offset The offset
      *
      * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
-     *             To be removed in 3.0.
+     *             To be removed in Symfony 3.0.
      */
     public function offsetUnset($offset)
     {
@@ -184,7 +184,7 @@ public function offsetUnset($offset)
      * @return integer The number of groups
      *
      * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
-     *             To be removed in 3.0.
+     *             To be removed in Symfony 3.0.
      */
     public function count()
     {
diff --git a/src/Symfony/Component/Validator/Context/LegacyExecutionContext.php b/src/Symfony/Component/Validator/Context/LegacyExecutionContext.php
@@ -25,8 +25,8 @@
  * @since  2.5
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
- * @deprecated Implemented for backwards compatibility with Symfony < 2.5. To be
- *             removed in 3.0.
+ * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
+ *             To be removed in Symfony 3.0.
  */
 class LegacyExecutionContext extends ExecutionContext
 {
diff --git a/src/Symfony/Component/Validator/Context/LegacyExecutionContextFactory.php b/src/Symfony/Component/Validator/Context/LegacyExecutionContextFactory.php
@@ -21,8 +21,8 @@
  * @since  2.5
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
- * @deprecated Implemented for backwards compatibility with Symfony < 2.5. To be
- *             removed in 3.0.
+ * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
+ *             To be removed in Symfony 3.0.
  */
 class LegacyExecutionContextFactory implements ExecutionContextFactoryInterface
 {
diff --git a/src/Symfony/Component/Validator/ExecutionContext.php b/src/Symfony/Component/Validator/ExecutionContext.php
@@ -20,6 +20,9 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Context\ExecutionContext} instead.
  */
 class ExecutionContext implements ExecutionContextInterface
 {
diff --git a/src/Symfony/Component/Validator/ExecutionContextInterface.php b/src/Symfony/Component/Validator/ExecutionContextInterface.php
@@ -82,6 +82,9 @@
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @api
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Context\ExecutionContextInterface} instead.
  */
 interface ExecutionContextInterface
 {
@@ -95,6 +98,10 @@ interface ExecutionContextInterface
      * @param integer|null $code          The violation code.
      *
      * @api
+     *
+     * @deprecated The parameters $invalidValue, $pluralization and $code are
+     *             deprecated since version 2.5 and will be removed in
+     *             Symfony 3.0.
      */
     public function addViolation($message, array $params = array(), $invalidValue = null, $pluralization = null, $code = null);
 
@@ -110,6 +117,10 @@ public function addViolation($message, array $params = array(), $invalidValue =
      * @param integer|null $code          The violation code.
      *
      * @api
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+     *             Use {@link Context\ExecutionContextInterface::buildViolation()}
+     *             instead.
      */
     public function addViolationAt($subPath, $message, array $parameters = array(), $invalidValue = null, $pluralization = null, $code = null);
 
@@ -151,6 +162,10 @@ public function addViolationAt($subPath, $message, array $parameters = array(),
      *                                       or an instance of <tt>\Traversable</tt>.
      * @param Boolean              $deep     Whether to traverse the value recursively if
      *                                       it is a collection of collections.
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+     *             Use {@link Context\ExecutionContextInterface::getValidator()}
+     *             instead.
      */
     public function validate($value, $subPath = '', $groups = null, $traverse = false, $deep = false);
 
@@ -180,6 +195,10 @@ public function validate($value, $subPath = '', $groups = null, $traverse = fals
      * @param null|string|string[]    $groups      The groups to validate in. If you don't pass any
      *                                             groups here, the current group of the context
      *                                             will be used.
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+     *             Use {@link Context\ExecutionContextInterface::getValidator()}
+     *             instead.
      */
     public function validateValue($value, $constraints, $subPath = '', $groups = null);
 
@@ -237,6 +256,12 @@ public function getMetadata();
      * Returns the used metadata factory.
      *
      * @return MetadataFactoryInterface The metadata factory.
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+     *             Use {@link Context\ExecutionContextInterface::getValidator()}
+     *             instead and call
+     *             {@link Validator\ValidatorInterface::getMetadataFor()} or
+     *             {@link Validator\ValidatorInterface::hasMetadataFor()} there.
      */
     public function getMetadataFactory();
 
diff --git a/src/Symfony/Component/Validator/GlobalExecutionContextInterface.php b/src/Symfony/Component/Validator/GlobalExecutionContextInterface.php
@@ -26,6 +26,9 @@
  * </ul>
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Context\ExecutionContextInterface} instead.
  */
 interface GlobalExecutionContextInterface
 {
diff --git a/src/Symfony/Component/Validator/MetadataInterface.php b/src/Symfony/Component/Validator/MetadataInterface.php
@@ -41,6 +41,9 @@
  * again.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Mapping\MetadataInterface} instead.
  */
 interface MetadataInterface
 {
@@ -54,6 +57,8 @@ interface MetadataInterface
      * @param mixed                      $value        The value to validate.
      * @param string|string[]            $group        The validation group to validate in.
      * @param string                     $propertyPath The current property path in the validation graph.
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
      */
     public function accept(ValidationVisitorInterface $visitor, $value, $group, $propertyPath);
 
diff --git a/src/Symfony/Component/Validator/PropertyMetadataContainerInterface.php b/src/Symfony/Component/Validator/PropertyMetadataContainerInterface.php
@@ -15,6 +15,9 @@
  * A container for {@link PropertyMetadataInterface} instances.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Mapping\ClassMetadataInterface} instead.
  */
 interface PropertyMetadataContainerInterface
 {
diff --git a/src/Symfony/Component/Validator/PropertyMetadataInterface.php b/src/Symfony/Component/Validator/PropertyMetadataInterface.php
@@ -23,6 +23,9 @@
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @see MetadataInterface
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Mapping\PropertyMetadataInterface} instead.
  */
 interface PropertyMetadataInterface extends MetadataInterface
 {
diff --git a/src/Symfony/Component/Validator/ValidationVisitor.php b/src/Symfony/Component/Validator/ValidationVisitor.php
@@ -20,6 +20,9 @@
  * {@link GlobalExecutionContextInterface}.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link NodeVisitor\NodeVisitorInterface} instead.
  */
 class ValidationVisitor implements ValidationVisitorInterface, GlobalExecutionContextInterface
 {
diff --git a/src/Symfony/Component/Validator/ValidationVisitorInterface.php b/src/Symfony/Component/Validator/ValidationVisitorInterface.php
@@ -33,6 +33,9 @@
  * </ol>
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link NodeVisitor\NodeVisitorInterface} instead.
  */
 interface ValidationVisitorInterface
 {
@@ -62,6 +65,8 @@ interface ValidationVisitorInterface
      *
      * @throws Exception\NoSuchMetadataException If no metadata can be found for
      *                                           the given value.
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
      */
     public function validate($value, $group, $propertyPath, $traverse = false, $deep = false);
 
@@ -75,6 +80,8 @@ public function validate($value, $group, $propertyPath, $traverse = false, $deep
      * @param mixed             $value        The value to validate.
      * @param string            $group        The validation group to validate.
      * @param string            $propertyPath The current property path in the validation graph.
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
      */
     public function visit(MetadataInterface $metadata, $value, $group, $propertyPath);
 }
diff --git a/src/Symfony/Component/Validator/Validator.php b/src/Symfony/Component/Validator/Validator.php
@@ -20,6 +20,9 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Validator\Validator} instead.
  */
 class Validator implements ValidatorInterface
 {
diff --git a/src/Symfony/Component/Validator/Validator/LegacyValidator.php b/src/Symfony/Component/Validator/Validator/LegacyValidator.php
@@ -17,8 +17,11 @@
 use Symfony\Component\Validator\ValidatorInterface as LegacyValidatorInterface;
 
 /**
- * @since  %%NextVersion%%
+ * @since  2.5
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @deprecated Implemented for backwards compatibility with Symfony < 2.5.
+ *             To be removed in Symfony 3.0.
  */
 class LegacyValidator extends Validator implements LegacyValidatorInterface
 {
diff --git a/src/Symfony/Component/Validator/ValidatorInterface.php b/src/Symfony/Component/Validator/ValidatorInterface.php
@@ -17,6 +17,9 @@
  * @author Bernhard Schussek <bschussek@gmail.com>
  *
  * @api
+ *
+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+ *             Use {@link Validator\ValidatorInterface} instead.
  */
 interface ValidatorInterface
 {
@@ -35,6 +38,10 @@ interface ValidatorInterface
      *                                          list is empty, validation succeeded.
      *
      * @api
+     *
+     * @deprecated The signature changed with Symfony 2.5 (see
+     *             {@link Validator\ValidatorInterface::validate()}. This
+     *             signature will be disabled in Symfony 3.0.
      */
     public function validate($value, $groups = null, $traverse = false, $deep = false);
 
@@ -85,6 +92,9 @@ public function validatePropertyValue($containingValue, $property, $value, $grou
      *                                          list is empty, validation succeeded.
      *
      * @api
+     *
+     * @deprecated Renamed to {@link Validator\ValidatorInterface::validate()}
+     *             in Symfony 2.5. Will be removed in Symfony 3.0.
      */
     public function validateValue($value, $constraints, $groups = null);
 
@@ -94,6 +104,11 @@ public function validateValue($value, $constraints, $groups = null);
      * @return MetadataFactoryInterface The metadata factory.
      *
      * @api
+     *
+     * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.
+     *             Use {@link Validator\ValidatorInterface::getMetadataFor()} or
+     *             {@link Validator\ValidatorInterface::hasMetadataFor()}
+     *             instead.
      */
     public function getMetadataFactory();
 }

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,9 @@`
`15`	`15`	`* An object backed by a PHP class.`
`16`	`16`	`*`
`17`	`17`	`* @author Bernhard Schussek <[email protected]>`
	`18`	`+ *`
	`19`	`+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.`
	`20`	`+ * Use {@link Mapping\ClassMetadataInterface} instead.`
`18`	`21`	`*/`
`19`	`22`	`interface ClassBasedInterface`
`20`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public function __construct(array $groups)`
`99`	`99`	`* @see \IteratorAggregate::getIterator()`
`100`	`100`	`*`
`101`	`101`	`* @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
`102`		`- * To be removed in 3.0.`
	`102`	`+ * To be removed in Symfony 3.0.`
`103`	`103`	`*/`
`104`	`104`	`public function getIterator()`
`105`	`105`	`{`
`@@ -114,7 +114,7 @@ public function getIterator()`
`114`	`114`	`* @return Boolean Whether the offset exists`
`115`	`115`	`*`
`116`	`116`	`* @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
`117`		`- * To be removed in 3.0.`
	`117`	`+ * To be removed in Symfony 3.0.`
`118`	`118`	`*/`
`119`	`119`	`public function offsetExists($offset)`
`120`	`120`	`{`
`@@ -131,7 +131,7 @@ public function offsetExists($offset)`
`131`	`131`	`* @throws OutOfBoundsException If the object does not exist`
`132`	`132`	`*`
`133`	`133`	`* @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
`134`		`- * To be removed in 3.0.`
	`134`	`+ * To be removed in Symfony 3.0.`
`135`	`135`	`*/`
`136`	`136`	`public function offsetGet($offset)`
`137`	`137`	`{`
`@@ -152,7 +152,7 @@ public function offsetGet($offset)`
`152`	`152`	`* @param string $value The group name`
`153`	`153`	`*`
`154`	`154`	`* @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
`155`		`- * To be removed in 3.0.`
	`155`	`+ * To be removed in Symfony 3.0.`
`156`	`156`	`*/`
`157`	`157`	`public function offsetSet($offset, $value)`
`158`	`158`	`{`
`@@ -171,7 +171,7 @@ public function offsetSet($offset, $value)`
`171`	`171`	`* @param integer $offset The offset`
`172`	`172`	`*`
`173`	`173`	`* @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
`174`		`- * To be removed in 3.0.`
	`174`	`+ * To be removed in Symfony 3.0.`
`175`	`175`	`*/`
`176`	`176`	`public function offsetUnset($offset)`
`177`	`177`	`{`
`@@ -184,7 +184,7 @@ public function offsetUnset($offset)`
`184`	`184`	`* @return integer The number of groups`
`185`	`185`	`*`
`186`	`186`	`* @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
`187`		`- * To be removed in 3.0.`
	`187`	`+ * To be removed in Symfony 3.0.`
`188`	`188`	`*/`
`189`	`189`	`public function count()`
`190`	`190`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,8 @@`
`25`	`25`	`* @since 2.5`
`26`	`26`	`* @author Bernhard Schussek <[email protected]>`
`27`	`27`	`*`
`28`		`- * @deprecated Implemented for backwards compatibility with Symfony < 2.5. To be`
`29`		`- * removed in 3.0.`
	`28`	`+ * @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
	`29`	`+ * To be removed in Symfony 3.0.`
`30`	`30`	`*/`
`31`	`31`	`class LegacyExecutionContext extends ExecutionContext`
`32`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@`
`21`	`21`	`* @since 2.5`
`22`	`22`	`* @author Bernhard Schussek <[email protected]>`
`23`	`23`	`*`
`24`		`- * @deprecated Implemented for backwards compatibility with Symfony < 2.5. To be`
`25`		`- * removed in 3.0.`
	`24`	`+ * @deprecated Implemented for backwards compatibility with Symfony < 2.5.`
	`25`	`+ * To be removed in Symfony 3.0.`
`26`	`26`	`*/`
`27`	`27`	`class LegacyExecutionContextFactory implements ExecutionContextFactoryInterface`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,9 @@`
`20`	`20`	`*`
`21`	`21`	`* @author Fabien Potencier <[email protected]>`
`22`	`22`	`* @author Bernhard Schussek <[email protected]>`
	`23`	`+ *`
	`24`	`+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.`
	`25`	`+ * Use {@link Context\ExecutionContext} instead.`
`23`	`26`	`*/`
`24`	`27`	`class ExecutionContext implements ExecutionContextInterface`
`25`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,9 @@`
`26`	`26`	`* </ul>`
`27`	`27`	`*`
`28`	`28`	`* @author Bernhard Schussek <[email protected]>`
	`29`	`+ *`
	`30`	`+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.`
	`31`	`+ * Use {@link Context\ExecutionContextInterface} instead.`
`29`	`32`	`*/`
`30`	`33`	`interface GlobalExecutionContextInterface`
`31`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,9 @@`
`23`	`23`	`* @author Bernhard Schussek <[email protected]>`
`24`	`24`	`*`
`25`	`25`	`* @see MetadataInterface`
	`26`	`+ *`
	`27`	`+ * @deprecated Deprecated since version 2.5, to be removed in Symfony 3.0.`
	`28`	`+ * Use {@link Mapping\PropertyMetadataInterface} instead.`
`26`	`29`	`*/`
`27`	`30`	`interface PropertyMetadataInterface extends MetadataInterface`
`28`	`31`	`{`