Skip to content

Commit

Permalink
feature #20887 [Form] DateIntervalType: Allow to configure labels & e…
Browse files Browse the repository at this point in the history 
…nhance form theme (ogizanagi)

This PR was merged into the 3.3-dev branch.

Discussion
----------

[Form] DateIntervalType: Allow to configure labels & enhance form theme

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | yes
| BC breaks?    | no (unless someone relies on this non themed type)
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | N/A
| License       | MIT
| Doc PR        | Should document the new `labels` option

I just realized by using it for last fixes in #20886 and #20877 that this type was not really themed:

### before

<img width="861" alt="screenshot 2016-12-13 a 00 54 35" src="https://cloud.githubusercontent.com/assets/2211145/21121792/c589d27a-c0ce-11e6-8368-a396fda3bc7a.PNG">

At least labels should appear, but this also means being able to change them (thus the new `labels` option).

I think the form themes should provide a functional & minimalistic integration like this:

### after

<img width="862" alt="screenshot 2016-12-13 a 00 54 17" src="https://cloud.githubusercontent.com/assets/2211145/21121814/d9c4ead6-c0ce-11e6-94e1-41e6c14884a7.PNG">

---
(On screenshots above, I've only added a css rule to remove the 100% width of the `.table` class. See #20887 (comment))

Commits
-------

bfd9e50 [Form] DateIntervalType: Allow to configure labels & enhance form theme
  • Loading branch information
@fabpot
fabpot committed Jan 11, 2017
2 parents 294a877 + bfd9e50 commit df876b3
Show file tree
Hide file tree
Showing 4 changed files with 122 additions and 16 deletions.
33 changes: 26 additions & 7 deletions src/Symfony/Bridge/Twig/Resources/views/Form/bootstrap_3_layout.html.twig
View file
Expand Up @@ -94,13 +94,32 @@
{%- set attr = attr|merge({class: (attr.class|default('') ~ ' form-inline')|trim}) -%}
<div {{ block('widget_container_attributes') }}>
{{- form_errors(form) -}}
{%- if with_years %}{{ form_widget(form.years) }}{% endif -%}
{%- if with_months %}{{ form_widget(form.months) }}{% endif -%}
{%- if with_weeks %}{{ form_widget(form.weeks) }}{% endif -%}
{%- if with_days %}{{ form_widget(form.days) }}{% endif -%}
{%- if with_hours %}{{ form_widget(form.hours) }}{% endif -%}
{%- if with_minutes %}{{ form_widget(form.minutes) }}{% endif -%}
{%- if with_seconds %}{{ form_widget(form.seconds) }}{% endif -%}
<div class="table-responsive">
<table class="table {{ table_class|default('table-bordered table-condensed table-striped') }}">
<thead>
<tr>
{%- if with_years %}<th>{{ form_label(form.years) }}</th>{% endif -%}
{%- if with_months %}<th>{{ form_label(form.months) }}</th>{% endif -%}
{%- if with_weeks %}<th>{{ form_label(form.weeks) }}</th>{% endif -%}
{%- if with_days %}<th>{{ form_label(form.days) }}</th>{% endif -%}
{%- if with_hours %}<th>{{ form_label(form.hours) }}</th>{% endif -%}
{%- if with_minutes %}<th>{{ form_label(form.minutes) }}</th>{% endif -%}
{%- if with_seconds %}<th>{{ form_label(form.seconds) }}</th>{% endif -%}
</tr>
</thead>
<tbody>
<tr>
{%- if with_years %}<td>{{ form_widget(form.years) }}</td>{% endif -%}
{%- if with_months %}<td>{{ form_widget(form.months) }}</td>{% endif -%}
{%- if with_weeks %}<td>{{ form_widget(form.weeks) }}</td>{% endif -%}
{%- if with_days %}<td>{{ form_widget(form.days) }}</td>{% endif -%}
{%- if with_hours %}<td>{{ form_widget(form.hours) }}</td>{% endif -%}
{%- if with_minutes %}<td>{{ form_widget(form.minutes) }}</td>{% endif -%}
{%- if with_seconds %}<td>{{ form_widget(form.seconds) }}</td>{% endif -%}
</tr>
</tbody>
</table>
</div>
{%- if with_invert %}{{ form_widget(form.invert) }}{% endif -%}
</div>
{%- endif -%}
Expand Down
31 changes: 24 additions & 7 deletions src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig
View file
Expand Up @@ -136,13 +136,30 @@
{%- else -%}
<div {{ block('widget_container_attributes') }}>
{{- form_errors(form) -}}
{%- if with_years %}{{ form_widget(form.years) }}{% endif -%}
{%- if with_months %}{{ form_widget(form.months) }}{% endif -%}
{%- if with_weeks %}{{ form_widget(form.weeks) }}{% endif -%}
{%- if with_days %}{{ form_widget(form.days) }}{% endif -%}
{%- if with_hours %}{{ form_widget(form.hours) }}{% endif -%}
{%- if with_minutes %}{{ form_widget(form.minutes) }}{% endif -%}
{%- if with_seconds %}{{ form_widget(form.seconds) }}{% endif -%}
<table class="{{ table_class|default('') }}">
<thead>
<tr>
{%- if with_years %}<th>{{ form_label(form.years) }}</th>{% endif -%}
{%- if with_months %}<th>{{ form_label(form.months) }}</th>{% endif -%}
{%- if with_weeks %}<th>{{ form_label(form.weeks) }}</th>{% endif -%}
{%- if with_days %}<th>{{ form_label(form.days) }}</th>{% endif -%}
{%- if with_hours %}<th>{{ form_label(form.hours) }}</th>{% endif -%}
{%- if with_minutes %}<th>{{ form_label(form.minutes) }}</th>{% endif -%}
{%- if with_seconds %}<th>{{ form_label(form.seconds) }}</th>{% endif -%}
</tr>
</thead>
<tbody>
<tr>
{%- if with_years %}<td>{{ form_widget(form.years) }}</td>{% endif -%}
{%- if with_months %}<td>{{ form_widget(form.months) }}</td>{% endif -%}
{%- if with_weeks %}<td>{{ form_widget(form.weeks) }}</td>{% endif -%}
{%- if with_days %}<td>{{ form_widget(form.days) }}</td>{% endif -%}
{%- if with_hours %}<td>{{ form_widget(form.hours) }}</td>{% endif -%}
{%- if with_minutes %}<td>{{ form_widget(form.minutes) }}</td>{% endif -%}
{%- if with_seconds %}<td>{{ form_widget(form.seconds) }}</td>{% endif -%}
</tr>
</tbody>
</table>
{%- if with_invert %}{{ form_widget(form.invert) }}{% endif -%}
</div>
{%- endif -%}
Expand Down
25 changes: 23 additions & 2 deletions src/Symfony/Component/Form/Extension/Core/Type/DateIntervalType.php
View file
Expand Up @@ -99,8 +99,10 @@ public function buildForm(FormBuilderInterface $builder, array $options)
$childOptions = array();
foreach ($this->timeParts as $part) {
if ($options['with_'.$part]) {
$childOptions[$part] = array();
$childOptions[$part]['error_bubbling'] = true;
$childOptions[$part] = array(
'error_bubbling' => true,
'label' => $options['labels'][$part],
);
if ('choice' === $options['widget']) {
$childOptions[$part]['choice_translation_domain'] = false;
$childOptions[$part]['choices'] = $options[$part];
Expand Down Expand Up @@ -131,6 +133,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
}
if ($options['with_invert']) {
$builder->add('invert', 'Symfony\Component\Form\Extension\Core\Type\CheckboxType', array(
'label' => $options['labels']['invert'],
'error_bubbling' => true,
'required' => false,
'translation_domain' => $options['translation_domain'],
Expand Down Expand Up @@ -192,6 +195,21 @@ public function configureOptions(OptionsResolver $resolver)
return array_fill_keys($timeParts, $placeholder);
};

$labelsNormalizer = function (Options $options, array $labels) {
return array_replace(array(
'years' => null,
'months' => null,
'days' => null,
'weeks' => null,
'hours' => null,
'minutes' => null,
'seconds' => null,
'invert' => 'Negative interval',
), array_filter($labels, function ($label) {
return null !== $label;
}));
};

$resolver->setDefaults(
array(
'with_years' => true,
Expand Down Expand Up @@ -220,9 +238,11 @@ public function configureOptions(OptionsResolver $resolver)
// this option.
'data_class' => null,
'compound' => $compound,
'labels' => array(),
)
);
$resolver->setNormalizer('placeholder', $placeholderNormalizer);
$resolver->setNormalizer('labels', $labelsNormalizer);

$resolver->setAllowedValues(
'input',
Expand Down Expand Up @@ -260,6 +280,7 @@ public function configureOptions(OptionsResolver $resolver)
$resolver->setAllowedTypes('with_minutes', 'bool');
$resolver->setAllowedTypes('with_seconds', 'bool');
$resolver->setAllowedTypes('with_invert', 'bool');
$resolver->setAllowedTypes('labels', 'array');
}

/**
Expand Down
49 changes: 49 additions & 0 deletions src/Symfony/Component/Form/Tests/Extension/Core/Type/DateIntervalTypeTest.php
View file
Expand Up @@ -399,4 +399,53 @@ public function testInvertDoesNotInheritRequiredOption()
);
$this->assertFalse($form->get('invert')->getConfig()->getOption('required'));
}

public function testCanChangeTimeFieldsLabels()
{
$form = $this->factory->create(
DateIntervalType::class,
null,
array(
'required' => true,
'with_invert' => true,
'with_hours' => true,
'with_minutes' => true,
'with_seconds' => true,
'labels' => array(
'invert' => 'form.trans.invert',
'years' => 'form.trans.years',
'months' => 'form.trans.months',
'days' => 'form.trans.days',
'hours' => 'form.trans.hours',
'minutes' => 'form.trans.minutes',
'seconds' => 'form.trans.seconds',
),
)
);

$view = $form->createView();
$this->assertSame('form.trans.invert', $view['invert']->vars['label']);
$this->assertSame('form.trans.years', $view['years']->vars['label']);
$this->assertSame('form.trans.months', $view['months']->vars['label']);
$this->assertSame('form.trans.days', $view['days']->vars['label']);
$this->assertSame('form.trans.hours', $view['hours']->vars['label']);
$this->assertSame('form.trans.minutes', $view['minutes']->vars['label']);
$this->assertSame('form.trans.seconds', $view['seconds']->vars['label']);
}

public function testInvertDefaultLabel()
{
$form = $this->factory->create(DateIntervalType::class, null, array('with_invert' => true));

$view = $form->createView();
$this->assertSame('Negative interval', $view['invert']->vars['label']);

$form = $this->factory->create(DateIntervalType::class, null, array(
'with_invert' => true,
'labels' => array('invert' => null),
));

$view = $form->createView();
$this->assertSame('Negative interval', $view['invert']->vars['label']);
}
}

0 comments on commit df876b3

Please sign in to comment.