Support write() and create()

Author: judgej

README.md

@@ -97,10 +97,11 @@ The following helper functions return a native PHP type insead:
 * readArray - array
 * searchCount - integer
 * getResourceId - integer
-* getResourceId2 - array
+* getResourceIds - array
 
 (I'm torn between this approach and a more fluent approach such as
-`$client->firstOnly()->asArray()->read(...)`)
+`$client->firstOnly()->asArray()->read(...)` to set the context that
+will apply to the next command.)
 
 Note that `searchRead` will emulate the server's `search_read` for
 Odoo versions less than 8.0 (OpenERP) but use the native `search_read`
@@ -124,6 +125,8 @@ fail to make the OpenERP/Odoo version number clear.
 
 # TODO
 
-* The write functions are not written yet (create, write and unlink).
+* The write functions are not written yet (~~create~~, ~~write~~ and unlink).
 * Examples on how relationships are managed are needed, since they are
-  one of the areas that cause the most confusion.
+  one of the areas that cause the most confusion. It's actuall pretty
+  easy once you see the technique, though a helper may be useful to
+  put together the data structure needed.

src/OdooClient.php

@@ -66,7 +66,7 @@ class OdooClient
     // Can not be used on One2many.
     // Can not be used in create().
     // (5, _, _)
-    const RELATION_REMOVE_ALL_LINKs = 5;
+    const RELATION_REMOVE_ALL_LINKS = 5;
     //
     // Replaces all existing records in the set by the ids list,
     // equivalent to using the command 5 followed by a command 4
@@ -108,6 +108,11 @@ class OdooClient
     protected $username;
     protected $password;
 
+    /**
+     * The last response.
+     */
+    protected $response;
+
     /**
      * @param array $config the connection configuration details
      */
@@ -176,7 +181,7 @@ public function getUserId()
         // Send the request.
 
         try {
-            $response = $xmlRpcClient->send($msg);
+            $this->response = $xmlRpcClient->send($msg);
         } catch (Exception $e) {
             // Some connection problem.
 
@@ -188,7 +193,7 @@ public function getUserId()
 
         // Grab the User ID.
 
-        $this->userId = $this->valueToNative($response->value());
+        $this->userId = $this->valueToNative($this->response->value());
 
         // Get the server version for capabilities.
 
@@ -275,9 +280,9 @@ public function search(
         $msg->addParam($this->intValue($limit));
         $msg->addParam($this->stringValue($order));
 
-        $response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient('object')->send($msg);
 
-        return $response;
+        return $this->response;
     }
 
     /**
@@ -292,24 +297,24 @@ public function searchArray(
         $limit = self::DEFAULT_LIMIT,
         $order = ''
     ) {
-        $response = $this->search(
+        $this->response = $this->search(
             $modelName,
             $criteria,
             $offset,
             $limit,
             $order
         );
 
-        if ($response->value() instanceof Value) {
-            return $this->valueToNative($response->value());
+        if ($this->response->value() instanceof Value) {
+            return $this->valueToNative($this->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()
+            $this->response->value()
         ));
     }
 
@@ -327,9 +332,9 @@ public function searchCount(
 
         $msg->addParam($this->nativeToValue($criteria));
 
-        $response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient('object')->send($msg);
 
-        return $this->valueToNative($response->value());
+        return $this->valueToNative($this->response->value());
     }
 
     /**
@@ -365,10 +370,10 @@ public function searchRead(
             $msg->addParam($this->intValue($limit));
             $msg->addParam($this->stringValue($order));
 
-            $response = $this->getXmlRpcClient('object')->send($msg);
+            $this->response = $this->getXmlRpcClient('object')->send($msg);
         }
 
-        return $response;
+        return $this->response;
     }
 
     /**
@@ -381,15 +386,15 @@ public function searchReadArray(
         $limit = self::DEFAULT_LIMIT,
         $order = ''
     ) {
-        $response = $this->searchRead(
+        $this->response = $this->searchRead(
             $modelName,
             $criteria,
             $offset,
             $limit,
             $order
         );
 
-        return $this->valueToNative($response->value());
+        return $this->valueToNative($this->response->value());
     }
 
     /**
@@ -411,9 +416,9 @@ public function read(
             $msg->addParam($this->nativeToValue($options));
         }
 
-        $response = $this->getXmlRpcClient('object')->send($msg);
+        $this->response = $this->getXmlRpcClient('object')->send($msg);
 
-        return $response;
+        return $this->response;
     }
 
     /**
@@ -424,22 +429,22 @@ public function readArray(
         array $instanceIds = [],
         array $options = []
     ) {
-        $response = $this->read(
+        $this->response = $this->read(
             $modelName,
             $instanceIds,
             $options
         );
 
-        if ($response->value() instanceof Value) {
-            return $this->valueToNative($response->value());
+        if ($this->response->value() instanceof Value) {
+            return $this->valueToNative($this->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()
+            $this->response->value()
         ));
     }
 
@@ -452,13 +457,58 @@ public function version()
     {
         $msg = new Request('version');
 
-        $response = $this->getXmlRpcClient('common')->send($msg);
+        $this->response = $this->getXmlRpcClient('common')->send($msg);
 
-        return $this->valueToNative($response->value());
+        return $this->valueToNative($this->response->value());
+    }
+
+    /**
+     * Create a new resource.
+     *
+     * @param array $fields 
+     */
+    public function create(string $modelName, array $fields)
+    {
+        $msg = $this->getBaseObjectRequest($modelName, 'create');
+
+        $msg->addParam($this->nativeToValue($fields));
+
+        $this->response = $this->getXmlRpcClient('object')->send($msg);
+
+        // If there was an error, then an integer will be returned.
+
+        if (! $this->response->value() instanceof Value) {
+            return $this->response->value();
+        }
+
+        return $this->valueToNative($this->response->value());
+    }
+
+    /**
+     * Update a resource.
+     *
+     * @return bool true if the update was successful.
+     */
+    public function write(string $modelName, int $resourceId, array $fields)
+    {
+        $msg = $this->getBaseObjectRequest($modelName, 'write');
+
+        $msg->addParam($this->nativeToValue([$resourceId]));
+        $msg->addParam($this->nativeToValue($fields));
+
+        $this->response = $this->getXmlRpcClient('object')->send($msg);
+
+        // If there was an error, then an integer will be returned.
+
+        if (! $this->response->value() instanceof Value) {
+            return $this->response->value();
+        }
+
+        return $this->valueToNative($this->response->value());
     }
 
     //
-    // TODO: actions to implement = create write unlink
+    // TODO: actions to implement = unlink
     // Also: fields_get, version
     //
 
@@ -676,4 +726,15 @@ public function valueToNative(Value $value)
 
         return $result;
     }
+
+    /**
+     * The last response, in case it needs to be inspected for
+     * error reasons.
+     *
+     * @return Response|null
+     */
+    public function getLastResponse()
+    {
+        return $this->response;
+    }
 }