8000 [Form] Renamed client and application format to view and model format · symfony/symfony@bec8015 · GitHub
[go: up one dir, main page]
Skip to content

Commit bec8015

Browse files
webmozartwebmozart
committed
[Form] Renamed client and application format to view and model format
1 parent 8cae328 commit bec8015

25 files changed

+316
-178
lines changed

‎UPGRADE-2.1.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -467,8 +467,10 @@
467467
* `getClientTransformers`
468468
* `getAttribute`
469469
* `hasAttribute`
470+
* `getClientData`
470471
471-
You can access these methods on the `FormConfigInterface` object instead.
472+
The method `getClientData` has a new equivalent that is named `getViewData`.
473+
You can access all other methods on the `FormConfigInterface` object instead.
472474
473475
Before:
474476
@@ -643,6 +645,31 @@
643645
public function buildView(FormViewInterface $view, FormInterface $form, array $options)
644646
public function buildViewBottomUp(FormViewInterface $view, FormInterface $form, array $options)
645647
```
648+
649+
* The following methods in `FormBuilder` were deprecated and have a new equivalent:
650+
651+
* `prependClientTransformer`: `addViewTransformer`
652+
* `appendClientTransformer`: no new equivalent, should not be used
653+
* `getClientTransformers`: `getViewTransformers`
654+
* `resetClientTransformers`: `resetViewTransformers`
655+
* `prependNormTransformer`: no new equivalent, should not be used
656+
* `appendNormTransformer`: `addModelTransformer`
657+
* `getNormTransformers`: `getModelTransformers`
658+
* `resetNormTransformers`: `resetModelTransformers`
659+
660+
The deprecated methods will be removed in Symfony 2.3. You are advised to update your application.
661+
662+
Before:
663+
664+
```
665+
$builder->prependClientTransformer(new MyTransformer());
666+
```
667+
668+
After:
669+
670+
```
671+
$builder->addViewTransformer(new MyTransformer());
672+
```
646673
647674
### Validator
648675

‎src/Symfony/Component/Form/CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,31 @@ CHANGELOG
7575
* errors are not mapped to unsynchronized forms anymore
7676
* [BC BREAK] changed Form constructor to accept a single `FormConfigInterface` object
7777
* [BC BREAK] changed argument order in the FormBuilder constructor
78+
* added Form method `getViewData`
7879
* deprecated Form methods
7980
* `getTypes`
8081
* `getErrorBubbling`
8182
* `getNormTransformers`
8283
* `getClientTransformers`
8384
* `getAttribute`
8485
* `hasAttribute`
86+
* `getClientData`
87+
* added FormBuilder methods
88+
* `addViewTransformer`
89+
* `getViewTransformers`
90+
* `resetViewTransformers`
91+
* `addModelTransformer`
92+
* `getModelTransformers`
93+
* `resetModelTransformers`
94+
* deprecated FormBuilder methods
95+
* `prependClientTransformer`
96+
* `appendClientTransformer`
97+
* `getClientTransformers`
98+
* `resetClientTransformers`
99+
* `prependNormTransformer`
100+
* `appendNormTransformer`
101+
* `getNormTransformers`
102+
* `resetNormTransformers`
85103
* deprecated the option "validation_constraint" in favor of the new
86104
option "constraints"
87105
* removed superfluous methods from DataMapperInterface

‎src/Symfony/Component/Form/Extension/Core/Type/CheckboxType.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class CheckboxType extends AbstractType
2626
public function buildForm(FormBuilderInterface $builder, array $options)
2727
{
2828
$builder
29-
->appendClientTransformer(new BooleanToStringTransformer($options['value']))
29+
->addViewTransformer(new BooleanToStringTransformer($options['value']))
3030
;
3131
}
3232

@@ -37,7 +37,7 @@ public function buildView(FormViewInterface $view, FormInterface $form, array $o
3737
{
3838
$view
3939
->set('value', $options['value'])
40-
->set('checked', null !== $form->getClientData())
40+
->set('checked', null !== $form->getViewData())
4141
;
4242
}
4343

‎src/Symfony/Component/Form/Extension/Core/Type/ChoiceType.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,20 @@ public function buildForm(FormBuilderInterface $builder, array $options)
4646

4747
if ($options['multiple']) {
4848
$builder
49-
->appendClientTransformer(new ChoicesToBooleanArrayTransformer($options['choice_list']))
49+
->addViewTransformer(new ChoicesToBooleanArrayTransformer($options['choice_list']))
5050
->addEventSubscriber(new FixCheckboxInputListener($options['choice_list']), 10)
5151
;
5252
} else {
5353
$builder
54-
->appendClientTransformer(new ChoiceToBooleanArrayTransformer($options['choice_list']))
54+
->addViewTransformer(new ChoiceToBooleanArrayTransformer($options['choice_list']))
5555
->addEventSubscriber(new FixRadioInputListener($options['choice_list']), 10)
5656
;
5757
}
5858
} else {
5959
if ($options['multiple']) {
60-
$builder->appendClientTransformer(new ChoicesToValuesTransformer($options['choice_list']));
60+
$builder->addViewTransformer(new ChoicesToValuesTransformer($options['choice_list']));
6161
} else {
62-
$builder->appendClientTransformer(new ChoiceToValueTransformer($options['choice_list']));
62+
$builder->addViewTransformer(new ChoiceToValueTransformer($options['choice_list']));
6363
}
6464
}
6565

‎src/Symfony/Component/Form/Extension/Core/Type/DateTimeType.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
4343
}
4444

4545
if ('single_text' === $options['widget']) {
46-
$builder->appendClientTransformer(new DateTimeToStringTransformer($options['data_timezone'], $options['user_timezone'], $format));
46+
$builder->addViewTransformer(new DateTimeToStringTransformer($options['data_timezone'], $options['user_timezone'], $format));
4747
} else {
4848
// Only pass a subset of the options to children
4949
$dateOptions = array_intersect_key($options, array_flip(array(
@@ -86,7 +86,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
8686
$timeOptions['input'] = 'array';
8787

8888
$builder
89-
->appendClientTransformer(new DataTransformerChain(array(
89+
->addViewTransformer(new DataTransformerChain(array(
9090
new DateTimeToArrayTransformer($options['data_timezone'], $options['user_timezone'], $parts),
9191
new ArrayToPartsTransformer(array(
9292
'date' => array('year', 'month', 'day'),

‎src/Symfony/Component/Form/Extension/Core/Type/DateType.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
6363
);
6464

6565
if ('single_text' === $options['widget']) {
66-
$builder->appendClientTransformer(new DateTimeToLocalizedStringTransformer($options['data_timezone'], $options['user_timezone'], $format, \IntlDateFormatter::NONE, \IntlDateFormatter::GREGORIAN, $pattern));
66+
$builder->addViewTransformer(new DateTimeToLocalizedStringTransformer($options['data_timezone'], $options['user_timezone'], $format, \IntlDateFormatter::NONE, \IntlDateFormatter::GREGORIAN, $pattern));
6767
} else {
6868
$yearOptions = $monthOptions = $dayOptions = array();
6969

@@ -110,7 +110,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
110110
->add('year', $options['widget'], $yearOptions)
111111
->add('month', $options['widget'], $monthOptions)
112112
->add('day', $options['widget'], $dayOptions)
113-
->appendClientTransformer(new DateTimeToArrayTransformer(
113+
->addViewTransformer(new DateTimeToArrayTransformer(
114114
$options['data_timezone'], $options['user_timezone'], array('year', 'month', 'day')
115115
))
116116
;

‎src/Symfony/Component/Form/Extension/Core/Type/FormType.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ public function buildView(FormViewInterface $view, FormInterface $form, array $o
9797
->set('read_only', $readOnly)
9898
->set('errors', $form->getErrors())
9999
->set('valid', $form->isBound() ? $form->isValid() : true)
100-
->set('value', $form->getClientData())
100+
->set('value', $form->getViewData())
101101
->set('disabled', $form->isDisabled())
102102
->set('required', $form->isRequired())
103103
->set('max_length', $options['max_length'])

‎src/Symfony/Component/Form/Extension/Core/Type/IntegerType.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class IntegerType extends AbstractType
2323
*/
2424
public function buildForm(FormBuilderInterface $builder, array $options)
2525
{
26-
$builder->appendClientTransformer(
26+
$builder->addViewTransformer(
2727
new IntegerToLocalizedStringTransformer(
2828
$options['precision'],
2929
$options['grouping'],

‎src/Symfony/Component/Form/Extension/Core/Type/MoneyType.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class MoneyType extends AbstractType
2828
public function buildForm(FormBuilderInterface $builder, array $options)
2929
{
3030
$builder
31-
->appendClientTransformer(new MoneyToLocalizedStringTransformer(
31+
->addViewTransformer(new MoneyToLocalizedStringTransformer(
3232
$options['precision'],
3333
$options['grouping'],
3434
null,

‎src/Symfony/Component/Form/Extension/Core/Type/NumberType.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class NumberType extends AbstractType
2323
*/
2424
public function buildForm(FormBuilderInterface $builder, array $options)
2525
{
26-
$builder->appendClientTransformer(new NumberToLocalizedStringTransformer(
26+
$builder->addViewTransformer(new NumberToLocalizedStringTransformer(
2727
$options['precision'],
2828
$options['grouping'],
2929
$options['rounding_mode']

‎src/Symfony/Component/Form/Extension/Core/Type/PercentType.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class PercentType extends AbstractType
2323
*/
2424
public function buildForm(FormBuilderInterface $builder, array $options)
2525
{
26-
$builder->appendClientTransformer(new PercentToLocalizedStringTransformer($options['precision'], $options['type']));
26+
$builder->addViewTransformer(new PercentToLocalizedStringTransformer($options['precision'], $options['type']));
2727
}
2828

2929
/**

‎src/Symfony/Component/Form/Extension/Core/Type/RepeatedType.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
2929
$options['second_options']['required'] = $options['required'];
3030

3131
$builder
32-
->appendClientTransformer(new ValueToDuplicatesTransformer(array(
32+
->addViewTransformer(new ValueToDuplicatesTransformer(array(
3333
$options['first_name'],
3434
$options['second_name'],
3535
)))

‎src/Symfony/Component/Form/Extension/Core/Type/TextType.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class TextType extends AbstractType
2424
public function buildForm(FormBuilderInterface $builder, array $options)
2525
{
2626
$builder
27-
->appendClientTransformer(new ValueToStringTransformer())
27+
->addViewTransformer(new ValueToStringTransformer())
2828
;
2929
}
3030

‎src/Symfony/Component/Form/Extension/Core/Type/TimeType.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
3737
}
3838

3939
if ('single_text' === $options['widget']) {
40-
$builder->appendClientTransformer(new DateTimeToStringTransformer($options['data_timezone'], $options['user_timezone'], $format));
40+
$builder->addViewTransformer(new DateTimeToStringTransformer($options['data_timezone'], $options['user_timezone'], $format));
4141
} else {
4242
$hourOptions = $minuteOptions = $secondOptions = array();
4343

@@ -92,7 +92,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
9292
$builder->add('second', $options['widget'], $secondOptions);
9393
}
9494

95-
$builder->appendClientTransformer(new DateTimeToArrayTransformer($options['data_timezone'], $options['user_timezone'], $parts, 'text' === $options['widget']));
95+
$builder->addViewTransformer(new DateTimeToArrayTransformer($options['data_timezone'], $options['user_timezone'], $parts, 'text' === $options['widget']));
9696
}
9797

9898
if ('string' === $options['input']) {

‎src/Symfony/Component/Form/Extension/Validator/Constraints/FormValidator.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ public function validate($form, Constraint $constraint)
8080
}
8181
}
8282
} else {
83-
$clientDataAsString = is_scalar($form->getClientData())
84-
? (string) $form->getClientData()
85-
: gettype($form->getClientData());
83+
$clientDataAsString = is_scalar($form->getViewData())
84+
? (string) $form->getViewData()
85+
: gettype($form->getViewData());
8686

8787
// Mark the form with an error if it is not synchronized
8888
$this->context->addViolation(
8989
$config->getOption('invalid_message'),
9090
array('{{ value }}' => $clientDataAsString),
91-
$form->getClientData(),
91+
$form->getViewData(),
9292
null,
9393
Form::ERR_INVALID
9494
);

0 commit comments

Comments
 (0)
0