[2.7][Form][choice] add doc about the new option: choice_translation_domain

[aitboudad]

symfony/symfony#13651

choice_translation_domain (bool | null | string)

• true: reuse current translation_domain
• false: disabled
• null: parents translation_domain or default domain (messages)
• string: explicit domain

[Tobion]

It's choice_translation_domain (bool | null | string)

[wouterj]

This has to be documented in the form type reference using the same format as the other options and should also have a .. versionadded:: 2.7 directive indicating that this option was introduced in Symfony 2.7.

[nothingaa]

Is there a way to impact the whole entity in a single call?
I have tried to call the following funciton and it is not working.

public function configureOptions(OptionsResolver $resolver)
{
    $resolver->setDefaults(array(
        'choice_translation_domain' => true,
    ));
}

[ricohumme]

On what form field types is the choice_translation_domain effective?
I'm testing with field type date and it throws an error saying it's a non-existent option.
As for the docs, it has no reference yet on the use of this options.

Could some clarify?

Edit:
When using translation_domain => false on the date type, it does work.
Am I just interpreting the choice_translation_domain wrong?

Edit 2:
When using this as in the mention above, the label is also no longer translated. I assumed it was just having effect on the choice widget?

[xabbuh]

@aitboudad Can you confirm that what @ricohumme describes is the intended behaviour?

[xabbuh]

By the way, there is an open pull request: see #5614

[aitboudad]

Sorry I don't have much time these days ^^ below how it work:
The choice_translation_domain is related to translation_domain only when the value is equal to true or null, it was introduced to enable/disable translation for optgroup and option in Choice Fields:

• Default value: true
  • choice
• Default value: false
  • country
  • currency
  • language
  • locale
  • timezone
  • entity

for the date type currently it's not possible but it can be introduced in 2.8 once symfony/symfony#15301 got merged.

[aitboudad]

@ricohumme not sure if I understood the Edit 2: can you leave us an example to reproduce it.

[ricohumme]

Sure!
When using the following code:

$builder->add('purchaseDate', 'date', [
            'label' => 'rma_form.label.purchaseDate',
            'placeholder' => array('year' => 'Year', 'month' => 'Month', 'day' => 'Day'),
            'widget' => 'choice',
            'required' => true,
            'translation_domain' => false
        ]);

The output on the screen renders the widgets without translating the contents of the widgets, however the label also shows rma_form.label.purchaseDate (not translated)

When using the following code:

$builder->add('purchaseDate', 'date', [
            'label' => 'rma_form.label.purchaseDate',
            'placeholder' => array('year' => 'label.year', 'month' => 'label.month', 'day' => 'label.day'),
            'widget' => 'choice',
            'required' => true
        ]);

The output on the screen renders the widgets and translates the content: So the placeholders are correct, but also the numbers are translated. The label widget label is correctly translated.

[aitboudad]

@ricohumme your example work as expected :), as I already mentioned above the choice_translation_domain doesn't affect the date type.

[ricohumme]

@aitboudad that is true, you did. But do you agree that the date type should work the same way the choice type does when it comes to choice_translation_domain ?

[aitboudad]

@ricohumme yes, see symfony/symfony#15301

[xabbuh]

@ricohumme @aitboudad What about the label not being translated? Is that intended too?

[aitboudad]

@xabbuh when translation_domain = false the label is not translated see:

{{ translation_domain is sameas(false) ? label : label|trans({}, translation_domain) }}

[xabbuh]

@aitboudad Yes, but was that really intended?

[aitboudad]

@xabbuh not sure, anyway not related to this issue !

[peterrehm]

Fixed by #5906