Merge pull request #5 from xzag/feature-refactor

parse params as object feature

Author: georgique

Action.php

@@ -83,25 +83,6 @@ protected function restoreYiiRequest()
         return $this;
     }
 
-    /**
-     * Recursively converts object to an associative array.
-     * @param $obj
-     * @return array
-     */
-    protected function objToAssoc($obj) {
-        $result = (array) $obj;
-
-        if (is_array($result)) {
-            foreach ($result as $key => $value) {
-                if (is_object($value) || is_array($value)) {
-                    $result[$key] = $this->objToAssoc($value);
-                }
-            }
-        }
-
-        return $result;
-    }
-
     /**
      * @inheritdoc
      */
@@ -125,33 +106,23 @@ public function runWithParams($params)
                 try {
                     $request = new JsonRpcRequest();
                     $request->paramsPassMethod = $this->paramsPassMethod;
+                    $request->parseAsArray = $this->requestParseAsArray;
 
-                    // Handling params
-                    $params = ($this->requestParseAsArray)
-                        ? (isset($request->params) ? $this->objToAssoc($request->params) : [])
-                        : (isset($request->params) ? $request->params : new \stdClass());
-
-                    $requestData = ArrayHelper::toArray($requestData);
-                    $requestData['params'] = $params;
-
-                    $request->load($requestData, '');
+                    $request->load(ArrayHelper::toArray($requestData), '');
                     if ($request->validate()) {
                         $result = $request->execute();
                         if (!is_null($request->id)) {
                             $batchResponse[] = new SuccessResponse($request, $result);
                         }
-                    }
-                    else {
+                    } else {
                         foreach ($request->getFirstErrors() as $attribute => $error) {
                             $request->$attribute = null;
                         }
                         throw new InvalidRequestException();
                     }
-                }
-                catch (InvalidRequestException $e) {
+                } catch (InvalidRequestException $e) {
                     $batchResponse[] = new ErrorResponse($e, $request ?: null);
-                }
-                catch (JsonRpcException $e) {
+                } catch (JsonRpcException $e) {
                     // We do not return response to notifications
                     if ($request && !is_null($request->id)) {
                         $batchResponse[] = new ErrorResponse($e, $request ?: null);
@@ -160,8 +131,7 @@ public function runWithParams($params)
 
                 $this->restoreYiiRequest();
             }
-        }
-        catch (JsonRpcException $e) {
+        } catch (JsonRpcException $e) {
             return new ErrorResponse($e);
         }
 

Controller.php

@@ -24,17 +24,17 @@ class Controller extends \yii\web\Controller
     public $paramsPassMethod = self::JSON_RPC_PARAMS_PASS_FUNCARGS;
 
     /**
-     * @var array Whether JSON parse should parse objects in `params` as associate arrays or objects
+     * @var array Whether JSON parse should parse objects in `params` as associative arrays or objects
      */
     public $requestParseAsArray = true;
-  
+
     public function actions()
     {
         return [
             'index' => [
                 'class' => Action::class,
                 'paramsPassMethod' => $this->paramsPassMethod,
-                'requestParseAsArray' => $this->requestParseAsArray,
+                'requestParseAsArray' => $this->requestParseAsArray
             ]
         ];
     }

JsonRpcRequest.php

@@ -28,6 +28,7 @@ class JsonRpcRequest extends Model
     public $params = [];
 
     public $paramsPassMethod;
+    public $parseAsArray;
 
     /**
      * @inheritdoc
@@ -166,14 +167,21 @@ public function execute()
             if ($this->paramsPassMethod == Controller::JSON_RPC_PARAMS_PASS_BODY) {
                 $app->request->setBodyParams($this->params);
                 $app->request->setRawBody(Json::encode($this->params));
-                $result = $app->runAction($routeParsed, $params);
+                $result = $app->runAction($routeParsed);
             } else {
                 if (ArrayHelper::isAssociative($this->params)) {
                     $params += $this->params;
                 } else {
                     // allow non-named parameters
                     $params += $this->bindParamsArray($routeParsed, $this->params);
                 }
+
+                if (is_array($params) && !$this->parseAsArray) {
+                    foreach ($params as $key => $value) {
+                        $params[$key] = Json::decode(Json::encode($value), false);
+                    }
+                }
+
                 $result = $app->runAction($routeParsed, $params);
             }
         } catch (JsonRpcException $e) {

demo/controllers/BodyParamsJsonRpcController.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace app\controllers;
+
+use \georgique\yii2\jsonrpc\Controller;
+
+class BodyParamsJsonRpcController extends Controller
+{
+    // Disable CSRF validation for JSON-RPC POST requests
+    public $enableCsrfValidation = false;
+
+    public $paramsPassMethod = self::JSON_RPC_PARAMS_PASS_BODY;
+}

demo/controllers/DemoController.php

@@ -16,6 +16,31 @@ public function actionSomeMethod()
         return "Some response";
     }
 
+    /**
+     * @param $params
+     * @return mixed
+     */
+    public function actionEcho(array $params)
+    {
+        return [
+            'params' => $params,
+            'type' => gettype($params)
+        ];
+    }
+
+    public function actionEchoObject($params)
+    {
+        return [
+            'params' => $params,
+            'type' => gettype($params)
+        ];
+    }
+
+    public function actionObjectFoo($object)
+    {
+        return $object->foo;
+    }
+
     /**
      * @param $foo
      * @param $bar
@@ -53,12 +78,30 @@ public function actionSum($a, $b)
         return $a + $b;
     }
 
-    public function actionSumList($params)
+    /**
+     * @return mixed
+     * @throws \yii\base\InvalidConfigException
+     */
+    public function actionSumIntegerList()
     {
-        //var_dump($params);
+        $params = \Yii::$app->request->getBodyParams();
         return array_reduce($params, function ($acc, $item) {
-            $acc += $item;
+            $acc += is_int($item) ? $item : 0;
             return $acc;
         }, 0);
     }
+
+    /**
+     * @return string
+     * @throws \yii\base\InvalidConfigException
+     */
+    public function actionDumpRequest()
+    {
+        $output = "Params received: ";
+        $output_chunks = array();
+        foreach (\Yii::$app->request->getBodyParams() as $name => $value) {
+            $output_chunks[] = "$name = $value\n";
+        }
+        return $output . implode(', ', $output_chunks) . '.';
+    }
 }

demo/controllers/JsonRpcController.php

@@ -11,9 +11,4 @@ class JsonRpcController extends Controller
 
     // Disable CSRF validation for JSON-RPC POST requests
     public $enableCsrfValidation = false;
-
-    public function actionVariadic(... $params)
-    {
-        var_dump($params);
-    }
 }

demo/controllers/ObjectParamsJsonRpcController.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace app\controllers;
+
+use \georgique\yii2\jsonrpc\Controller;
+
+class ObjectParamsJsonRpcController extends Controller
+{
+    // Disable CSRF validation for JSON-RPC POST requests
+    public $enableCsrfValidation = false;
+
+    public $requestParseAsArray = false;
+}