Support fetching multiple resourceIds at once.

Still needs some work to cope with multiple different
modules in an array of external IDs being searched for at once.

Author: judgej

README.md

@@ -90,13 +90,14 @@ The following methods are supported and will return an XML-RPC response:
 * searchRead()
 * read()
 
-The following helper functions return a native PHp type insead:
+The following helper functions return a native PHP type insead:
 
 * searchArray - array
 * searchReadArray - array
 * readArray - array
 * searchCount - integer
 * getResourceId - integer
+* getResourceId2 - array
 
 (I'm torn between this approach and a more fluent approach such as
 `$client->firstOnly()->asArray()->read(...)`)

src/OdooClient.php

@@ -474,47 +474,96 @@ public function version()
      */
     public function getResourceId(string $externalId, string $model = null)
     {
+        $resourceIds = $this->getResourceIds([$externalId], $model);
+
+        return collect($resourceIds)->first();
+    }
+
+    /**
+     * Get multiple resource IDs at once.
+     *
+     * @param array $externalIds each either "name" or "module.name"
+     * @param string $module optional, but recommended
+     * @return int|null
+     *
+     * FIXME: all external IDs must have the same "module" at the moment.
+     */
+    public function getResourceIds(
+        array $externalIds,
+        string $model = null,
+        $offset = 0,
+        $limit = self::DEFAULT_LIMIT,
+        $order = ''
+    ) {
         $criteria = [];
 
         if ($model !== null) {
             $criteria[] = ['model', '=', 'res.partner'];
         }
 
-        if (strpos($externalId, '.') !== false) {
-            list ($module, $name) = explode('.', $externalId, 2);
+        $moduleList = [];
 
-            $criteria[] = ['module', '=', $module];
-        } else {
-            $name = $externalId;
+        foreach($externalIds as $externalId) {
+            if (strpos($externalId, '.') !== false) {
+                list ($module, $name) = explode('.', $externalId, 2);
+            } else {
+                $name = $externalId;
+                $module = '{none}';
+            }
+
+            if (! array_key_exists($module, $moduleList)) {
+                $moduleList[$module] = [];
+            }
+
+            $moduleList[$module][] = $name;
         }
 
-        $criteria[] = ['name', '=', $name];
+        // TODO: work out how to represent the boolean OR operator
+        // for multiple modules fetched at once.
+        // Each set of conditions in this loop should be ORed with
+        // every other set of conditions in this loop.
+        // So we should be able to search for "foo.bar_123" and "fing.bing_456"
+        // in one query, giving us conceptually:
+        // ((module = foo and name = bar_123) or (module = fing and name = bing_456))
+
+        foreach($moduleList as $module => $externalIds) {
+            if ($module !== '{none}') {
+                $criteria[] = ['module', '=', $module];
+            }
+
+            $criteria[] = ['name', 'in', $externalIds];
+        }
 
-        $irModelDataIds = $this->searchArray('ir.model.data', $criteria);
-        $irModelDataId = collect($irModelDataIds)->first();
+        $irModelDataIds = $this->searchArray(
+            'ir.model.data',
+            $criteria,
+            $offset,
+            $limit,
+            $order
+        );
 
-        if ($irModelDataId === null) {
+        if (empty($irModelDataIds)) {
             // No matches found, so give up now.
             return;
         }
 
-        // Now read the full record to get the resource ID.
+        // Now read the full records to get the resource IDs.
 
         $irModelDataArray = $this->readArray(
             'ir.model.data',
-            [$irModelDataId]
+            $irModelDataIds
         );
-        $irModelData = collect($irModelDataArray)->first();
+        $irModelData = collect($irModelDataArray);
 
         if ($irModelData === null) {
             // We could not find the record.
             // (We really should have, since we just looked it up)
             return;
         }
 
-        // Return the resource ID.
+        // Return the resource IDs.
 
-        return $irModelData['res_id'];
+        return $irModelData->pluck('res_id')->toArray();
     }
 
     /**