Select specific fields in result (#30)

* Add setFields method to ApiClient

* Support fields in query params and refactor query params getter

* Add `select` method in Airtable class

* Update `get` method to support array of fields

* code style

* Fix code style

* code style

Co-authored-by: Yassine Bourakba <[email protected]>

Author: yassinebourakba

src/Airtable.php

@@ -36,8 +36,12 @@ public function destroy(string $id)
         return $this->api->delete($id);
     }
 
-    public function get()
+    public function get(array $fields = [])
     {
+        if ($fields) {
+            $this->select($fields);
+        }
+
         return $this->toCollection($this->api->get());
     }
 
@@ -109,6 +113,13 @@ public function updateOrCreate(array $idData, array $updateData = [])
         return $this->create($data);
     }
 
+    public function select(array $fields = [])
+    {
+        $this->api->setFields($fields);
+
+        return $this;
+    }
+
     private function toCollection($object)
     {
         return isset($object['records']) ? collect($object['records']) : $object;

src/Api/AirtableApiClient.php

@@ -14,6 +14,7 @@ class AirtableApiClient implements ApiClient
     private $table;
 
     private $filters = [];
+    private $fields = [];
     private $pageSize = 100;
     private $maxRecords = 100;
 
@@ -170,6 +171,13 @@ public function decodeResponse($response)
         return json_decode($body, true);
     }
 
+    public function setFields(?array $fields)
+    {
+        $this->fields = $fields;
+
+        return $this;
+    }
+
     protected function getEndpointUrl(?string $id = null): string
     {
         if ($id) {
@@ -189,12 +197,25 @@ protected function getEndpointUrl(?string $id = null): string
             $this->table,
         ], $url);
 
-        if ($this->filters) {
-            $url .= '?'.http_build_query([
-                'filterByFormula' => 'AND('.implode(',', $this->filters).')',
-            ]);
+        if ($query_params = $this->getQueryParams()) {
+            $url .= '?'.http_build_query($query_params);
         }
 
         return $url;
     }
+
+    protected function getQueryParams(): array
+    {
+        $query_params = [];
+
+        if ($this->filters) {
+            $query_params['filterByFormula'] = 'AND('.implode(',', $this->filters).')';
+        }
+
+        if ($this->fields) {
+            $query_params['fields'] = $this->fields;
+        }
+
+        return $query_params;
+    }
 }