minor #10103 Documented the findByCodes() validation method (javiereguiluz)

javiereguiluz · javiereguiluz · commit 13997c73bf6f · 2018-07-20T17:57:03.000+02:00
This PR was merged into the 3.4 branch. Discussion ---------- Documented the findByCodes() validation method Fixes #7786. Commits ------- 5cd7605 Documented the findByCodes() validation method
diff --git a/components/validator.rst b/components/validator.rst
@@ -53,7 +53,19 @@ characters long::
         }
     }
 
-The validator returns the list of violations.
+The  ``validate()`` method returns the list of violations as an object that
+implements :class:`Symfony\\Component\\Validator\\ConstraintViolationListInterface`.
+If you have lots of validation errors, you can filter them by error code::
+
+    use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
+
+    $violations = $validator->validate(...);
+    if (count($violations->findByCodes(UniqueEntity::NOT_UNIQUE_ERROR))) {
+        // handle this specific error (display some message, send an email, etc.)
+    }
+
+.. versionadded:: 3.3
+    The ``findByCodes()`` method was introduced in Symfony 3.3.
 
 Retrieving a Validator Instance
 -------------------------------
