New in Symfony 4.3: Improved form translation

February 14, 2019 Javier Eguiluz

Warning: This post is about an unsupported Symfony version. Some of this information may be out of date. Read the most recent Symfony Docs.

Contributed by
Webnet team
in #28635.

The forms created with the Symfony Form component translate their labels and help messages automatically. However, the translations cannot contain any custom parameters because in the templates, the trans() Twig filter is called without passing any parameters.

In Symfony 4.3 we improved the translation of Symfony Forms allowing to define custom translation parameters using three new config options: label_translation_parameters, help_translation_parameters, and attr_translation_parameters (this one is useful to translate placeholder and title):

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

class OrderType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('comment', TextType::class, [
            'label' => 'Comment for the order of %company%',
            'label_translation_parameters' => [
                '%company%' => 'Acme Ltd.',
            ],

            'help' => 'The address of %company% is %address%',
            'help_translation_parameters' => [
                '%company%' => 'Acme Ltd.',
                '%address%' => '4 Form street, Symfonyville',
            ],
        ])
    }
}

Help the Symfony project!

As with any Open-Source project, contributing code or documentation is the most common way to help, but we also have a wide range of sponsoring opportunities.

New in Symfony 4.3: Improved form translation symfony.com/blog/new-in-symfony-4-3-improved-form-translation

Tweet this

Comments

Josef Kufner said on Feb 14, 2019 at 12:21 #1

How do you extract such strings for translation? When using gettext, the extractor can run simple static analysis to find _() function calls.

Alex Rock Certified said on Feb 14, 2019 at 12:21 #2

Really useful!

Just miss a config-based option to add the "raw" filter after "trans" and it'll be perfect 👍

Javier Eguiluz Certified said on Feb 14, 2019 at 13:58 #3

@Josef you cannot extract them using the tools provided for Symfony (which only extract from templates).

@Alex there's a new option in Symfony 4.3 called "help_html". Set it to "true" to output HTML contents as "raw". But I think there's no such option for "label".

Josef Kufner said on Feb 14, 2019 at 14:48 #4

@Javier Eguiluz: That sounds like a bug (by design).

Matthias Althaus said on Feb 14, 2019 at 17:44 #5

@Josef: Just set the t10n directly with a gettext call and set the translation domains to `false`? For more complex t10n (like translating translation parameters) you'd still inject the Translator into the FormType.

Josef Kufner said on Feb 15, 2019 at 13:13 #6

Matthias: The question is not how to use gettext. The question is how to translate the messages that are used in the source code. The biggest problem is in how to be sure that all the messages are translated. How can I get a PO file from source code such as this example and then send it to a translator who knows other language?

Comments are closed.

To ensure that comments stay relevant, they are closed for old posts.