Skip to content
Closed
Changes from 2 commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions cookbook/form/form_label_translation_easily.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
.. index::
single: Form; Translate field labels

How to Translate field labels easily
====================================

Translating the field labels in each form can be a tedious task,
especially if you use **"Keyword Messages"**.
For example, if you had two different forms with a field named "order",
the default translation keyword would be exactly the same.
On the other hand, if you need to write different translations
depending the form, you need to change the default label in one of them.

This is why you can use a simple solution:
:doc:`Create a Form Type Extension</cookbook/form/create_form_type_extension>`
that allows you to manipulate the labels and automatically create unique
keys::

// src/Acme/DemoBundle/Form/Extension/LabelTranslationExtension.php
namespace Acme\DemoBundle\Form\Extension;

use Symfony\Component\Form\AbstractTypeExtension;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\Form\FormView;

class LabelTranslationExtension extends AbstractTypeExtension
{
/**
* Manipulates the label.
*
* @param FormView $view
* @param FormInterface $form
* @param array $options
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still not aligned correctly.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@smoya it should be:

* @param FormView $view * @param FormInterface $form * @param array $options 

how it is now:

* @param FormView $view * @param FormInterface $form * @param array $options 
*/
public function finishView(FormView $view, FormInterface $form, array $options)
{
if (null === $options['label']) {
$view->vars['label'] = str_replace('_', '.', $view->vars['id']);
}
}

/**
* Returns the name of the type being extended.
*
* @return string The name of the type being extended
*/
public function getExtendedType()
{
return 'form';
}
}

Now, declare it as a **service**:

.. configuration-block::

.. code-block:: yaml

services:
acme_demo_bundle.label_translation_extension:
class: Acme\DemoBundle\Form\Type\LabelTranslationExtension
tags:
- { name: form.type_extension, alias: form }

.. code-block:: xml

<service id="acme_demo_bundle.label_translation_extension"
class="Acme\DemoBundle\Form\Type\LabelTranslationExtension">
<tag name="form.type_extension" alias="form" />
</service>

.. code-block:: php

$container
->register(
'acme_demo_bundle.label_translation_extension',
'Acme\DemoBundle\Form\Type\LabelTranslationExtension'
)
->addTag('form.type_extension', array('alias' => 'form'));


.. configuration-block::

.. code-block:: xml

<!-- messages.fr.xliff -->
<?xml version="1.0"?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
<file source-language="en" datatype="plaintext" original="file.ext">
<body>
<trans-unit id="1">
<source>acme.demobundle.exampletype.order</source>
<target>Ordre</target>
</trans-unit>
</body>
</file>
</xliff>

.. code-block:: php

// messages.fr.php
return array(
'acme.demobundle.exampletype.order' => 'Ordre',
);

.. code-block:: yaml

# messages.fr.yml
acme:
demobundle:
exampletype:
order: Ordre