Skip to content

[Validator] Add a section for custom translation domain #18873

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 61 additions & 2 deletions validation/translations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,64 @@ Now, create a ``validators`` catalog file in the ``translations/`` directory:
'author.name.not_blank' => 'Please enter an author name.',
];

You may need to clear your cache (even in the dev environment) after creating this
file for the first time.
You may need to clear your cache (even in the dev environment) after creating
this file for the first time.

Custom Translation Domain
-------------------------

The default translation domain can be changed globally using the
``FrameworkBundle`` configuration:

.. configuration-block::

.. code-block:: yaml

# config/packages/validator.yaml
framework:
validation:
translation_domain: validation_errors

.. code-block:: xml

<!-- config/packages/validator.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services
https://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony
https://symfony.com/schema/dic/symfony/symfony-1.0.xsd">

<framework:config>
<framework:validation
translation-domain="validation_errors"
/>
</framework:config>
</container>

.. code-block:: php

// config/packages/validator.php
use Symfony\Config\FrameworkConfig;

return static function (FrameworkConfig $framework) {
// ...
$framework
->validation()
->translationDomain('validation_errors')
;
};

Or it can be customized for a specific violation from a constraint validator::

public function validate($value, Constraint $constraint): void
{
// validation logic

$this->context->buildViolation($constraint->message)
->setParameter('{{ string }}', $value)
->setTranslationDomain('validation_errors')
->addViolation();
}