Generalise query options

Author: Josh Freeman

README.md

@@ -27,44 +27,17 @@ You can set the environment variable: `XIVAPI_KEY` Or via:
 $api->environment->key('my_api_key');
 ```
 
-**Using global queries**
+**Using Queries (excludes Search)**
 
-The following global queries are supported:
+The API has a whole host of queries to allow you to customise the response, these are all passed to the API before you request data. Search has some extra queries that are hard coded as these interact with Elastic Search.
 
-#### `columns`
-
-```php
-$columns = [
-    'ID',
-    'Name',
-    'Icon
-];
-
-$api->columns($columns)->content->Item()->list();
-```
-
-#### `language`
-
-```php
-$api->language('en')->content->Item()->list();
-```
-
-#### `snake_case`
-
-```php
-$api->snakeCase()->content->Item()->list();
-```
-
-#### `tags`
-
-```php
-$tags = [
-    'one',
-    'two',
-    'three'
-];
-$api->tags($tags)->content->Item()->list();
-```
+- `limit=250` - https://xivapi.com/docs/Content#limit
+- `ids=1,4,8,20` - https://xivapi.com/docs/Content#ids
+- `minify=1` - https://xivapi.com/docs/Content#minify
+- `language=en` - https://xivapi.com/docs/Welcome#language
+- `snake_case` - https://xivapi.com/docs/Welcome#snake_case
+- `columns` - https://xivapi.com/docs/Welcome#columns
+- `tags` - https://xivapi.com/docs/Welcome#tags
 
 ### Content
 

cli

@@ -12,12 +12,15 @@ $api = new \XIVAPI\XIVAPI();
 // set env key
 $api->environment->key('my_api_key');
 
-$columns = [
-    'ID',
-    'Name'
+$queries = [
+    'limit' => 500,
+    'columns' => [
+        'ID',
+        'Name'
+    ]
 ];
 
 // do commands
-$results = $api->columns($columns)->content->Item()->list();
+$results = $api->queries($queries)->content->Item()->list();
 
 print_r($results);

src/XIVAPI/Api/Content.php

@@ -459,7 +459,7 @@ public function __call($name, $args): ContentHandler
         return (new ContentHandler())->setContentName($name);
     }
 
-    public function list(): array
+    public function list($options = []): array
     {
         return Guzzle::get('/content');
     }

src/XIVAPI/Guzzle/Guzzle.php

@@ -3,7 +3,6 @@
 namespace XIVAPI\Guzzle;
 
 use GuzzleHttp\Client;
-use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\RequestOptions;
 use XIVAPI\Common\Environment;
 
@@ -14,31 +13,17 @@ class Guzzle
     const TIMEOUT = 10.0;
     const VERIFY = false;
 
-    private static $columns = [];
-    private static $language = null;
-    private static $snakeCase = false;
-    private static $tags = [];
+    private static $options = [];
 
     public static function query($method, $apiEndpoint, $options = [])
     {
         if ($key = getenv(Environment::XIVAPI_KEY)) {
             $options[RequestOptions::QUERY]['key'] = $key;
         }
 
-        if (self::$columns) {
-            $options[RequestOptions::QUERY]['columns'] = implode(',', self::$columns);
-        }
-
-        if (self::$language) {
-            $options[RequestOptions::QUERY]['language'] = self::$language;
-        }
-
-        if (self::$snakeCase) {
-            $options[RequestOptions::QUERY]['snake_case'] = 1;
-        }
-
-        if (self::$tags) {
-            $options[RequestOptions::QUERY]['tags'] = implode(',', self::$tags);
+        foreach (self::$options as $query => $value) {
+            $value = is_array($value) ? implode(',', $value) : $value;
+            $options[RequestOptions::QUERY][$query] = $value;
         }
 
         $client = new Client([
@@ -47,34 +32,14 @@ public static function query($method, $apiEndpoint, $options = [])
             'verify'    => self::VERIFY,
         ]);
 
-        try {
-            return \GuzzleHttp\json_decode(
-                $client->request($method, $apiEndpoint, $options)->getBody()
-            );
-        } catch (ClientException $ex) {
-            // todo - handle exception
-            $response = $ex->getResponse();
-        }
-    }
-
-    public static function setColumns($columns)
-    {
-        self::$columns = $columns;
-    }
-
-    public static function setLanguage($language)
-    {
-        self::$language = $language;
-    }
-
-    public static function setSnakeCase()
-    {
-        self::$snakeCase = true;
+        return \GuzzleHttp\json_decode(
+            $client->request($method, $apiEndpoint, $options)->getBody()
+        );
     }
 
-    public static function setTags($tags)
+    public static function setQuery(string $query, $value)
     {
-        self::$tags = $tags;
+        self::$options[$query] = $value;
     }
 
     public static function get($apiEndpoint, $options = [])

src/XIVAPI/XIVAPI.php

@@ -51,27 +51,12 @@ public function __construct()
         $this->patchlist    = new PatchList();
     }
 
-    public function columns($columns): XIVAPI
+    public function queries($queries): XIVAPI
     {
-        Guzzle::setColumns($columns);
-        return $this;
-    }
-
-    public function language($language): XIVAPI
-    {
-        Guzzle::setLanguage($language);
-        return $this;
-    }
+        foreach ($queries as $query => $value) {
+            Guzzle::setQuery($query, $value);
+        }
 
-    public function snakeCase(): XIVAPI
-    {
-        Guzzle::setSnakeCase();
-        return $this;
-    }
-
-    public function tags($tags): XIVAPI
-    {
-        Guzzle::setTags($tags);
         return $this;
     }
 }