Skip to content

Commit 74d2e30

Browse files
weaverryanweaverryan
committed
feature #4786 Replaced setDefaultOptions by the new configureOptions method (peterrehm)
This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #4786). Discussion ---------- Replaced setDefaultOptions by the new configureOptions method | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes|no (PR symfony/symfony#12891) | Applies to | 2.7 | Fixed tickets | #4565 Pending on the merge of symfony/symfony#12891. With this PR all references to setDefaultOptions and the deprecated OptionResolverInterface are removed in 2.7. Commits ------- 728205f Replaced setDefaultOptions by the new configureOptions method
2 parents 7363c9b + 728205f commit 74d2e30

12 files changed

+49
-53
lines changed

‎best_practices/forms.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ form in its own PHP class::
2121

2222
use Symfony\Component\Form\AbstractType;
2323
use Symfony\Component\Form\FormBuilderInterface;
24-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
24+
use Symfony\Component\OptionsResolver\OptionsResolver;
2525

2626
class PostType extends AbstractType
2727
{
@@ -36,7 +36,7 @@ form in its own PHP class::
3636
;
3737
}
3838

39-
public function setDefaultOptions(OptionsResolverInterface $resolver)
39+
public function configureOptions(OptionsResolver $resolver)
4040
{
4141
$resolver->setDefaults(array(
4242
'data_class' => 'AppBundle\Entity\Post'

‎book/forms.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -471,12 +471,12 @@ you'll need to specify which validation group(s) your form should use::
471471
))->add(...);
472472

473473
If you're creating :ref:`form classes <book-form-creating-form-classes>` (a
474-
good practice), then you'll need to add the following to the ``setDefaultOptions()``
474+
good practice), then you'll need to add the following to the ``configureOptions()``
475475
method::
476476

477-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
477+
use Symfony\Component\OptionsResolver\OptionsResolver;
478478

