php - Translate custom form type in symfony2

Solution:

You can add translations like in other places, just fill the label.

public function buildForm(FormBuilderInterface $builder, array $options)
{
    $builder
        ->add('title', 'text', [
            'label' => 'rpr.page.title', // <- any string can be there
        ]);
}
Copy code

The default translation domain is 'messages', to change add 'translation_domain' to you configureOptions

public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults([
       'data_class'         => 'Acme\Entity\DemoEntity',
       'translation_domain' => 'forms'
    ]);
}
Copy code

Of course you then need to create the translation files in the right place:AcmeBundle\Resources\translations

Important things to note: - when you create new translation files in yourAcmeBundle\Resources\translations like forms.de.yml you need to clear the cache even in development.

docs here: http://symfony.com/doc/current/reference/forms/types/form.html#translation-domain

Solution:

a) set locale parameter and enable translation in config.yml

parameters:
    locale: en

framework:
    #esi:             ~
    translator:      { fallbacks: ["%locale%"] }
Copy code

b) create custom form type. I created the GenderType from the docs.

c) extend the custom form type with a constructor to get access to the translator and use the translater where you want to:

namespace AppBundle\Form\Type;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Translation\Translator;

class GenderType extends AbstractType
{
    private $translator;

    public function __construct(Translator $translator)
    {
        $this->translator = $translator;
    }

    public function configureOptions(OptionsResolver $resolver)
    {
        $resolver->setDefaults(array(
            'choices' => array(
                'm' => $this->translator->trans('user.male'),
                'f' => $this->translator->trans('user.female'),
            )
        ));
    }

    public function getParent()
    {
        return 'choice';
    }

    public function getName()
    {
        return 'gender';
    }
}
Copy code

d) Create your Field Type as a Service

// app/config/services.yml
services:
    app.form.type.gender:
        class: AppBundle\Form\Type\GenderType
        arguments:
            - @translator.default
        tags:
            - { name: form.type, alias: gender }
Copy code

e) Create a translationfile:

// src/AppBundle/Resources/translations/user.en.yml
user:
    creation: Create User
    gender: Gender
    male: Male
    female: Female
Copy code

f) Extend your formType (e.g. UserType). Make sure that you pass the fieldtype by the 'gender' service-alias that you created at step d. Also set the label and the translation_domain options for each field.

// src/AppBundle/Form/UserType.php
namespace AppBundle\Form;

use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
use AppBundle\Form\Type\GenderType;

class UserType extends AbstractType
{
    /**
     * @param FormBuilderInterface $builder
     * @param array $options
     */
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder
            ->add('gender', 'gender', array('label' => 'user.gender', 'translation_domain' => 'user'))
            // and more fields
        ;
    }

    /**
     * @param OptionsResolverInterface $resolver
     */
    public function setDefaultOptions(OptionsResolverInterface $resolver)
    {
        $resolver->setDefaults(array(
            'data_class' => 'AppBundle\Entity\User'
        ));
    }

    /**
     * @return string
     */
    public function getName()
    {
        return 'appbundle_user';
    }
}
Copy code

g) add trans_default_domain to your twig templates and translate whatever you want to translate. Example:

{% extends '::base.html.twig' %}

{% trans_default_domain 'user' %}

{% block body -%}
    <h1>{{ 'user.creation'|trans }}</h1>

    {{ form(form) }}

{% endblock %}
Copy code