minor #13060 [2.7] adds deprecation notices. (hhamon)

fabpot · fabpot · commit 419416de6fb4 · 2015-01-05T21:51:33.000+01:00
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.
diff --git a/OptionsResolver.php b/OptionsResolver.php
@@ -1011,20 +1011,24 @@ public function count()
     /**
      * Alias of {@link setDefault()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function set($option, $value)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the setDefaults() method instead.', E_USER_DEPRECATED);
+
         return $this->setDefault($option, $value);
     }
 
     /**
      * Shortcut for {@link clear()} and {@link setDefaults()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function replace(array $defaults)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the clear() and setDefaults() methods instead.', E_USER_DEPRECATED);
+
         $this->clear();
 
         return $this->setDefaults($defaults);
@@ -1033,40 +1037,48 @@ public function replace(array $defaults)
     /**
      * Alias of {@link setDefault()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function overload($option, $value)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the setDefault() method instead.', E_USER_DEPRECATED);
+
         return $this->setDefault($option, $value);
     }
 
     /**
      * Alias of {@link offsetGet()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function get($option)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the ArrayAccess syntax instead to get an option value.', E_USER_DEPRECATED);
+
         return $this->offsetGet($option);
     }
 
     /**
      * Alias of {@link offsetExists()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function has($option)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the ArrayAccess syntax instead to get an option value.', E_USER_DEPRECATED);
+
         return $this->offsetExists($option);
     }
 
     /**
      * Shortcut for {@link clear()} and {@link setDefaults()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function replaceDefaults(array $defaultValues)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the clear() and setDefaults() methods instead.', E_USER_DEPRECATED);
+
         $this->clear();
 
         return $this->setDefaults($defaultValues);
@@ -1075,20 +1087,24 @@ public function replaceDefaults(array $defaultValues)
     /**
      * Alias of {@link setDefined()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function setOptional(array $optionNames)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the setDefined() method instead.', E_USER_DEPRECATED);
+
         return $this->setDefined($optionNames);
     }
 
     /**
      * Alias of {@link isDefined()}.
      *
-     * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.
+     * @deprecated since version 2.6, to be removed in 3.0.
      */
     public function isKnown($option)
     {
+        trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the isDefined() method instead.', E_USER_DEPRECATED);
+
         return $this->isDefined($option);
     }
 
diff --git a/OptionsResolverInterface.php b/OptionsResolverInterface.php
@@ -11,8 +11,6 @@
 
 namespace Symfony\Component\OptionsResolver;
 
-trigger_error('The "Symfony\Component\OptionsResolver\OptionsResolverInterface" interface was deprecated in version 2.6 and will be removed in 3.0. Use "Symfony\Component\OptionsResolver\OptionsResolver" instead.', E_USER_DEPRECATED);
-
 use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 use Symfony\Component\OptionsResolver\Exception\MissingOptionsException;
 use Symfony\Component\OptionsResolver\Exception\OptionDefinitionException;
@@ -22,6 +20,7 @@
  *
  * @deprecated since version 2.6, to be removed in Symfony 3.0.
  *             Use {@link OptionsResolver} instead.
