Additional *Array() convenience methods; emulate searchRead for Odoo <8.0

Author: judgej

README.md

@@ -71,6 +71,26 @@ $client->searchCount('res.partner', $criteria);
 $client->read('res.partner', [17858, 17852])->value()->me['array']
 ```
 
+# Query methods
+
+The following methods are supported and will return an XML-RPC response:
+
+* search()
+* searchRead()
+* read()
+
+The following helper functions return a native PHp type insead:
+
+* searchArray - array
+* searchReadArray - array
+* readArray - array
+* searchCount - integer
+* getResourceId - integer
+
+Note that `searchRead` will emulate the server's `search_read` for
+Odoo versions less than 8.0 (OpenERP) but use the native `search_read`
+for Odoo 8.0 upwards.
+
 # TODO
 
 * An elegant way to parse the results, as the `Value` objects can be

src/OdooClient.php

@@ -26,6 +26,8 @@ class OdooClient
     const TYPE_DOUBLE   = 'double';
     const TYPE_NULL     = 'null';
 
+    const DEFAULT_LIMIT = 100;
+
     /**
      *
      */
@@ -41,6 +43,11 @@ class OdooClient
      */
     protected $userId;
 
+    /**
+     * The version of the server, fetched when logging in.
+     */
+    protected $serverVersion;
+
     /**
      * Config data.
      */
@@ -131,10 +138,16 @@ public function getUserId()
 
         // Grab the User ID.
 
-        $userId = $response->value()->me['int'];
+        $this->userId = $this->valueToNative($response->value());
 
-        if ($userId > 0) {
-            return $userId;
+        // Get the server version for capabilities.
+
+        $version = $this->version();
+
+        $this->serverVersion = $version['server_version'] ?? '';
+
+        if ($this->userId > 0) {
+            return $this->userId;
         }
 
         throw new Exception(sprintf(
@@ -201,7 +214,7 @@ public function search(
         string $modelName,
         array $criteria = [],
         $offset = 0,
-        $limit = 100,
+        $limit = self::DEFAULT_LIMIT,
         $order = ''
     ) {
         $msg = $this->getBaseObjectRequest($modelName, 'search');
@@ -217,9 +230,42 @@ public function search(
         return $response;
     }
 
+    /**
+     * Same as search() but returns a native array.
+     *
+     * @return array
+     */
+    public function searchArray(
+        string $modelName,
+        array $criteria = [],
+        $offset = 0,
+        $limit = self::DEFAULT_LIMIT,
+        $order = ''
+    ) {
+        $response = $this->search(
+            $modelName,
+            $criteria,
+            $offset,
+            $limit,
+            $order
+        );
+
+        if ($response->value() instanceof Value) {
+            return $this->valueToNative($response->value());
+        }
+
+        // An error in the criteria or model provided.
+
+        throw new Exception(sprintf(
+            'Failed to search model %s; response was "%s"',
+            $modelName,
+            $response->value()
+        ));
+    }
+
     /**
      * Example:
-     * OdooApi::getClient()->search_count('res.partner', $criteria)
+     * OdooApi::getClient()->searchCount('res.partner', $criteria)
      *
      * @return integer
      */
@@ -233,7 +279,7 @@ public function searchCount(
 
         $response = $this->getXmlRpcClient('object')->send($msg);
 
-        return $response->value()->me['int'];
+        return $this->valueToNative($response->value());
     }
 
     /**
@@ -244,45 +290,117 @@ public function searchRead(
         string $modelName,
         array $criteria = [],
         $offset = 0,
-        $limit = 100,
+        $limit = self::DEFAULT_LIMIT,
         $order = ''
     ) {
-        $msg = $this->getBaseObjectRequest($modelName, 'search_read');
+        if (version_compare('8.0', $this->serverVersion) === 1) {
+            // Less than Odoo 8.0, so search_read is not supported.
+            // However, we will emulate it.
+
+            $ids = $this->searchArray(
+                $modelName,
+                $criteria,
+                $offset,
+                $limit,
+                $order
+            );
+
+            return $this->read($modelName, $ids);
+        } else {
+            $msg = $this->getBaseObjectRequest($modelName, 'search_read');
 
-        $msg->addParam($this->nativeToValue($criteria));
+            $msg->addParam($this->nativeToValue($criteria));
 
-        // To be fixed when we have Odoo 8 available to develop against.
+            $msg->addParam($this->intValue($offset));
+            $msg->addParam($this->intValue($limit));
+            $msg->addParam($this->stringValue($order));
 
-        //$msg->addParam($this->stringValue('id'));
+            $response = $this->getXmlRpcClient('object')->send($msg);
+        }
 
-        //$msg->addParam($this->stringValue($offset)); // offset
-        //$msg->addParam($this->intValue($limit));  // limit
-        //$msg->addParam($this->stringValue($order)); // order, CSV list
-        //$msg->addParam($this->structValue(['fields' => $this->arrayValue(['id', 'name'])]));
+        return $response;
+    }
 
-        $response = $this->getXmlRpcClient('object')->send($msg);
+    /**
+     * Same as searchRead but returning a native PHP array.
+     */
+    public function searchReadArray(
+        string $modelName,
+        array $criteria = [],
+        $offset = 0,
+        $limit = self::DEFAULT_LIMIT,
+        $order = ''
+    ) {
+        $response = $this->searchRead(
+            $modelName,
+            $criteria,
+            $offset,
+            $limit,
+            $order
+        );
 
-        return $response;
+        return $this->valueToNative($response->value());
     }
 
     /**
-     * $criteria is an array of IDs.
+     * @param array $instanceIds list of model instance IDs to read and return
+     * @return Response
      */
     public function read(
         string $modelName,
-        array $criteria = []
+        array $instanceIds = []
     ) {
         $msg = $this->getBaseObjectRequest($modelName, 'read');
 
-        $msg->addParam($this->nativeToValue($criteria));
+        $msg->addParam($this->nativeToValue($instanceIds));
 
         $response = $this->getXmlRpcClient('object')->send($msg);
 
         return $response;
     }
 
+    /**
+     * Same as read() but returns a native array.
+     */
+    public function readArray(
+        string $modelName,
+        array $instanceIds = []
+    ) {
+        $response = $this->read(
+            $modelName,
+            $instanceIds
+        );
+
+        if ($response->value() instanceof Value) {
+            return $this->valueToNative($response->value());
+        }
+
+        // An error in the instanceIds or model provided.
+
+        throw new Exception(sprintf(
+            'Failed to read model %s; response was "%s"',
+            $modelName,
+            $response->value()
+        ));
+    }
+
+    /**
+     * Get the server version information.
+     *
+     * @return array
+     */
+    public function version()
+    {
+        $msg = new Request('version');
+
+        $response = $this->getXmlRpcClient('common')->send($msg);
+
+        return $this->valueToNative($response->value());
+    }
+
     //
     // TODO: actions to implement = create write unlink
+    // Also: fields_get, version
     //
 
     /**
@@ -310,8 +428,7 @@ public function getResourceId(string $externalId, string $model = null)
 
         $criteria[] = ['name', '=', $name];
 
-        $result = $this->search('ir.model.data', $criteria);
-        $irModelDataIds = $this->valueToNative($result->value());
+        $irModelDataIds = $this->searchArray('ir.model.data', $criteria);
         $irModelDataId = collect($irModelDataIds)->first();
 
         if ($irModelDataId === null) {
@@ -321,8 +438,9 @@ public function getResourceId(string $externalId, string $model = null)
 
         // Now read the full record to get the resource ID.
 
-        $irModelDataArray = $this->valueToNative(
-            $this->read('ir.model.data', [$irModelDataId])->value()
+        $irModelDataArray = $this->readArray(
+            'ir.model.data',
+            [$irModelDataId]
         );
         $irModelData = collect($irModelDataArray)->first();