Skip to content

Commit aa6124e

Browse files
fabpotfabpot
committed
minor #13060 [2.7] adds deprecation notices. (hhamon)
This PR was merged into the 2.7 branch. Discussion ---------- [2.7] adds deprecation notices. | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | #12608, #12672, #12675 #12684, #12686 | License | MIT | Doc PR | ~ Commits ------- f9fbb4f Fixes more deprecation notices as per @stof review. fd47c07 Fixed some deprecations according to @stof feedbacks. 2a3e7d2 Normalizes deprecation notice messages. 738b9be [Validator] fixes UuidValidator deprecated class namespace. e608ba6 [Form] adds more deprecation notices. cd9617a [Validator] adds more deprecation notices. a7f841e [Form] Adds a way to trigger deprecation notice on demand for VirtualFormAwareIterator class. 97efd2c Fixes more deprecation notices. fd9c7bb Normalized @deprecated annotations. 39cfd47 Removed deprecation notices from test files. 2a9749d Fixes deprecation notices. 6f57b7b Reverted trigger_error() function calls on deprecated interfaces to prevent breaking third party projects implementing them. 86b9f6b Adds deprecation notices for structures to be removed in 3.0.
2 parents be00ea2 + a8638c6 commit aa6124e

31 files changed

+159
-87
lines changed

‎ButtonBuilder.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -592,12 +592,12 @@ public function getByReference()
592592
*
593593
* @return bool Always returns false.
594594
*
595-
* @deprecated since version 2.3, to be removed in 3.0. Use
596-
* {@link getInheritData()} instead.
595+
* @deprecated since version 2.3, to be removed in 3.0.
596+
* Use {@link getInheritData()} instead.
597597
*/
598598
public function getVirtual()
599599
{
600-
trigger_error('ButtonBuilder::getVirtual() is deprecated since version 2.3 and will be removed in 3.0. Use FormConfigBuilder::getInheritData() instead.', E_USER_DEPRECATED);
600+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the Symfony\Component\Form\FormConfigBuilder::getInheritData method instead.', E_USER_DEPRECATED);
601601

602602
return false;
603603
}

‎Deprecated/FormEvents.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
<?php
2+
23
/*
34
* This file is part of the Symfony package.
45
*
@@ -10,10 +11,10 @@
1011

1112
namespace Symfony\Component\Form\Deprecated;
1213

13-
trigger_error('Constants PRE_BIND, BIND and POST_BIND on class Symfony\Component\Form\FormEvents were deprecated in Symfony 2.3 and will be removed in 3.0. Use PRE_SUBMIT, SUBMIT and POST_SUBMIT instead.', E_USER_DEPRECATED);
14+
trigger_error('Constants PRE_BIND, BIND and POST_BIND in class Symfony\Component\Form\FormEvents are deprecated since version 2.3 and will be removed in 3.0. Use PRE_SUBMIT, SUBMIT and POST_SUBMIT instead.', E_USER_DEPRECATED);
1415

1516
/**
16-
* @deprecated since 2.7, to be removed in 3.0.
17+
* @deprecated since version 2.7, to be removed in 3.0.
1718
* @internal
1819
*/
1920
final class FormEvents

‎Deprecated/NumberToLocalizedStringTransformer.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111

1212
namespace Symfony\Component\Form\Deprecated;
1313

14-
trigger_error('Constants ROUND_HALFEVEN, ROUND_HALFUP and ROUND_HALFDOWN on class NumberToLocalizedStringTransformer were deprecated in Symfony 2.4 and will be removed in 3.0. Use ROUND_HALF_EVEN, ROUND_HALF_UP and ROUND_HALF_DOWN instead.', E_USER_DEPRECATED);
14+
trigger_error('Constants ROUND_HALFEVEN, ROUND_HALFUP and ROUND_HALFDOWN in class NumberToLocalizedStringTransformer are deprecated since version 2.4 and will be removed in 3.0. Use ROUND_HALF_EVEN, ROUND_HALF_UP and ROUND_HALF_DOWN instead.', E_USER_DEPRECATED);
1515

