minor #19054 [Validator] Add "Translatable Objects" example (cavasinf)

javiereguiluz · javiereguiluz · commit 56c3af16829f · 2023-10-25T13:25:34.000+02:00
This PR was submitted for the 6.4 branch but it was squashed and merged into the 6.3 branch instead. Discussion ---------- [Validator] Add "Translatable Objects" example Resolve #19049 Commits ------- 3b18682 [Validator] Add "Translatable Objects" example
diff --git a/validation/translations.rst b/validation/translations.rst
@@ -123,6 +123,29 @@ Now, create a ``validators`` catalog file in the ``translations/`` directory:
 You may need to clear your cache (even in the dev environment) after creating
 this file for the first time.
 
+You can also use :class:`Symfony\\Component\\Translation\\TranslatableMessage` to build your violation message::
+
+    use Symfony\Component\Translation\TranslatableMessage;
+    use Symfony\Component\Validator\Constraints as Assert;
+    use Symfony\Component\Validator\Context\ExecutionContextInterface;
+    
+    #[Assert\Callback]
+    public function validate(ExecutionContextInterface $context, mixed $payload): void
+    {
+        // somehow you have an array of "fake names"
+        $fakeNames = [/* ... */];
+    
+        // check if the name is actually a fake name
+        if (in_array($this->getFirstName(), $fakeNames, true)) {
+            $context->buildViolation(new TranslatableMessage('author.name.fake', [], 'validators'))
+                ->atPath('firstName')
+                ->addViolation()
+            ;
+        }
+    }
+
+You can learn more about translatable messages in :ref:`the dedicated section <translatable-objects>`.
+
 Custom Translation Domain
 -------------------------
 
