Return collections of mapped models rather than arrays; remove "array" methods.

Author: judgej

README.md

@@ -84,24 +84,26 @@ where `$type` will typically be 'db', 'common' or 'object'.
 
 # Query methods
 
-The following methods are supported and will return an XML-RPC response:
+The following methods are supported and will return a collection:
 
-* search()
-* searchRead()
-* read()
+* search() - collection of integers
+* searchRead() - collection of models
+* read() - collection of models
+* getResourceIds - collection of integers
+* fieldsGet() - collection of arrays
 
 The following helper functions return a native PHP type insead:
 
-* searchArray - array
-* searchReadArray - array
-* readArray - array
 * searchCount - integer
 * getResourceId - integer
-* getResourceIds - array
+* unlink - boolean
+* create - boolean
 
-(I'm torn between this approach and a more fluent approach such as
-`$client->firstOnly()->asArray()->read(...)` to set the context that
-will apply to the next command.)
+All `read()` and `searchRead()` methods will return a collection of models.
+The default model will be `Consilience\OdooApi\Model`, but other models can be specified.
+The `odoo-api.php` config provides an array setting to map OpenERP model names
+to model class names for instantiation. Further mappings can be added to the client
+using `$client->addMapping('odoo.model.name', \FQDN\Class\name::class)`.
 
 Note that `searchRead` will emulate the server's `search_read` for
 Odoo versions less than 8.0 (OpenERP) but use the native `search_read`
@@ -123,6 +125,10 @@ formats are used:
 This makes finding help on the API difficult, since many articles
 fail to make the OpenERP/Odoo version number clear.
 
+# Setting Relationships
+
+TODO (it's fairly simple once explained)
+
 # TODO
 
 * The write functions are not written yet (~~create~~, ~~write~~ and unlink).

config/odoo-api.php

@@ -14,6 +14,15 @@
             'database' => env('ODOO_API_DATABASE'),
             'username' => env('ODOO_API_USER'),
             'password' => env('ODOO_API_PASSWORD'),
+
+            'model_map' => [
+            ],
         ],
     ],
+
+    // Map OpenERP model names to local model classes.
+
+    'model_map' => [
+        //'account.invoice' => Foo\Bar\Invoice::class,
+    ],
 ];

src/HasModelDataTrait.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Consilience\OdooApi;
+
+/**
+ * Methods to initialise, and get data items.
+ */
+
+trait HasModelDataTrait
+{
+    /**
+     * Data structure as returned by the API and converted to
+     * a native PHP array.
+     */
+    protected $data = [];
+
+    /**
+     * Instantiate with the array data from the ERP model read.
+     */
+    public function __construct(array $data = [])
+    {
+        // Store away the source data.
+        $this->setData($data);
+    }
+
+    protected function setData($data)
+    {
+        $this->data = $data;
+    }
+
+    public function getData()
+    {
+        return $this->data;
+    }
+
+    /**
+     * Get a data field using a "dot notation" path.
+     */
+    public function get($key, $default = null)
+    {
+        // Since we are running under laravel, use laravel's helper.
+
+        return data_get($this->data, $key, $default);
+    }
+
+    public function jsonSerialize()
+    {
+        return $this->data;
+    }
+}

src/Model.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace Consilience\OdooApi;
+
+/**
+ * Default model for a module record instance.
+ */
+
+class Model implements ModelInterface
+{
+    use HasModelDataTrait;
+}

src/ModelInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Consilience\OdooApi;
+
+/**
+ *
+ */
+
+use JsonSerializable;
+
+interface ModelInterface extends JsonSerializable
+{
+    public function get($key, $default = null);
+}