1616
/**
17-
* @deprecated since 2.7, to be removed in 3.0.
17+
* @deprecated since version 2.7, to be removed in 3.0.
1818
* @internal
1919
*/
2020
final class NumberToLocalizedStringTransformer

‎Exception/AlreadyBoundException.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@
1111

1212
namespace Symfony\Component\Form\Exception;
1313

14+
trigger_error('The '.__NAMESPACE__.'\AlreadyBoundException class is deprecated since version 2.3 and will be removed in 3.0. Use the Symfony\Component\Form\Exception\AlreadySubmittedException class instead.', E_USER_DEPRECATED);
15+
1416
/**
1517
* Alias of {@link AlreadySubmittedException}.
1618
*
17-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
18-
* {@link AlreadySubmittedException} instead.
19+
* @deprecated since version 2.3, to be removed in 3.0.
20+
* Use {@link AlreadySubmittedException} instead.
1921
*/
2022
class AlreadyBoundException extends LogicException
2123
{

‎Extension/Core/ChoiceList/ChoiceList.php

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,10 +199,12 @@ public function getValuesForChoices(array $choices)
199199
/**
200200
* {@inheritdoc}
201201
*
202-
* @deprecated Deprecated since version 2.4, to be removed in 3.0.
202+
* @deprecated since version 2.4, to be removed in 3.0.
203203
*/
204204
public function getIndicesForChoices(array $choices)
205205
{
206+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
207+
206208
$choices = $this->fixChoices($choices);
207209
$indices = array();
208210

@@ -225,10 +227,12 @@ public function getIndicesForChoices(array $choices)
225227
/**
226228
* {@inheritdoc}
227229
*
228-
* @deprecated Deprecated since version 2.4, to be removed in 3.0.
230+
* @deprecated since version 2.4, to be removed in 3.0.
229231
*/
230232
public function getIndicesForValues(array $values)
231233
{
234+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
235+
232236
$values = $this->fixValues($values);
233237
$indices = array();
234238

‎Extension/Core/ChoiceList/ChoiceListInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ public function getValuesForChoices(array $choices);
139139
*
140140
* @return array An array of indices with ascending, 0-based numeric keys
141141
*
142-
* @deprecated Deprecated since version 2.4, to be removed in 3.0.
142+
* @deprecated since version 2.4, to be removed in 3.0.
143143
*/
144144
public function getIndicesForChoices(array $choices);
145145

@@ -159,7 +159,7 @@ public function getIndicesForChoices(array $choices);
159159
*
160160
* @return array An array of indices with ascending, 0-based numeric keys
161161
*
162-
* @deprecated Deprecated since version 2.4, to be removed in 3.0.
162+
* @deprecated since version 2.4, to be removed in 3.0.
163163
*/
164164
public function getIndicesForValues(array $values);
165165
}

‎Extension/Core/ChoiceList/LazyChoiceList.php

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,12 @@ public function getValuesForChoices(array $choices)
106106
/**
107107
* {@inheritdoc}
108108
*
109-
* @deprecated Deprecated since version 2.4, to be removed in 3.0.
109+
* @deprecated since version 2.4, to be removed in 3.0.
110110
*/
111111
public function getIndicesForChoices(array $choices)
112112
{
113+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
114+
113115
if (!$this->choiceList) {
114116
$this->load();
115117
}
@@ -120,10 +122,12 @@ public function getIndicesForChoices(array $choices)
120122
/**
121123
* {@inheritdoc}
122124
*
123-
* @deprecated Deprecated since version 2.4, to be removed in 3.0.
125+
* @deprecated since version 2.4, to be removed in 3.0.
124126
*/
125127
public function getIndicesForValues(array $values)
126128
{
129+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
130+
127131
if (!$this->choiceList) {
128132
$this->load();
129133
}

‎Extension/Core/ChoiceList/ObjectChoiceList.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,10 +187,12 @@ public function getValuesForChoices(array $choices)
187187
/**
188188
* {@inheritdoc}
189189
*
190-
* @deprecated Deprecated since version 2.4, to be removed in 3.0.
190+
* @deprecated since version 2.4, to be removed in 3.0.
191191
*/
192192
public function getIndicesForChoices(array $choices)
193193
{
194+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.4 and will be removed in 3.0.', E_USER_DEPRECATED);
195+
194196
if (!$this->valuePath) {
195197
return parent::getIndicesForChoices($choices);
196198
}

‎Extension/Core/DataTransformer/NumberToLocalizedStringTransformer.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,21 +76,21 @@ class NumberToLocalizedStringTransformer implements DataTransformerInterface
7676
/**
7777
* Alias for {@link self::ROUND_HALF_EVEN}.
7878
*
79-
* @deprecated Deprecated as of Symfony 2.4, to be removed in Symfony 3.0.
79+
* @deprecated since version 2.4, to be removed in 3.0.
8080
*/
8181
const ROUND_HALFEVEN = Deprecated::ROUND_HALFEVEN;
8282

8383
/**
8484
* Alias for {@link self::ROUND_HALF_UP}.
8585
*
86-
* @deprecated Deprecated as of Symfony 2.4, to be removed in Symfony 3.0.
86+
* @deprecated since version 2.4, to be removed in 3.0.
8787
*/
8888
const ROUND_HALFUP = Deprecated::ROUND_HALFUP;
8989

9090
/**
9191
* Alias for {@link self::ROUND_HALF_DOWN}.
9292
*
93-
* @deprecated Deprecated as of Symfony 2.4, to be removed in Symfony 3.0.
93+
* @deprecated since version 2.4, to be removed in 3.0.
9494
*/
9595
const ROUND_HALFDOWN = Deprecated::ROUND_HALFDOWN;
9696

‎Extension/Core/EventListener/FixCheckboxInputListener.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,13 @@ public function preSubmit(FormEvent $event)
8181
/**
8282
* Alias of {@link preSubmit()}.
8383
*
84-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
85-
* {@link preSubmit()} instead.
84+
* @deprecated since version 2.3, to be removed in 3.0.
85+
* Use {@link preSubmit()} instead.
8686
*/
8787
public function preBind(FormEvent $event)
8888
{
89+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the preSubmit() method instead.', E_USER_DEPRECATED);
90+
8991
$this->preSubmit($event);
9092
}
9193

‎Extension/Core/EventListener/FixRadioInputListener.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,13 @@ public function preSubmit(FormEvent $event)
6363
/**
6464
* Alias of {@link preSubmit()}.
6565
*
66-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
67-
* {@link preSubmit()} instead.
66+
* @deprecated since version 2.3, to be removed in 3.0.
67+
* Use {@link preSubmit()} instead.
6868
*/
6969
public function preBind(FormEvent $event)
7070
{
71+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the preSubmit() method instead.', E_USER_DEPRECATED);
72+
7173
$this->preSubmit($event);
7274
}
7375

‎Extension/Core/EventListener/FixUrlProtocolListener.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,13 @@ public function onSubmit(FormEvent $event)
4646
/**
4747
* Alias of {@link onSubmit()}.
4848
*
49-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
50-
* {@link onSubmit()} instead.
49+
* @deprecated since version 2.3, to be removed in 3.0.
50+
* Use {@link onSubmit()} instead.
5151
*/
5252
public function onBind(FormEvent $event)
5353
{
54+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the onSubmit() method instead.', E_USER_DEPRECATED);
55+
5456
$this->onSubmit($event);
5557
}
5658

‎Extension/Core/EventListener/MergeCollectionListener.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,13 @@ public function onSubmit(FormEvent $event)
129129
/**
130130
* Alias of {@link onSubmit()}.
131131
*
132-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
133-
* {@link onSubmit()} instead.
132+
* @deprecated since version 2.3, to be removed in 3.0.
133+
* Use {@link onSubmit()} instead.
134134
*/
135135
public function onBind(FormEvent $event)
136136
{
137+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the onSubmit() method instead.', E_USER_DEPRECATED);
138+
137139
$this->onSubmit($event);
138140
}
139141
}

‎Extension/Core/EventListener/ResizeFormListener.php

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,22 +184,26 @@ public function onSubmit(FormEvent $event)
184184
/**
185185
* Alias of {@link preSubmit()}.
186186
*
187-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
188-
* {@link preSubmit()} instead.
187+
* @deprecated since version 2.3, to be removed in 3.0.
188+
* Use {@link preSubmit()} instead.
189189
*/
190190
public function preBind(FormEvent $event)
191191
{
192+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the preSubmit() method instead.', E_USER_DEPRECATED);
193+
192194
$this->preSubmit($event);
193195
}
194196

195197
/**
196198
* Alias of {@link onSubmit()}.
197199
*
198-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
199-
* {@link onSubmit()} instead.
200+
* @deprecated since version 2.3, to be removed in 3.0.
201+
* Use {@link onSubmit()} instead.
200202
*/
201203
public function onBind(FormEvent $event)
202204
{
205+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the onSubmit() method instead.', E_USER_DEPRECATED);
206+
203207
$this->onSubmit($event);
204208
}
205209
}

‎Extension/Core/EventListener/TrimListener.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,13 @@ public function preSubmit(FormEvent $event)
4040
/**
4141
* Alias of {@link preSubmit()}.
4242
*
43-
* @deprecated Deprecated since version 2.3, to be removed in 3.0. Use
44-
* {@link preSubmit()} instead.
43+
* @deprecated since version 2.3, to be removed in 3.0.
44+
* Use {@link preSubmit()} instead.
4545
*/
4646
public function preBind(FormEvent $event)
4747
{
48+
trigger_error('The '.__METHOD__.' method is deprecated since version 2.3 and will be removed in 3.0. Use the preSubmit() method instead.', E_USER_DEPRECATED);
49+
4850
$this->preSubmit($event);
4951
}
5052

‎Extension/Csrf/CsrfProvider/CsrfProviderAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
namespace Symfony\Component\Form\Extension\Csrf\CsrfProvider;
1313

14-
trigger_error('Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderAdapter was deprecated in version 2.4 and will be removed in version 3.0. Please use Symfony\Component\Security\Csrf\CsrfTokenManager instead.', E_USER_DEPRECATED);
14+
trigger_error('The '.__NAMESPACE__.'\CsrfProviderAdapter class is deprecated since version 2.4 and will be removed in version 3.0. Use the Symfony\Component\Security\Csrf\CsrfTokenManager class instead.', E_USER_DEPRECATED);
1515

1616
use Symfony\Component\Form\Exception\BadMethodCallException;
1717
use Symfony\Component\Security\Csrf\CsrfToken;
@@ -24,7 +24,7 @@
2424
* @since 2.4
2525
* @author Bernhard Schussek <[email protected]>
2626
*
27-
* @deprecated Deprecated since version 2.4, to be removed in Symfony 3.0.
27+
* @deprecated since version 2.4, to be removed in 3.0.
2828
*/
2929
class CsrfProviderAdapter implements CsrfTokenManagerInterface
3030
{

‎Extension/Csrf/CsrfProvider/CsrfProviderInterface.php

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@
1111

1212
namespace Symfony\Component\Form\Extension\Csrf\CsrfProvider;
1313

14-
trigger_error('Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfProviderInterface was deprecated in version 2.4 and will be removed in version 3.0. Please use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface instead.', E_USER_DEPRECATED);
15-
1614
/**
1715
* Marks classes able to provide CSRF protection.
1816
*
@@ -29,9 +27,8 @@
2927
*
3028
* @author Bernhard Schussek <[email protected]>
3129
*
32-
* @deprecated since version 2.4, to be removed in Symfony 3.0. Use
33-
* {@link \Symfony\Component\Security\Csrf\CsrfTokenManagerInterface}
34-
* instead.
30+
* @deprecated since version 2.4, to be removed in 3.0.
31+
* Use {@link \Symfony\Component\Security\Csrf\CsrfTokenManagerInterface} instead.
3532
*/
3633
interface CsrfProviderInterface
3734
{

‎Extension/Csrf/CsrfProvider/CsrfTokenManagerAdapter.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
namespace Symfony\Component\Form\Extension\Csrf\CsrfProvider;
1313

14-
trigger_error('Symfony\Component\Form\Extension\Csrf\CsrfProvider\CsrfTokenManagerAdapter was deprecated in version 2.4 and will be removed in version 3.0. Please use Symfony\Component\Security\Csrf\CsrfTokenManager instead.', E_USER_DEPRECATED);
14+
trigger_error('The '.__NAMESPACE__.'\CsrfTokenManagerAdapter is deprecated since version 2.4 and will be removed in version 3.0. Use the Symfony\Component\Security\Csrf\CsrfTokenManager class instead.', E_USER_DEPRECATED);
1515

1616
use Symfony\Component\Security\Csrf\CsrfToken;
1717
use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
@@ -22,7 +22,7 @@
2222
* @since 2.4
2323
* @author Bernhard Schussek <[email protected]>
2424
*
25-
* @deprecated Deprecated since version 2.4, to be removed in Symfony 3.0.
25+
* @deprecated since version 2.4, to be removed in 3.0.
2626
*/
2727
class CsrfTokenManagerAdapter implements CsrfProviderInterface
2828
{

‎Extension/Csrf/CsrfProvider/DefaultCsrfProvider.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
namespace Symfony\Component\Form\Extension\Csrf\CsrfProvider;
1313

14-
trigger_error('Symfony\Component\Security\Csrf\CsrfTokenManager was deprecated in version 2.4 and will be removed in version 3.0. Please use \Symfony\Component\Security\Csrf\TokenStorage\NativeSessionTokenStorage instead.', E_USER_DEPRECATED);
14+
trigger_error('The '.__NAMESPACE__.'\DefaultCsrfProvider is deprecated since version 2.4 and will be removed in version 3.0. Use the \Symfony\Component\Security\Csrf\TokenStorage\NativeSessionTokenStorage class instead.', E_USER_DEPRECATED);
1515

1616
/**
1717
* Default implementation of CsrfProviderInterface.
@@ -21,8 +21,8 @@
2121
*
2222
* @author Bernhard Schussek <[email protected]>
2323
*
24-
* @deprecated Deprecated since version 2.4, to be removed in Symfony 3.0. Use
25-
* {@link \Symfony\Component\Security\Csrf\CsrfTokenManager} in
24+
* @deprecated since version 2.4, to be removed in 3.0.
25+
* Use {@link \Symfony\Component\Security\Csrf\CsrfTokenManager} in
2626
* combination with {@link \Symfony\Component\Security\Csrf\TokenStorage\NativeSessionTokenStorage}
2727
* instead.
2828
*/

‎Extension/Csrf/CsrfProvider/SessionCsrfProvider.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
namespace Symfony\Component\Form\Extension\Csrf\CsrfProvider;
1313

14-
trigger_error('Symfony\Component\Security\Csrf\CsrfTokenManager was deprecated in version 2.4 and will be removed in version 3.0. Please use Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage instead.', E_USER_DEPRECATED);
14+
trigger_error('The '.__NAMESPACE__.'\SessionCsrfProvider is deprecated since version 2.4 and will be removed in version 3.0. Use the Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage class instead.', E_USER_DEPRECATED);
1515

1616
use Symfony\Component\HttpFoundation\Session\Session;
1717

@@ -23,8 +23,8 @@
2323
*
2424
* @author Bernhard Schussek <[email protected]>
2525
*
26-
* @deprecated Deprecated since version 2.4, to be removed in Symfony 3.0. Use
27-
* {@link \Symfony\Component\Security\Csrf\CsrfTokenManager} in
26+
* @deprecated since version 2.4, to be removed in 3.0.
27+
* Use {@link \Symfony\Component\Security\Csrf\CsrfTokenManager} in
2828
* combination with {@link \Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage}
2929
* instead.
3030
*/

0 commit comments

Comments
 (0)