Added converter from Value object to navitive PHP arrays and scalers

Author: judgej

composer.json

@@ -10,7 +10,7 @@
     "license": "MIT",
     "require": {
         "php": ">= 7.0.0",
-        "phpxmlrpc/phpxmlrpc": "~4.0"
+        "phpxmlrpc/phpxmlrpc": "~4.3"
     },
     "autoload": {
         "psr-4": {

src/OdooClient.php

@@ -9,6 +9,7 @@
 use PhpXmlRpc\Client;
 use PhpXmlRpc\Request;
 use PhpXmlRpc\Value;
+use PhpXmlRpc\Response;
 
 use Exception;
 
@@ -188,6 +189,13 @@ public function nullValue()
     /**
      * Example:
      * OdooApi::getClient()->search('res.partner', $criteria, 0, 10)
+     *
+     * @param string $modelName example res.partner
+     * @param array $criteria nested array of search criteria (Polish notation logic)
+     * @param int $offset
+     * @param int $limit
+     * @param string $order comma-separated list of fields
+     * @return Response
      */
     public function search(
         string $modelName,
@@ -198,11 +206,11 @@ public function search(
     ) {
         $msg = $this->getBaseObjectRequest($modelName, 'search');
 
-        $msg->addParam($this->objectifyArray($criteria));
+        $msg->addParam($this->nativeToValue($criteria));
 
-        $msg->addParam($this->intValue($offset)); // offset
-        $msg->addParam($this->intValue($limit));  // limit
-        $msg->addParam($this->stringValue($order)); // order, CSV list
+        $msg->addParam($this->intValue($offset));
+        $msg->addParam($this->intValue($limit));
+        $msg->addParam($this->stringValue($order));
 
         $response = $this->getXmlRpcClient('object')->send($msg);
 
@@ -212,14 +220,16 @@ public function search(
     /**
      * Example:
      * OdooApi::getClient()->search_count('res.partner', $criteria)
+     *
+     * @return integer
      */
     public function searchCount(
         string $modelName,
         array $criteria = []
     ) {
         $msg = $this->getBaseObjectRequest($modelName, 'search_count');
 
-        $msg->addParam($this->objectifyArray($criteria));
+        $msg->addParam($this->nativeToValue($criteria));
 
         $response = $this->getXmlRpcClient('object')->send($msg);
 
@@ -239,7 +249,7 @@ public function searchRead(
     ) {
         $msg = $this->getBaseObjectRequest($modelName, 'search_read');
 
-        $msg->addParam($this->objectifyArray($criteria));
+        $msg->addParam($this->nativeToValue($criteria));
 
         // To be fixed when we have Odoo 8 available to develop against.
 
@@ -264,7 +274,7 @@ public function read(
     ) {
         $msg = $this->getBaseObjectRequest($modelName, 'read');
 
-        $msg->addParam($this->objectifyArray($criteria));
+        $msg->addParam($this->nativeToValue($criteria));
 
         $response = $this->getXmlRpcClient('object')->send($msg);
 
@@ -308,7 +318,7 @@ public function getBaseObjectRequest(
      * Walk through the criteria array and convert scalar values to
      * XML-RPC objects, and nested arrays to array and struct objects.
      */
-    public function objectifyArray($item)
+    public function nativeToValue($item)
     {
         // If a scalar, then map to the appropriate object.
 
@@ -338,7 +348,7 @@ public function objectifyArray($item)
         // If an array, then deal with the children first.
 
         foreach ($item as $key => $element) {
-            $item[$key] = $this->objectifyArray($element);
+            $item[$key] = $this->nativeToValue($element);
         }
 
         // Map to an array or a struct, depending on whether a numeric
@@ -350,4 +360,39 @@ public function objectifyArray($item)
             return $this->structValue($item);
         }
     }
+
+    /**
+     * Convert a Value object into native PHP types.
+     * Basically the reverse of nativeToValue().
+     *
+     * @param Value the object to convert, which may contain nested objects
+     * @returns mixed a null, an array, a scalar, and may be nested
+     */
+    public function valueToNative(Value $value)
+    {
+        switch ($value->kindOf()) {
+            case 'array':
+                $result = [];
+                foreach ($value->getIterator() as $element) {
+                    $result[] = $this->valueToNative($element);
+                }
+                break;
+            case 'struct':
+                $result = [];
+                foreach ($value->getIterator() as $key => $element) {
+                    $result[$key] = $this->valueToNative($element);
+                }
+                break;
+            case 'scalar':
+                return $value->scalarval();
+                break;
+            default:
+                throw new Exception(sprintf(
+                    'Unexpected data type %s',
+                    $value->kindOf()
+                ));
+        }
+
+        return $result;
+    }
 }