[HttpFoundation] deprecated finding deep items in Request and ParameterBag

xabbuh · xabbuh · commit 64ec8b4993ae · 2015-04-03T18:19:27.000+02:00
diff --git a/src/Symfony/Component/HttpFoundation/ParameterBag.php b/src/Symfony/Component/HttpFoundation/ParameterBag.php
@@ -99,9 +99,15 @@ public function add(array $parameters = array())
      * @throws \InvalidArgumentException
      *
      * @api
+     *
+     * @deprecated Finding deep items is deprecated since version 2.7, to be removed in 3.0.
      */
     public function get($path, $default = null, $deep = false)
     {
+        if (true === $deep) {
+            trigger_error('Using paths to find deeper items in '.__METHOD__.' is deprecated since version 2.7 and will be removed in 3.0. Filter the returned value in your own code instead.', E_USER_DEPRECATED);
+        }
+
         if (!$deep || false === $pos = strpos($path, '[')) {
             return array_key_exists($path, $this->parameters) ? $this->parameters[$path] : $default;
         }
diff --git a/src/Symfony/Component/HttpFoundation/Request.php b/src/Symfony/Component/HttpFoundation/Request.php
@@ -743,9 +743,15 @@ public static function getHttpMethodParameterOverride()
      * @param bool   $deep    is parameter deep in multidimensional array
      *
      * @return mixed
+     *
+     * @deprecated Finding deep items is deprecated since version 2.7, to be removed in 3.0.
      */
     public function get($key, $default = null, $deep = false)
     {
+        if (true === $deep) {
+            trigger_error('Using paths to find deeper items in '.__METHOD__.' is deprecated since version 2.7 and will be removed in 3.0. Filter the returned value in your own code instead.', E_USER_DEPRECATED);
+        }
+
         if ($this !== $result = $this->query->get($key, $this, $deep)) {
             return $result;
         }
diff --git a/src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php b/src/Symfony/Component/HttpFoundation/Tests/ParameterBagTest.php
@@ -89,7 +89,7 @@ public function testGetDoesNotUseDeepByDefault()
      * @dataProvider getInvalidPaths
      * @expectedException \InvalidArgumentException
      */
-    public function testGetDeepWithInvalidPaths($path)
+    public function testLegacyGetDeepWithInvalidPaths($path)
     {
         $bag = new ParameterBag(array('foo' => array('bar' => 'moo')));
 
@@ -106,7 +106,7 @@ public function getInvalidPaths()
         );
     }
 
-    public function testGetDeep()
+    public function testLegacyGetDeep()
     {
         $bag = new ParameterBag(array('foo' => array('bar' => array('moo' => 'boo'))));
 

Original file line number	Diff line number	Diff line change
`@@ -99,9 +99,15 @@ public function add(array $parameters = array())`
`99`	`99`	`* @throws \InvalidArgumentException`
`100`	`100`	`*`
`101`	`101`	`* @api`
	`102`	`+ *`
	`103`	`+ * @deprecated Finding deep items is deprecated since version 2.7, to be removed in 3.0.`
`102`	`104`	`*/`
`103`	`105`	`public function get($path, $default = null, $deep = false)`
`104`	`106`	`{`
	`107`	`+ if (true === $deep) {`
	`108`	`+ trigger_error('Using paths to find deeper items in '.__METHOD__.' is deprecated since version 2.7 and will be removed in 3.0. Filter the returned value in your own code instead.', E_USER_DEPRECATED);`
	`109`	`+ }`
	`110`	`+`
`105`	`111`	`if (!$deep \|\| false === $pos = strpos($path, '[')) {`
`106`	`112`	`return array_key_exists($path, $this->parameters) ? $this->parameters[$path] : $default;`
`107`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -743,9 +743,15 @@ public static function getHttpMethodParameterOverride()`
`743`	`743`	`* @param bool $deep is parameter deep in multidimensional array`
`744`	`744`	`*`
`745`	`745`	`* @return mixed`
	`746`	`+ *`
	`747`	`+ * @deprecated Finding deep items is deprecated since version 2.7, to be removed in 3.0.`
`746`	`748`	`*/`
`747`	`749`	`public function get($key, $default = null, $deep = false)`
`748`	`750`	`{`
	`751`	`+ if (true === $deep) {`
	`752`	`+ trigger_error('Using paths to find deeper items in '.__METHOD__.' is deprecated since version 2.7 and will be removed in 3.0. Filter the returned value in your own code instead.', E_USER_DEPRECATED);`
	`753`	`+ }`
	`754`	`+`
`749`	`755`	`if ($this !== $result = $this->query->get($key, $this, $deep)) {`
`750`	`756`	`return $result;`
`751`	`757`	`}`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ public function testGetDoesNotUseDeepByDefault()`
`89`	`89`	`* @dataProvider getInvalidPaths`
`90`	`90`	`* @expectedException \InvalidArgumentException`
`91`	`91`	`*/`
`92`		`- public function testGetDeepWithInvalidPaths($path)`
	`92`	`+ public function testLegacyGetDeepWithInvalidPaths($path)`
`93`	`93`	`{`
`94`	`94`	`$bag = new ParameterBag(array('foo' => array('bar' => 'moo')));`
`95`	`95`
`@@ -106,7 +106,7 @@ public function getInvalidPaths()`
`106`	`106`	`);`
`107`	`107`	`}`
`108`	`108`
`109`		`- public function testGetDeep()`
	`109`	`+ public function testLegacyGetDeep()`
`110`	`110`	`{`
`111`	`111`	`$bag = new ParameterBag(array('foo' => array('bar' => array('moo' => 'boo'))));`
`112`	`112`