8000 Remove deprecated OptionsResolverInterface from documentation · michaelperrin/symfony-docs@cc7cb28 · GitHub
[go: up one dir, main page]

Skip to content

Commit cc7cb28

Browse files
author
Michaël Perrin
committed
Remove deprecated OptionsResolverInterface from documentation
`OptionsResolverInterface` has been deprecated in Symfony 2.6 in favor of `OptionsResolver` (see symfony/symfony#12156)
1 parent ffd8d78 commit cc7cb28

11 files changed

+43
-43
lines changed

best_practices/forms.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ form in its own PHP class:
2323
2424
use Symfony\Component\Form\AbstractType;
2525
use Symfony\Component\Form\FormBuilderInterface;
26-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
26+
use Symfony\Component\OptionsResolver\OptionsResolver;
2727
2828
class PostType extends AbstractType
2929
{
@@ -38,7 +38,7 @@ form in its own PHP class:
3838
;
3939
}
4040
41-
public function setDefaultOptions(OptionsResolverInterface $resolver)
41+
public function setDefaultOptions(OptionsResolver $resolver)
4242
{
4343
$resolver->setDefaults(array(
4444
'data_class' => 'AppBundle\Entity\Post'

book/forms.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -469,9 +469,9 @@ If you're creating :ref:`form classes <book-form-creating-form-classes>` (a
469469
good practice), then you'll need to add the following to the ``setDefaultOptions()``
470470
method::
471471

472-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
472+
use Symfony\Component\OptionsResolver\OptionsResolver;
473473

474-
public function setDefaultOptions(OptionsResolverInterface $resolver)
474+
public function setDefaultOptions(OptionsResolver $resolver)
475475
{
476476
$resolver->setDefaults(array(
477477
'validation_groups' => array('registration'),
@@ -493,9 +493,9 @@ Disabling Validation
493493
Sometimes it is useful to suppress the validation of a form altogether. For
494494
these cases you can set the ``validation_groups`` option to ``false``::
495495

496-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
496+
use Symfony\Component\OptionsResolver\OptionsResolver;
497497

498-
public function setDefaultOptions(OptionsResolverInterface $resolver)
498+
public function setDefaultOptions(OptionsResolver $resolver)
499499
{
500500
$resolver->setDefaults(array(
501501
'validation_groups' => false,
@@ -519,9 +519,9 @@ If you need some advanced logic to determine the validation groups (e.g.
519519
based on submitted data), you can set the ``validation_groups`` option
520520
to an array callback::
521521

522-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
522+
use Symfony\Component\OptionsResolver\OptionsResolver;
523523

524-
public function setDefaultOptions(OptionsResolverInterface $resolver)
524+
public function setDefaultOptions(OptionsResolver $resolver)
525525
{
526526
$resolver->setDefaults(array(
527527
'validation_groups' => array(
@@ -537,9 +537,9 @@ The Form object is passed as an argument to that method (see next example).
537537
You can also define whole logic inline by using a ``Closure``::
538538

539539
use Symfony\Component\Form\FormInterface;
540-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
540+
use Symfony\Component\OptionsResolver\OptionsResolver;
541541

542-
public function setDefaultOptions(OptionsResolverInterface $resolver)
542+
public function setDefaultOptions(OptionsResolver $resolver)
543543
{
544544
$resolver->setDefaults(array(
545545
'validation_groups' => function(FormInterface $form) {
@@ -1065,9 +1065,9 @@ the choice is ultimately up to you.
10651065
good idea to explicitly specify the ``data_class`` option by adding the
10661066
following to your form type class::
10671067

1068-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
1068+
use Symfony\Component\OptionsResolver\OptionsResolver;
10691069

1070-
public function setDefaultOptions(OptionsResolverInterface $resolver)
1070+
public function setDefaultOptions(OptionsResolver $resolver)
10711071
{
10721072
$resolver->setDefaults(array(
10731073
'data_class' => 'Acme\TaskBundle\Entity\Task',
@@ -1296,7 +1296,7 @@ create a form class so that a ``Category`` object can be modified by the user::
12961296

12971297
use Symfony\Component\Form\AbstractType;
12981298
use Symfony\Component\Form\FormBuilderInterface;
1299-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
1299+
use Symfony\Component\OptionsResolver\OptionsResolver;
13001300

13011301
class CategoryType extends AbstractType
13021302
{
@@ -1305,7 +1305,7 @@ create a form class so that a ``Category`` object can be modified by the user::
13051305
$builder->add('name');
13061306
}
13071307

1308-
public function setDefaultOptions(OptionsResolverInterface $resolver)
1308+
public function setDefaultOptions(OptionsResolver $resolver)
13091309
{
13101310
$resolver->setDefaults(array(
13111311
'data_class' => 'Acme\TaskBundle\Entity\Category',
@@ -1738,13 +1738,13 @@ that all un-rendered fields are output.
17381738

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

1741-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
1741+
use Symfony\Component\OptionsResolver\OptionsResolver;
17421742

17431743
class TaskType extends AbstractType
17441744
{
17451745
// ...
17461746

1747-
public function setDefaultOptions(OptionsResolverInterface $resolver)
1747+
public function setDefaultOptions(OptionsResolver $resolver)
17481748
{
17491749
$resolver->setDefaults(array(
17501750
'data_class' => 'Acme\TaskBundle\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 setDefaultOptions(OptionsResolver $resolver)
129129
{
130130
$resolver->setDefaults(array(
131131
'data_class' => 'Acme\AccountBundle\Entity\User'

cookbook/form/create_custom_field_type.rst

Lines changed: 4 additions & 4 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 Acme\DemoBundle\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 setDefaultOptions(OptionsResolver $resolver)
3232
{
3333
$resolver->setDefaults(array(
3434
'choices' => array(
@@ -342,7 +342,7 @@ method to ``GenderType``, which receives the gender configuration::
342342
// src/Acme/DemoBundle/Form/Type/GenderType.php
343343
namespace Acme\DemoBundle\Form\Type;
344344

345-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
345+
use Symfony\Component\OptionsResolver\OptionsResolver;
346346

347347
// ...
348348

@@ -356,7 +356,7 @@ method to ``GenderType``, which receives the gender configuration::
356356
$this->genderChoices = $genderChoices;
357357
}
358358

359-
public function setDefaultOptions(OptionsResolverInterface $resolver)
359+
public function setDefaultOptions(OptionsResolver $resolver)
360360
{
361361
$resolver->setDefaults(array(
362362
'choices' => $this->genderChoices,

cookbook/form/create_form_type_extension.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ it in the view::
195195
use Symfony\Component\Form\FormView;
196196
use Symfony\Component\Form\FormInterface;
197197
use Symfony\Component\PropertyAccess\PropertyAccess;
198-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
198+
use Symfony\Component\OptionsResolver\OptionsResolver;
199199

200200
class ImageTypeExtension extends AbstractTypeExtension
201201
{
@@ -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 setDefaultOptions(OptionsResolver $resolver)
218218
{
219219
$resolver->setOptional(array('image_path'));
220220
}

cookbook/form/data_transformers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ by calling ``addModelTransformer`` (or ``addViewTransformer`` - see
133133
);
134134
}
135135

136-
public function setDefaultOptions(OptionsResolverInterface $resolver)
136+
public function setDefaultOptions(OptionsResolver $resolver)
137137
{
138138
$resolver
139139
->setDefaults(array(
@@ -254,7 +254,7 @@ First, create the custom field type class::
254254
use Symfony\Component\Form\FormBuilderInterface;
255255
use Acme\TaskBundle\Form\DataTransformer\IssueToNumberTransformer;
256256
use Doctrine\Common\Persistence\ObjectManager;
257-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
257+
use Symfony\Component\OptionsResolver\OptionsResolver;
258258

259259
class IssueSelectorType extends AbstractType
260260
{
@@ -277,7 +277,7 @@ First, create the custom field type class::
277277
$builder->addModelTransformer($transformer);
278278
}
279279

280-
public function setDefaultOptions(OptionsResolverInterface $resolver)
280+
public function setDefaultOptions(OptionsResolver $resolver)
281281
{
282282
$resolver->setDefaults(array(
283283
'invalid_message' => 'The selected issue does not exist',

cookbook/form/dynamic_form_modification.rst

Lines changed: 4 additions & 4 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 setDefaultOptions(OptionsResolver $resolver)
5555
{
5656
$resolver->setDefaults(array(
5757
'data_class' => 'Acme\DemoBundle\Entity\Product'
@@ -224,7 +224,7 @@ 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\SecurityContext;
227-
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
227+
use Symfony\Component\OptionsResolver\OptionsResolver;
228228

229229
class FriendMessageFormType extends AbstractType
230230
{
@@ -244,7 +244,7 @@ Using an event listener, your form might look like this::
244244
return 'acme_friend_message';
245245
}
246246

247-
public function setDefaultOptions(OptionsResolverInterface $resolver)
247+
public function setDefaultOptions(OptionsResolver $resolver)
248248
{
249249
}
250250
}

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 setDefaultOptions(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 setDefaultOptions(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 setDefaultOptions(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 Acme\DemoBundle\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 setDefaultOptions(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 setDefaultOptions(OptionsResolver $resolver)
8080
{
8181
$resolver->setDefaults(array(
8282
'empty_data' => function (FormInterface $form) {

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 setDefaultOptions(OptionsResolver $resolver)
1717
{
1818
$resolver->setDefaults(array(
1919
'error_mapping' => array(

0 commit comments

Comments
 (0)
0