Support ArrayAccess for mapped models.

This allows pluck() to be used on fetched resource collections,
which is very handy when scanning.

Author: judgej

src/HasModelDataTrait.php

@@ -49,4 +49,36 @@ public function jsonSerialize()
     {
         return $this->data;
     }
+
+    /**
+     * Supports ArrayAccess
+     */
+    public function offsetExists($offset): bool
+    {
+        return $this->get($offset) !== null;
+    }
+
+    /**
+     * Supports ArrayAccess
+     */
+    public function offsetGet($offset)
+    {
+        return $this->get($offset);
+    }
+
+    /**
+     * Supports ArrayAccess
+     */
+    public function offsetSet($offset, $value): void
+    {
+        data_set($this->data, $offset, $value);
+    }
+
+    /**
+     * Supports ArrayAccess
+     */
+    public function offsetUnset($offset): void
+    {
+        $this->offsetSet($offset, null);
+    }
 }

src/ModelInterface.php

@@ -7,8 +7,9 @@
  */
 
 use JsonSerializable;
+use ArrayAccess;
 
-interface ModelInterface extends JsonSerializable
+interface ModelInterface extends JsonSerializable, ArrayAccess
 {
     /**
      * Get a model instance data item, using "dot" notation.

src/OdooClient.php

@@ -66,6 +66,10 @@ class OdooClient
     // (6, _, ids)
     const RELATION_REPLACE_ALL_LINKS = 6;
 
+    const API_TYPE_COMMON = 'common';
+    const API_TYPE_OBJECT = 'object';
+    const API_TYPE_DB = 'db';
+
     /**
      * Later versions of the API include a version number e.g. /xmlrpc/2/
      */
@@ -162,7 +166,7 @@ public function getUserId()
 
         // Fetch the user ID from the server.
 
-        $xmlRpcClient = $this->getXmlRpcClient('common');
+        $xmlRpcClient = $this->getXmlRpcClient(static::API_TYPE_COMMON);
 
         // Build login parameters array.
 
@@ -278,7 +282,7 @@ public function search(
         $msg->addParam($this->intValue($limit));
         $msg->addParam($this->stringValue($order));
 
-        $this->response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
         return collect($this->responseAsNative());
     }
@@ -297,7 +301,7 @@ public function searchCount(
 
         $msg->addParam($this->nativeToValue($criteria));
 
-        $this->response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
         return $this->valueToNative();
     }
@@ -314,7 +318,7 @@ public function searchRead(
         $order = ''
     ) {
         if (version_compare('8.0', $this->serverVersion) === 1) {
-            // Less than Odoo 8.0, so search_read is not supported.
+            // For less than Odoo 8.0, search_read is not supported.
             // However, we will emulate it.
 
             $ids = $this->search(
@@ -335,38 +339,20 @@ public function searchRead(
             $msg->addParam($this->intValue($limit));
             $msg->addParam($this->stringValue($order));
 
-            $this->response = $this->getXmlRpcClient('object')->send($msg);
-        }
+            $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
-        return $this->response;
-    }
+            // FIXME: these need to be mapped onto models instead of
+            // being returned as native arrays.
 
-    /**
-     * Same as searchRead but returning a native PHP array.
-     */
-    public function searchReadArray(
-        string $modelName,
-        array $criteria = [],
-        $offset = 0,
-        $limit = self::DEFAULT_LIMIT,
-        $order = ''
-    ) {
-        $this->response = $this->searchRead(
-            $modelName,
-            $criteria,
-            $offset,
-            $limit,
-            $order
-        );
-
-        return $this->responseAsNative();
+            return $this->responseAsNative();
+        }
     }
 
     /**
      * @param string $modelName example res.partner
      * @param array $instanceIds list of model instance IDs to read and return
      * @param array $options varies with API versions see documentation
-     * @return Response
+     * @return Collection of ModelInterface
      */
     public function read(
         string $modelName,
@@ -381,7 +367,7 @@ public function read(
             $msg->addParam($this->nativeToValue($options));
         }
 
-        $this->response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
         $data = $this->responseAsNative();
 
@@ -401,7 +387,7 @@ public function version()
     {
         $msg = new Request('version');
 
-        $this->response = $this->getXmlRpcClient('common')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_COMMON)->send($msg);
 
         return $this->responseAsNative();
     }
@@ -417,7 +403,7 @@ public function create(string $modelName, array $fields)
 
         $msg->addParam($this->nativeToValue($fields));
 
-        $this->response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
         return $this->responseAsNative();
     }
@@ -434,7 +420,7 @@ public function write(string $modelName, int $resourceId, array $fields)
         $msg->addParam($this->nativeToValue([$resourceId]));
         $msg->addParam($this->nativeToValue($fields));
 
-        $this->response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
         return $this->responseAsNative();
     }
@@ -450,7 +436,7 @@ public function unlink(string $modelName, int $resourceId)
 
         $msg->addParam($this->nativeToValue([$resourceId]));
 
-        $this->response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
         return $this->responseAsNative();
     }
@@ -465,7 +451,7 @@ public function fieldsGet(string $modelName)
     {
         $msg = $this->getBaseObjectRequest($modelName, 'fields_get');
 
-        $this->response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
         return $this->responseAsNative();
     }
@@ -625,7 +611,7 @@ public function load(string $modelName, iterable $records)
             $msg->addParam($this->nativeToValue($group['keys']));
             $msg->addParam($this->nativeToValue($group['records']));
 
-            $this->response = $this->getXmlRpcClient('object')->send($msg);
+            $this->response = $this->getXmlRpcClient(static::API_TYPE_OBJECT)->send($msg);
 
             $groupResult = $this->responseAsNative();