+ * @deprecated since version 2.6, to be removed in 3.0. Use {@link OptionsResolver} instead.
  */
 interface OptionsResolverInterface
 {
diff --git a/Tests/LegacyOptionsTest.php b/Tests/LegacyOptionsTest.php
@@ -33,7 +33,7 @@ public function testSetLazyOption()
         $test = $this;
 
         $this->options->set('foo', function (Options $options) use ($test) {
-           return 'dynamic';
+            return 'dynamic';
         });
 
         $this->assertEquals(array('foo' => 'dynamic'), $this->options->resolve());

Original file line number	Diff line number	Diff line change
`@@ -1011,20 +1011,24 @@ public function count()`
`1011`	`1011`	`/**`
`1012`	`1012`	`* Alias of {@link setDefault()}.`
`1013`	`1013`	`*`
`1014`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1014`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1015`	`1015`	`*/`
`1016`	`1016`	`public function set($option, $value)`
`1017`	`1017`	`{`
	`1018`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the setDefaults() method instead.', E_USER_DEPRECATED);`
	`1019`	`+`
`1018`	`1020`	`return $this->setDefault($option, $value);`
`1019`	`1021`	`}`
`1020`	`1022`
`1021`	`1023`	`/**`
`1022`	`1024`	`* Shortcut for {@link clear()} and {@link setDefaults()}.`
`1023`	`1025`	`*`
`1024`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1026`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1025`	`1027`	`*/`
`1026`	`1028`	`public function replace(array $defaults)`
`1027`	`1029`	`{`
	`1030`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the clear() and setDefaults() methods instead.', E_USER_DEPRECATED);`
	`1031`	`+`
`1028`	`1032`	`$this->clear();`
`1029`	`1033`
`1030`	`1034`	`return $this->setDefaults($defaults);`
`@@ -1033,40 +1037,48 @@ public function replace(array $defaults)`
`1033`	`1037`	`/**`
`1034`	`1038`	`* Alias of {@link setDefault()}.`
`1035`	`1039`	`*`
`1036`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1040`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1037`	`1041`	`*/`
`1038`	`1042`	`public function overload($option, $value)`
`1039`	`1043`	`{`
	`1044`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the setDefault() method instead.', E_USER_DEPRECATED);`
	`1045`	`+`
`1040`	`1046`	`return $this->setDefault($option, $value);`
`1041`	`1047`	`}`
`1042`	`1048`
`1043`	`1049`	`/**`
`1044`	`1050`	`* Alias of {@link offsetGet()}.`
`1045`	`1051`	`*`
`1046`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1052`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1047`	`1053`	`*/`
`1048`	`1054`	`public function get($option)`
`1049`	`1055`	`{`
	`1056`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the ArrayAccess syntax instead to get an option value.', E_USER_DEPRECATED);`
	`1057`	`+`
`1050`	`1058`	`return $this->offsetGet($option);`
`1051`	`1059`	`}`
`1052`	`1060`
`1053`	`1061`	`/**`
`1054`	`1062`	`* Alias of {@link offsetExists()}.`
`1055`	`1063`	`*`
`1056`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1064`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1057`	`1065`	`*/`
`1058`	`1066`	`public function has($option)`
`1059`	`1067`	`{`
	`1068`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the ArrayAccess syntax instead to get an option value.', E_USER_DEPRECATED);`
	`1069`	`+`
`1060`	`1070`	`return $this->offsetExists($option);`
`1061`	`1071`	`}`
`1062`	`1072`
`1063`	`1073`	`/**`
`1064`	`1074`	`* Shortcut for {@link clear()} and {@link setDefaults()}.`
`1065`	`1075`	`*`
`1066`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1076`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1067`	`1077`	`*/`
`1068`	`1078`	`public function replaceDefaults(array $defaultValues)`
`1069`	`1079`	`{`
	`1080`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the clear() and setDefaults() methods instead.', E_USER_DEPRECATED);`
	`1081`	`+`
`1070`	`1082`	`$this->clear();`
`1071`	`1083`
`1072`	`1084`	`return $this->setDefaults($defaultValues);`
`@@ -1075,20 +1087,24 @@ public function replaceDefaults(array $defaultValues)`
`1075`	`1087`	`/**`
`1076`	`1088`	`* Alias of {@link setDefined()}.`
`1077`	`1089`	`*`
`1078`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1090`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1079`	`1091`	`*/`
`1080`	`1092`	`public function setOptional(array $optionNames)`
`1081`	`1093`	`{`
	`1094`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the setDefined() method instead.', E_USER_DEPRECATED);`
	`1095`	`+`
`1082`	`1096`	`return $this->setDefined($optionNames);`
`1083`	`1097`	`}`
`1084`	`1098`
`1085`	`1099`	`/**`
`1086`	`1100`	`* Alias of {@link isDefined()}.`
`1087`	`1101`	`*`
`1088`		`- * @deprecated Deprecated as of Symfony 2.6, to be removed in Symfony 3.0.`
	`1102`	`+ * @deprecated since version 2.6, to be removed in 3.0.`
`1089`	`1103`	`*/`
`1090`	`1104`	`public function isKnown($option)`
`1091`	`1105`	`{`
	`1106`	`+ trigger_error('The '.__METHOD__.' method is deprecated since version 2.6 and will be removed in 3.0. Use the isDefined() method instead.', E_USER_DEPRECATED);`
	`1107`	`+`
`1092`	`1108`	`return $this->isDefined($option);`
`1093`	`1109`	`}`
`1094`	`1110`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\OptionsResolver;`
`13`	`13`
`14`		`-trigger_error('The "Symfony\Component\OptionsResolver\OptionsResolverInterface" interface was deprecated in version 2.6 and will be removed in 3.0. Use "Symfony\Component\OptionsResolver\OptionsResolver" instead.', E_USER_DEPRECATED);`
`15`		`-`
`16`	`14`	`use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;`
`17`	`15`	`use Symfony\Component\OptionsResolver\Exception\MissingOptionsException;`
`18`	`16`	`use Symfony\Component\OptionsResolver\Exception\OptionDefinitionException;`
`@@ -22,6 +20,7 @@`
`22`	`20`	`*`
`23`	`21`	`* @deprecated since version 2.6, to be removed in Symfony 3.0.`
`24`	`22`	`* Use {@link OptionsResolver} instead.`
	`23`	`+ * @deprecated since version 2.6, to be removed in 3.0. Use {@link OptionsResolver} instead.`
`25`	`24`	`*/`
`26`	`25`	`interface OptionsResolverInterface`
`27`	`26`	`{`