Skip to content

[Form] Add label_translation_parameters, help_translation_parameters and attr_translation_parameters options to base form type #28635

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.

Sign up for GitHub

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
Feb 13, 2019
Merged

[Form] Add label_translation_parameters, help_translation_parameters and attr_translation_parameters options to base form type #28635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
174 changes: 174 additions & 0 deletions src/Symfony/Bridge/Doctrine/Tests/Form/Type/EntityTypeTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1366,6 +1366,180 @@ public function testDefaultTranslationDomain()
$this->assertNull($view['child']->vars['translation_domain']);
}

public function testPassLabelTranslationParametersToView()
{
$view = $this->factory->create(static::TESTED_TYPE, null, [
'label_translation_parameters' => ['%param%' => 'value'],
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->createView();

$this->assertSame(['%param%' => 'value'], $view->vars['label_translation_parameters']);
}

public function testPassHelpTranslationParametersToView()
{
$view = $this->factory->create(static::TESTED_TYPE, null, [
'help_translation_parameters' => ['%param%' => 'value'],
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->createView();

$this->assertSame(['%param%' => 'value'], $view->vars['help_translation_parameters']);
}

public function testPassAttrTranslationParametersToView()
{
$view = $this->factory->create(static::TESTED_TYPE, null, [
'attr_translation_parameters' => ['%param%' => 'value'],
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->createView();

$this->assertSame(['%param%' => 'value'], $view->vars['attr_translation_parameters']);
}

public function testInheritLabelTranslationParametersFromParent()
{
$view = $this->factory
->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE, null, [
'label_translation_parameters' => ['%param%' => 'value'],
])
->add('child', static::TESTED_TYPE, [
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals(['%param%' => 'value'], $view['child']->vars['label_translation_parameters']);
}

public function testInheritHelpTranslationParametersFromParent()
{
$view = $this->factory
->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE, null, [
'help_translation_parameters' => ['%param%' => 'value'],
])
->add('child', static::TESTED_TYPE, [
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals(['%param%' => 'value'], $view['child']->vars['help_translation_parameters']);
}

public function testInheritAttrTranslationParametersFromParent()
{
$view = $this->factory
->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE, null, [
'attr_translation_parameters' => ['%param%' => 'value'],
])
->add('child', static::TESTED_TYPE, [
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals(['%param%' => 'value'], $view['child']->vars['attr_translation_parameters']);
}

public function testPreferOwnLabelTranslationParameters()
{
$view = $this->factory
->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE, null, [
'label_translation_parameters' => ['%parent_param%' => 'parent_value', '%override_param%' => 'parent_override_value'],
])
->add('child', static::TESTED_TYPE, [
'label_translation_parameters' => ['%override_param%' => 'child_value'],
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals(['%parent_param%' => 'parent_value', '%override_param%' => 'child_value'], $view['child']->vars['label_translation_parameters']);
}

public function testPreferOwnHelpTranslationParameters()
{
$view = $this->factory
->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE, null, [
'help_translation_parameters' => ['%parent_param%' => 'parent_value', '%override_param%' => 'parent_override_value'],
])
->add('child', static::TESTED_TYPE, [
'help_translation_parameters' => ['%override_param%' => 'child_value'],
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals(['%parent_param%' => 'parent_value', '%override_param%' => 'child_value'], $view['child']->vars['help_translation_parameters']);
}

public function testPreferOwnAttrTranslationParameters()
{
$view = $this->factory
->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE, null, [
'attr_translation_parameters' => ['%parent_param%' => 'parent_value', '%override_param%' => 'parent_override_value'],
])
->add('child', static::TESTED_TYPE, [
'attr_translation_parameters' => ['%override_param%' => 'child_value'],
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals(['%parent_param%' => 'parent_value', '%override_param%' => 'child_value'], $view['child']->vars['attr_translation_parameters']);
}

public function testDefaultLabelTranslationParameters()
{
$view = $this->factory->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE)
->add('child', static::TESTED_TYPE, [
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals([], $view['child']->vars['label_translation_parameters']);
}

public function testDefaultHelpTranslationParameters()
{
$view = $this->factory->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE)
->add('child', static::TESTED_TYPE, [
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals([], $view['child']->vars['help_translation_parameters']);
}

public function testDefaultAttrTranslationParameters()
{
$view = $this->factory->createNamedBuilder('parent', FormTypeTest::TESTED_TYPE)
->add('child', static::TESTED_TYPE, [
'em' => 'default',
'class' => self::SINGLE_IDENT_CLASS,
])
->getForm()
->createView();

$this->assertEquals([], $view['child']->vars['attr_translation_parameters']);
}

public function testPassLabelToView()
{
$view = $this->factory->createNamed('__test___field', static::TESTED_TYPE, null, [
Expand Down
3 changes: 2 additions & 1 deletion src/Symfony/Bridge/Doctrine/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"require-dev": {
"symfony/stopwatch": "~3.4|~4.0",
"symfony/dependency-injection": "~3.4|~4.0",
"symfony/form": "~3.4|~4.0",
"symfony/form": "~4.3",
"symfony/http-kernel": "~3.4|~4.0",
"symfony/messenger": "~4.2",
"symfony/property-access": "~3.4|~4.0",
Expand All @@ -47,6 +47,7 @@
"conflict": {
"phpunit/phpunit": "<4.8.35|<5.4.3,>=5.0",
"symfony/dependency-injection": "<3.4",
"symfony/form": "<4.3",
"symfony/messenger": "<4.2"
},
"suggest": {
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_3_layout.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,9 @@
{%- endif -%}
{%- else -%}
{%- if help_html is same as(false) -%}
{{- help|trans({}, translation_domain) -}}
{{- help|trans(help_translation_parameters, translation_domain) -}}
{%- else -%}
{{- help|trans({}, translation_domain)|raw -}}
{{- help|trans(help_translation_parameters, translation_domain)|raw -}}
{%- endif -%}
{%- endif -%}
</span>
Expand Down
6 changes: 3 additions & 3 deletions src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_4_layout.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@
{% set label = name|humanize %}
{%- endif -%}
{%- endif -%}
<{{ element|default('label') }}{% if label_attr %}{% with { attr: label_attr } %}{{ block('attributes') }}{% endwith %}{% endif %}>{{ translation_domain is same as(false) ? label : label|trans({}, translation_domain) }}{% block form_label_errors %}{{- form_errors(form) -}}{% endblock form_label_errors %}</{{ element|default('label') }}>
<{{ element|default('label') }}{% if label_attr %}{% with { attr: label_attr } %}{{ block('attributes') }}{% endwith %}{% endif %}>{{ translation_domain is same as(false) ? label : label|trans(label_translation_parameters, translation_domain) }}{% block form_label_errors %}{{- form_errors(form) -}}{% endblock form_label_errors %}</{{ element|default('label') }}>
{%- else -%}
{%- if errors|length > 0 -%}
<div id="{{ id }}_errors" class="mb-2">
Expand Down Expand Up @@ -312,9 +312,9 @@
{%- endif -%}
{%- else -%}
{%- if help_html is same as(false) -%}
{{- help|trans({}, translation_domain) -}}
{{- help|trans(help_translation_parameters, translation_domain) -}}
{%- else -%}
{{- help|trans({}, translation_domain)|raw -}}
{{- help|trans(help_translation_parameters, translation_domain)|raw -}}
{%- endif -%}
{%- endif -%}
</small>
Expand Down
10 changes: 5 additions & 5 deletions src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@
{% set label = name|humanize %}
{%- endif -%}
{%- endif -%}
<button type="{{ type|default('button') }}" {{ block('button_attributes') }}>{{ translation_domain is same as(false) ? label : label|trans({}, translation_domain) }}</button>
<button type="{{ type|default('button') }}" {{ block('button_attributes') }}>{{ translation_domain is same as(false) ? label : label|trans(label_translation_parameters, translation_domain) }}</button>
{%- endblock button_widget -%}

{%- block submit_widget -%}
Expand Down Expand Up @@ -279,7 +279,7 @@
{%- if translation_domain is same as(false) -%}
{{- label -}}
{%- else -%}
{{- label|trans({}, translation_domain) -}}
{{- label|trans(label_translation_parameters, translation_domain) -}}
{%- endif -%}
</{{ element|default('label') }}>
{%- endif -%}
Expand All @@ -301,9 +301,9 @@
{%- endif -%}
{%- else -%}
{%- if help_html is same as(false) -%}
{{- help|trans({}, translation_domain) -}}
{{- help|trans(help_translation_parameters, translation_domain) -}}
{%- else -%}
{{- help|trans({}, translation_domain)|raw -}}
{{- help|trans(help_translation_parameters, translation_domain)|raw -}}
{%- endif -%}
{%- endif -%}
</p>
Expand Down Expand Up @@ -433,7 +433,7 @@
{%- for attrname, attrvalue in attr -%}
{{- " " -}}
{%- if attrname in ['placeholder', 'title'] -%}
{{- attrname }}="{{ translation_domain is same as(false) ? attrvalue : attrvalue|trans({}, translation_domain) }}"
{{- attrname }}="{{ translation_domain is same as(false) ? attrvalue : attrvalue|trans(attr_translation_parameters, translation_domain) }}"
{%- elseif attrvalue is same as(true) -%}
{{- attrname }}="{{ attrname }}"
{%- elseif attrvalue is not same as(false) -%}
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bridge/Twig/Tests/Extension/Fixtures/StubTranslator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ class StubTranslator implements TranslatorInterface
{
public function trans($id, array $parameters = [], $domain = null, $locale = null)
{
return '[trans]'.$id.'[/trans]';
return '[trans]'.strtr($id, $parameters).'[/trans]';
}
}
4 changes: 2 additions & 2 deletions src/Symfony/Bridge/Twig/Tests/Extension/Fixtures/templates/form/custom_widgets.html.twig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{% if label is empty %}
{% set label = name|humanize %}
{% endif %}
<label>Custom label: {{ label|trans({}, translation_domain) }}</label>
<label>Custom label: {{ label|trans(label_translation_parameters, translation_domain) }}</label>
{% endspaceless %}
{% endblock _names_entry_label %}

Expand All @@ -20,6 +20,6 @@
{% if label is empty %}
{% set label = name|humanize %}
{% endif %}
<label>Custom name label: {{ label|trans({}, translation_domain) }}</label>
<label>Custom name label: {{ label|trans(label_translation_parameters, translation_domain) }}</label>
{% endspaceless %}
{% endblock _name_c_entry_label %}
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/attributes.html.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php foreach ($attr as $k => $v): ?>
<?php if ('placeholder' === $k || 'title' === $k): ?>
<?php printf('%s="%s" ', $view->escape($k), $view->escape(false !== $translation_domain ? $view['translator']->trans($v, [], $translation_domain) : $v)) ?>
<?php printf('%s="%s" ', $view->escape($k), $view->escape(false !== $translation_domain ? $view['translator']->trans($v, $attr_translation_parameters, $translation_domain) : $v)) ?>
<?php elseif (true === $v): ?>
<?php printf('%s="%s" ', $view->escape($k), $view->escape($k)) ?>
<?php elseif (false !== $v): ?>
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/button_widget.html.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<?php if (!$label) { $label = isset($label_format)
? strtr($label_format, ['%name%' => $name, '%id%' => $id])
: $view['form']->humanize($name); } ?>
<button type="<?php echo isset($type) ? $view->escape($type) : 'button' ?>" <?php echo $view['form']->block($form, 'button_attributes') ?>><?php echo $view->escape(false !== $translation_domain ? $view['translator']->trans($label, [], $translation_domain) : $label) ?></button>
<button type="<?php echo isset($type) ? $view->escape($type) : 'button' ?>" <?php echo $view['form']->block($form, 'button_attributes') ?>><?php echo $view->escape(false !== $translation_domain ? $view['translator']->trans($label, $label_translation_parameters, $translation_domain) : $label) ?></button>
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/form_help.html.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php if (!empty($help)): ?>
<?php $help_attr['class'] = isset($help_attr['class']) ? trim($help_attr['class'].' help-text') : 'help-text'; ?>
<?php $help = false !== $translation_domain ? $view['translator']->trans($help, [], $translation_domain) : $help; ?>
<?php $help = false !== $translation_domain ? $view['translator']->trans($help, $help_translation_parameters, $translation_domain) : $help; ?>
<?php $help = false === $help_html ? $view->escape($help) : $help ?>
<p id="<?php echo $view->escape($id); ?>_help" <?php echo ' '.$view['form']->block($form, 'attributes', ['attr' => $help_attr]); ?>><?php echo $help; ?></p>
<?php endif; ?>
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Resources/views/Form/form_label.html.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
<?php if (!$label) { $label = isset($label_format)
? strtr($label_format, ['%name%' => $name, '%id%' => $id])
: $view['form']->humanize($name); } ?>
<label<?php if ($label_attr) { echo ' '.$view['form']->block($form, 'attributes', ['attr' => $label_attr]); } ?>><?php echo $view->escape(false !== $translation_domain ? $view['translator']->trans($label, [], $translation_domain) : $label) ?></label>
<label<?php if ($label_attr) { echo ' '.$view['form']->block($form, 'attributes', ['attr' => $label_attr]); } ?>><?php echo $view->escape(false !== $translation_domain ? $view['translator']->trans($label, $label_translation_parameters, $translation_domain) : $label) ?></label>
<?php endif ?>
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/FrameworkBundle/Tests/Templating/Helper/Fixtures/StubTranslator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@ class StubTranslator implements TranslatorInterface
{
public function trans($id, array $parameters = [], $domain = null, $locale = null)
{
return '[trans]'.$id.'[/trans]';
return '[trans]'.strtr($id, $parameters).'[/trans]';
}
}
24 changes: 24 additions & 0 deletions src/Symfony/Component/Form/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,30 @@ CHANGELOG
option is set to `single_text`
* added `block_prefix` option to `BaseType`.
* added `help_html` option to display the `help` text as HTML.
* added `label_translation_parameters`, `attr_translation_parameters`, `help_translation_parameters` options
to `FormType` to pass translation parameters to form labels, attributes (`placeholder` and `title`) and help text respectively.
The passed parameters will replace placeholders in translation messages.

```php
class OrderType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('comment', TextType::class, [
'label' => 'Comment to the order to %company%',
'label_translation_parameters' => [
'%company%' => 'Acme',
],
'help' => 'The address of the %company% is %address%',
'help_translation_parameters' => [
'%company%' => 'Acme Ltd.',
'%address%' => '4 Form street, Symfonyville',
],
])
}
}
```


4.2.0
-----
Expand Down
9 changes: 9 additions & 0 deletions src/Symfony/Component/Form/Extension/Core/Type/BaseType.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ public function buildView(FormView $view, FormInterface $form, array $options)
$name = $form->getName();
$blockName = $options['block_name'] ?: $form->getName();
$translationDomain = $options['translation_domain'];
$labelTranslationParameters = $options['label_translation_parameters'];
$attrTranslationParameters = $options['attr_translation_parameters'];
$labelFormat = $options['label_format'];

if ($view->parent) {
Expand All @@ -61,6 +63,9 @@ public function buildView(FormView $view, FormInterface $form, array $options)
$translationDomain = $view->parent->vars['translation_domain'];
}

$labelTranslationParameters = array_merge($view->parent->vars['label_translation_parameters'], $labelTranslationParameters);
$attrTranslationParameters = array_merge($view->parent->vars['attr_translation_parameters'], $attrTranslationParameters);

if (!$labelFormat) {
$labelFormat = $view->parent->vars['label_format'];
}
Expand Down Expand Up @@ -97,6 +102,8 @@ public function buildView(FormView $view, FormInterface $form, array $options)
'block_prefixes' => $blockPrefixes,
'unique_block_prefix' => $uniqueBlockPrefix,
'translation_domain' => $translationDomain,
'label_translation_parameters' => $labelTranslationParameters,
'attr_translation_parameters' => $attrTranslationParameters,
// Using the block name here speeds up performance in collection
// forms, where each entry has the same full block name.
// Including the type is important too, because if rows of a
Expand All @@ -118,6 +125,8 @@ public function configureOptions(OptionsResolver $resolver)
'disabled' => false,
'label' => null,
'label_format' => null,
'label_translation_parameters' => [],
'attr_translation_parameters' => [],
'attr' => [],
'translation_domain' => null,
'auto_initialize' => true,
Expand Down
Loading