479-
public function setDefaultOptions(OptionsResolverInterface $resolver)
479+
public function configureOptions(OptionsResolver $resolver)
480480
{
481481
$resolver->setDefaults(array(
482482
'validation_groups' => array('registration'),
@@ -498,9 +498,9 @@ Disabling Validation
498498
Sometimes it is useful to suppress the validation of a form altogether. For
499499
these cases you can set the ``validation_groups`` option to ``false``::
500500

501-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
501+
use Symfony\Component\OptionsResolver\OptionsResolver;
502502

503-
public function setDefaultOptions(OptionsResolverInterface $resolver)
503+
public function configureOptions(OptionsResolver $resolver)
504504
{
505505
$resolver->setDefaults(array(
506506
'validation_groups' => false,
@@ -524,10 +524,10 @@ If you need some advanced logic to determine the validation groups (e.g.
524524
based on submitted data), you can set the ``validation_groups`` option
525525
to an array callback::
526526

527-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
527+
use Symfony\Component\OptionsResolver\OptionsResolver;
528528

529529
// ...
530-
public function setDefaultOptions(OptionsResolverInterface $resolver)
530+
public function configureOptions(OptionsResolver $resolver)
531531
{
532532
$resolver->setDefaults(array(
533533
'validation_groups' => array(
@@ -544,10 +544,10 @@ You can also define whole logic inline by using a ``Closure``::
544544

545545
use Acme\AcmeBundle\Entity\Client;
546546
use Symfony\Component\Form\FormInterface;
547-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
547+
use Symfony\Component\OptionsResolver\OptionsResolver;
548548

549549
// ...
550-
public function setDefaultOptions(OptionsResolverInterface $resolver)
550+
public function configureOptions(OptionsResolver $resolver)
551551
{
552552
$resolver->setDefaults(array(
553553
'validation_groups' => function(FormInterface $form) {
@@ -567,10 +567,10 @@ of the entity as well you have to adjust the option as follows::
567567

568568
use Acme\AcmeBundle\Entity\Client;
569569
use Symfony\Component\Form\FormInterface;
570-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
570+
use Symfony\Component\OptionsResolver\OptionsResolver;
571571

572572
// ...
573-
public function setDefaultOptions(OptionsResolverInterface $resolver)
573+
public function configureOptions(OptionsResolver $resolver)
574574
{
575575
$resolver->setDefaults(array(
576576
'validation_groups' => function(FormInterface $form) {
@@ -1090,9 +1090,9 @@ the choice is ultimately up to you.
10901090
good idea to explicitly specify the ``data_class`` option by adding the
10911091
following to your form type class::
10921092

1093-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
1093+
use Symfony\Component\OptionsResolver\OptionsResolver;
10941094

1095-
public function setDefaultOptions(OptionsResolverInterface $resolver)
1095+
public function configureOptions(OptionsResolver $resolver)
10961096
{
10971097
$resolver->setDefaults(array(
10981098
'data_class' => 'AppBundle\Entity\Task',
@@ -1321,7 +1321,7 @@ create a form class so that a ``Category`` object can be modified by the user::
13211321

13221322
use Symfony\Component\Form\AbstractType;
13231323
use Symfony\Component\Form\FormBuilderInterface;
1324-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
1324+
use Symfony\Component\OptionsResolver\OptionsResolver;
13251325

13261326
class CategoryType extends AbstractType
13271327
{
@@ -1330,7 +1330,7 @@ create a form class so that a ``Category`` object can be modified by the user::
13301330
$builder->add('name');
13311331
}
13321332

1333-
public function setDefaultOptions(OptionsResolverInterface $resolver)
1333+
public function configureOptions(OptionsResolver $resolver)
13341334
{
13351335
$resolver->setDefaults(array(
13361336
'data_class' => 'AppBundle\Entity\Category',
@@ -1756,13 +1756,13 @@ that all un-rendered fields are output.
17561756

17571757
The CSRF token can be customized on a form-by-form basis. For example::
17581758

1759-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
1759+
use Symfony\Component\OptionsResolver\OptionsResolver;
17601760

17611761
class TaskType extends AbstractType
17621762
{
17631763
// ...
17641764

1765-
public function setDefaultOptions(OptionsResolverInterface $resolver)
1765+
public function configureOptions(OptionsResolver $resolver)
17661766
{
17671767
$resolver->setDefaults(array(
17681768
'data_class' => 'AppBundle\Entity\Task',

‎cookbook/doctrine/registration_form.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Next, create the form for the ``User`` model::
111111

112112
use Symfony\Component\Form\AbstractType;
113113
use Symfony\Component\Form\FormBuilderInterface;
114-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
114+
use Symfony\Component\OptionsResolver\OptionsResolver;
115115

116116
class UserType extends AbstractType
117117
{
@@ -125,7 +125,7 @@ Next, create the form for the ``User`` model::
125125
));
126126
}
127127

128-
public function setDefaultOptions(OptionsResolverInterface $resolver)
128+
public function configureOptions(OptionsResolver $resolver)
129129
{
130130
$resolver->setDefaults(array(
131131
'data_class' => 'Acme\AccountBundle\Entity\User'

‎cookbook/form/create_custom_field_type.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ for form fields, which is ``<BundleName>\Form\Type``. Make sure the field extend
2424
namespace AppBundle\Form\Type;
2525

2626
use Symfony\Component\Form\AbstractType;
27-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
27+
use Symfony\Component\OptionsResolver\OptionsResolver;
2828

2929
class GenderType extends AbstractType
3030
{
31-
public function setDefaultOptions(OptionsResolverInterface $resolver)
31+
public function configureOptions(OptionsResolver $resolver)
3232
{
3333
$resolver->setDefaults(array(
3434
'choices' => array(
@@ -72,7 +72,7 @@ important:
7272
set) the ``multiple`` attribute on the ``select`` field. See `Creating a Template for the Field`_
7373
for more details.
7474

75-
``setDefaultOptions()``
75+
``configureOptions()``
7676
This defines options for your form type that
7777
can be used in ``buildForm()`` and ``buildView()``. There are a lot of
7878
options common to all fields (see :doc:`/reference/forms/types/form`),
@@ -345,7 +345,7 @@ method to ``GenderType``, which receives the gender configuration::
345345
// src/AppBundle/Form/Type/GenderType.php
346346
namespace AppBundle\Form\Type;
347347

348-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
348+
use Symfony\Component\OptionsResolver\OptionsResolver;
349349

350350
// ...
351351

@@ -359,7 +359,7 @@ method to ``GenderType``, which receives the gender configuration::
359359
$this->genderChoices = $genderChoices;
360360
}
361361

362-
public function setDefaultOptions(OptionsResolverInterface $resolver)
362+
public function configureOptions(OptionsResolver $resolver)
363363
{
364364
$resolver->setDefaults(array(
365365
'choices' => $this->genderChoices,

‎cookbook/form/create_form_type_extension.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ to override one of the following methods:
8383

8484
* ``buildView()``
8585

86-
* ``setDefaultOptions()``
86+
* ``configureOptions()``
8787

8888
* ``finishView()``
8989

@@ -178,7 +178,7 @@ database)::
178178
Your form type extension class will need to do two things in order to extend
179179
the ``file`` form type:
180180

181-
#. Override the ``setDefaultOptions`` method in order to add an ``image_path``
181+
#. Override the ``configureOptions`` method in order to add an ``image_path``
182182
option;
183183
#. Override the ``buildForm`` and ``buildView`` methods in order to pass the image
184184
URL to the view.
@@ -212,9 +212,9 @@ it in the view::
212212
/**
213213
* Add the image_path option
214214
*
215-
* @param OptionsResolverInterface $resolver
215+
* @param OptionsResolver $resolver
216216
*/
217-
public function setDefaultOptions(OptionsResolverInterface $resolver)
217+
public function configureOptions(OptionsResolver $resolver)
218218
{
219219
$resolver->setOptional(array('image_path'));
220220
}

‎cookbook/form/data_transformers.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,9 @@ You can also use transformers without creating a new custom form type
113113
by calling ``addModelTransformer`` (or ``addViewTransformer`` - see
114114
`Model and View Transformers`_) on any field builder::
115115

116-
use Symfony\Component\Form\FormBuilderInterface;
117116
use Acme\TaskBundle\Form\DataTransformer\IssueToNumberTransformer;
117+
use Symfony\Component\Form\FormBuilderInterface;
118+
use Symfony\Component\OptionsResolver\OptionsResolver;
118119

119120
class TaskType extends AbstractType
120121
{
@@ -133,7 +134,7 @@ by calling ``addModelTransformer`` (or ``addViewTransformer`` - see
133134
);
134135
}
135136

136-
public function setDefaultOptions(OptionsResolverInterface $resolver)
137+
public function configureOptions(OptionsResolver $resolver)
137138
{
138139
$resolver
139140
->setDefaults(array(
@@ -254,7 +255,7 @@ First, create the custom field type class::
254255
use Symfony\Component\Form\FormBuilderInterface;
255256
use Acme\TaskBundle\Form\DataTransformer\IssueToNumberTransformer;
256257
use Doctrine\Common\Persistence\ObjectManager;
257-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
258+
use Symfony\Component\OptionsResolver\OptionsResolver;
258259

259260
class IssueSelectorType extends AbstractType
260261
{
@@ -277,7 +278,7 @@ First, create the custom field type class::
277278
$builder->addModelTransformer($transformer);
278279
}
279280

280-
public function setDefaultOptions(OptionsResolverInterface $resolver)
281+
public function configureOptions(OptionsResolverInterface $resolver)
281282
{
282283
$resolver->setDefaults(array(
283284
'invalid_message' => 'The selected issue does not exist',

‎cookbook/form/dynamic_form_modification.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ a bare form class looks like::
4141

4242
use Symfony\Component\Form\AbstractType;
4343
use Symfony\Component\Form\FormBuilderInterface;
44-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
44+
use Symfony\Component\OptionsResolver\OptionsResolver;
4545

4646
class ProductType extends AbstractType
4747
{
@@ -51,7 +51,7 @@ a bare form class looks like::
5151
$builder->add('price');
5252
}
5353

54-
public function setDefaultOptions(OptionsResolverInterface $resolver)
54+
public function configureOptions(OptionsResolver $resolver)
5555
{
5656
$resolver->setDefaults(array(
5757
'data_class' => 'AppBundle\Entity\Product'
@@ -224,7 +224,6 @@ Using an event listener, your form might look like this::
224224
use Symfony\Component\Form\FormEvents;
225225
use Symfony\Component\Form\FormEvent;
226226
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
227-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
228227

229228
class FriendMessageFormType extends AbstractType
230229
{
@@ -243,10 +242,6 @@ Using an event listener, your form might look like this::
243242
{
244243
return 'acme_friend_message';
245244
}
246-
247-
public function setDefaultOptions(OptionsResolverInterface $resolver)
248-
{
249-
}
250245
}
251246

252247
The problem is now to get the current user and create a choice field that

‎cookbook/form/form_collections.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Then, create a form class so that a ``Tag`` object can be modified by the user::
8484

8585
use Symfony\Component\Form\AbstractType;
8686
use Symfony\Component\Form\FormBuilderInterface;
87-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
87+
use Symfony\Component\OptionsResolver\OptionsResolver;
8888

8989
class TagType extends AbstractType
9090
{
@@ -93,7 +93,7 @@ Then, create a form class so that a ``Tag`` object can be modified by the user::
9393
$builder->add('name');
9494
}
9595

96-
public function setDefaultOptions(OptionsResolverInterface $resolver)
96+
public function configureOptions(OptionsResolver $resolver)
9797
{
9898
$resolver->setDefaults(array(
9999
'data_class' => 'Acme\TaskBundle\Entity\Tag',
@@ -118,7 +118,7 @@ Notice that you embed a collection of ``TagType`` forms using the
118118

119119
use Symfony\Component\Form\AbstractType;
120120
use Symfony\Component\Form\FormBuilderInterface;
121-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
121+
use Symfony\Component\OptionsResolver\OptionsResolver;
122122

123123
class TaskType extends AbstractType
124124
{
@@ -129,7 +129,7 @@ Notice that you embed a collection of ``TagType`` forms using the
129129
$builder->add('tags', 'collection', array('type' => new TagType()));
130130
}
131131

132-
public function setDefaultOptions(OptionsResolverInterface $resolver)
132+
public function configureOptions(OptionsResolver $resolver)
133133
{
134134
$resolver->setDefaults(array(
135135
'data_class' => 'Acme\TaskBundle\Entity\Task',

‎cookbook/form/inherit_data_option.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ for that::
9090

9191
use Symfony\Component\Form\AbstractType;
9292
use Symfony\Component\Form\FormBuilderInterface;
93-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
93+
use Symfony\Component\OptionsResolver\OptionsResolver;
9494

9595
class LocationType extends AbstractType
9696
{
@@ -103,7 +103,7 @@ for that::
103103
->add('country', 'text');
104104
}
105105

106-
public function setDefaultOptions(OptionsResolverInterface $resolver)
106+
public function configureOptions(OptionsResolver $resolver)
107107
{
108108
$resolver->setDefaults(array(
109109
'inherit_data' => true

‎cookbook/form/use_empty_data.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ that constructor with no arguments::
3939
// ...
4040
use Symfony\Component\Form\AbstractType;
4141
use AppBundle\Entity\Blog;
42-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
42+
use Symfony\Component\OptionsResolver\OptionsResolver;
4343

4444
class BlogType extends AbstractType
4545
{
@@ -51,7 +51,7 @@ that constructor with no arguments::
5151
}
5252
// ...
5353

54-
public function setDefaultOptions(OptionsResolverInterface $resolver)
54+
public function configureOptions(OptionsResolver $resolver)
5555
{
5656
$resolver->setDefaults(array(
5757
'empty_data' => new Blog($this->someDependency),
@@ -72,11 +72,11 @@ if it is needed.
7272

7373
The closure must accept a ``FormInterface`` instance as the first argument::
7474

75-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
75+
use Symfony\Component\OptionsResolver\OptionsResolver;
7676
use Symfony\Component\Form\FormInterface;
7777
// ...
7878

79-
public function setDefaultOptions(OptionsResolverInterface $resolver)
79+
public function configureOptions(OptionsResolver $resolver)
8080
{
8181
$resolver->setDefaults(array(
8282
'empty_data' => function (FormInterface $form) {

‎reference/dic_tags.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ the interface directly::
293293
class MyFormTypeExtension extends AbstractTypeExtension
294294
{
295295
// ... fill in whatever methods you want to override
296-
// like buildForm(), buildView(), finishView(), setDefaultOptions()
296+
// like buildForm(), buildView(), finishView(), configureOptions()
297297
}
298298
299299
In order for Symfony to know about your form extension and use it, give it

‎reference/forms/types/options/error_mapping.rst.inc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ of the form.
1313
With customized error mapping, you can do better: map the error to the city
1414
field so that it displays above it::
1515

16-
public function setDefaultOptions(OptionsResolverInterface $resolver)
16+
public function configureOptions(OptionsResolver $resolver)
1717
{
1818
$resolver->setDefaults(array(
1919
'error_mapping' => array(

0 commit comments

Comments
 (0)