Merge pull request #649 from entering/request-param-optional-origin-name

Add a option to specify the request original name

Author: lsmith77

Controller/Annotations/Param.php

@@ -22,6 +22,8 @@ abstract class Param
     /** @var string */
     public $name;
     /** @var string */
+    public $key = null;
+    /** @var string */
     public $requirements = '';
     /** @var mixed */
     public $default = null;
@@ -33,4 +35,12 @@ abstract class Param
     public $array = false;
     /** @var boolean */
     public $nullable = false;
+
+    /**
+     * @return string
+     */
+    public function getKey()
+    {
+        return $this->key ?: $this->name;
+    }
 }

Request/ParamFetcher.php

@@ -81,6 +81,7 @@ public function get($name, $strict = null)
             throw new \InvalidArgumentException(sprintf("No @QueryParam/@RequestParam configuration for parameter '%s'.", $name));
         }
 
+        /** @var Param $config */
         $config   = $this->params[$name];
         $nullable = $config->nullable;
         $default  = $config->default;
@@ -94,9 +95,9 @@ public function get($name, $strict = null)
         }
 
         if ($config instanceof RequestParam) {
-            $param = $this->request->request->get($name, $default);
+            $param = $this->request->request->get($config->getKey(), $default);
         } elseif ($config instanceof QueryParam) {
-            $param = $this->request->query->get($name, $default);
+            $param = $this->request->query->get($config->getKey(), $default);
         } else {
             $param = null;
         }

Resources/doc/annotations-reference.md

@@ -11,6 +11,7 @@ use FOS\RestBundle\Controller\Annotations\QueryParam;
 /**
  * @QueryParam(
  *   name="",
+ *   key=null,
  *   requirements="",
  *   default=null,
  *   description="",
@@ -29,6 +30,7 @@ use FOS\RestBundle\Controller\Annotations\RequestParam;
 /**
  * @RequestParam(
  *   name="",
+ *   key=null,
  *   requirements="",
  *   default=null,
  *   description="",

Tests/Request/ParamFetcherTest.php

@@ -76,6 +76,7 @@ public function setup()
 
         $annotations['biz'] = new QueryParam;
         $annotations['biz']->name = 'biz';
+        $annotations['biz']->key = 'business';
         $annotations['biz']->requirements = '\d+';
         $annotations['biz']->default = null;
         $annotations['biz']->nullable = true;
@@ -330,4 +331,11 @@ public function testExceptionOnNonConfiguredParameter()
         $queryFetcher->setController($this->controller);
         $queryFetcher->get('none', '42');
     }
+
+    public function testKeyPrecedenceOverName()
+    {
+        $queryFetcher = $this->getParamFetcher(array('business' => 5));
+        $queryFetcher->setController($this->controller);
+        $this->assertEquals(5, $queryFetcher->get('biz'));
+    }
 }