Adding details about the 2.4 API as comments

symfony · weaverryan · Oct 18, 2014 · Jul 25, 2014 · Aug 22, 2014 · Aug 8, 2014
commit 280440ea734e77cfe7ccfc1b100ad81940cd402c
diff --git a/cookbook/validation/custom_constraint.rst b/cookbook/validation/custom_constraint.rst
@@ -65,28 +65,34 @@ The validator class is also simple, and only has one required method ``validate(
         public function validate($value, Constraint $constraint)
         {
             if (!preg_match('/^[a-zA-Za0-9]+$/', $value, $matches)) {
+                // If you're using the new 2.5 validation API (you probably are!)
                 $this->context->buildViolation($constraint->message)
                     ->setParameter('%string%', $value)
                     ->addViolation();
                 );
+
+                // If you're using the old 2.4 validation API
+                /*
+                $this->context->addViolation(
+                    $constraint->message,
+                    array('%string%' => $value)
+                );
+                */
             }
         }
     }
 
-.. note::
-
-    The ``validate`` method does not return a value; instead, it adds violations
-    to the validator's ``context`` property. Therefore, a value could be considered
-    as being valid if it causes no violations to be added to the context.The
-    violation is constructed and added to the context using a
-    ``ConstraintViolationBuilder`` returned by the ``buildViolation`` method
-    call. The parameter given to the ``buildViolation`` call is the error message
-    to use for that violation. The ``addViolation`` method call finally adds the
-    violation to the context.
+Inside ``validate``, you don't need to return a value. Instead, you add violations
+to the validator's ``context`` property and a value will be considered valid
+if it causes no violations. The ``buildViolation`` takes the error message
+as its argument and returns an instance of
+:class:`Symfony\\Component\\Validator\\Violation\\ConstraintViolationBuilder`
+The ``addViolation`` method call finally adds the violation to the context.
 
 .. versionadded:: 2.5
-    The ``buildViolation`` method was added in Symfony 2.5. For usage examples with
-    older Symfony versions, see the corresponding versions of this documentation page.
+    The ``buildViolation`` method was added in Symfony 2.5. For usage examples
+    with older Symfony versions, see the corresponding versions of this documentation
+    page.
 
 Using the new Validator
 -----------------------

diff --git a/reference/constraints/Callback.rst b/reference/constraints/Callback.rst
@@ -51,6 +51,8 @@ Configuration
 
         use Symfony\Component\Validator\Constraints as Assert;
         use Symfony\Component\Validator\Context\ExecutionContextInterface;
+        // if you're using the older 2.4 validation API, you'll need this instead
+        // use Symfony\Component\Validator\ExecutionContextInterface;
 
         class Author
         {
@@ -101,6 +103,8 @@ those errors should be attributed::
 
     // ...
     use Symfony\Component\Validator\Context\ExecutionContextInterface;
+    // if you're using the older 2.4 validation API, you'll need this instead
+    // use Symfony\Component\Validator\ExecutionContextInterface;
 
     class Author
     {
@@ -114,16 +118,26 @@ those errors should be attributed::
 
             // check if the name is actually a fake name
             if (in_array($this->getFirstName(), $fakeNames)) {
+                // If you're using the new 2.5 validation API (you probably are!)
                 $context->buildViolation('This name sounds totally fake!')
                     ->atPath('firstName')
                     ->addViolation();
+
+                // If you're using the old 2.4 validation API
+                /*
+                $context->addViolationAt(
+                    'firstName',
+                    'This name sounds totally fake!'
+                );
+                */
             }
         }
     }
 
 .. versionadded:: 2.5
-    The ``buildViolation`` method was added in Symfony 2.5. For usage examples with
-    older Symfony versions, see the corresponding versions of this documentation page.
+    The ``buildViolation`` method was added in Symfony 2.5. For usage examples
+    with older Symfony versions, see the corresponding versions of this documentation
+    page.
 
 Static Callbacks
 ----------------
@@ -138,10 +152,17 @@ have access to the object instance, they receive the object as the first argumen
 
         // check if the name is actually a fake name
         if (in_array($object->getFirstName(), $fakeNames)) {
+            // If you're using the new 2.5 validation API (you probably are!)
             $context->buildViolation('This name sounds totally fake!')
                 ->atPath('firstName')
                 ->addViolation()
             ;
+
+            // If you're using the old 2.4 validation API
+            $context->addViolationAt(
+                'firstName',
+                'This name sounds totally fake!'
+            );
         }
     }
 
@@ -156,6 +177,8 @@ your validation function is ``Vendor\Package\Validator::validate()``::
     namespace Vendor\Package;
 
     use Symfony\Component\Validator\Context\ExecutionContextInterface;
+    // if you're using the older 2.4 validation API, you'll need this instead
+    // use Symfony\Component\Validator\ExecutionContextInterface;
 
     class Validator
     {