Flesh out rest of xivapi-php library logic

Josh Freeman · Josh Freeman · commit 8366e2d156a1 · 2018-11-29T15:56:19.000Z
diff --git a/README.md b/README.md
@@ -11,3 +11,137 @@ Install vis composer:
 - `composer require xivapi/xivapi-php`
 
 ## Usage
+
+The `xivapi-php` library is a very simple wrapper around Guzzle.
+
+**Initialize**
+```php
+$api = new \XIVAPI\XIVAPI();
+```
+
+**Setting your key if you have one**
+
+You can set the environment variable: `XIVAPI_KEY` Or via:
+
+```php
+$api->environment->key('my_api_key');
+```
+
+**Using global queries**
+
+The following global queries are supported:
+
+- `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();
+```
+
+### Content
+
+Content is dynamically driven based on what content is available in the game files, thus it has a method method for invoking the different types, eg:
+
+- `item()`
+- `instanceContent()`
+- `tripleTriadCard()`
+
+```php
+$api->content->[contentName]()->list();
+$api->content->[contentName]()->one($id);
+
+$api->content->list();
+$api->content->servers();
+$api->content->serversByDataCenter();
+```
+
+### Search
+
+```php
+$api->search->find($string)->results();
+```
+
+The following search modify methods are available:
+```php
+$api->search->column($column);
+$api->search->algorithm($searchStringAlgorithm);
+$api->search->page($number);
+$api->search->sort($field, $order);
+$api->search->limit($limit);
+$api->search->columns($columns);
+$api->search->bool($bool);
+```
+
+Filters are additive, multiple can be added, eg:
+
+```php
+$api->search
+    ->filter('LevelItem', 30, SearchFilters::GREATER_THAN)
+    ->filter('ItemSearchCategory', 10, SearchFilters::GREATER_THAN_OR_EQUAL_TO);
+```
+
+
+### Character
+
+```php
+$api->character->search($name, $server, $page);
+$api->character->get($id, $data = [], $extended = false);
+$api->character->verify($id);
+$api->character->update($id);
+$api->character->delete($id);
+```
+
+### Free Company
+
+```php
+$api->freecompany->search($name, $server, $page);
+$api->freecompany->get($id, $data = []);
+$api->freecompany->update($id);
+$api->freecompany->delete($id);
+```
+
+### Linkshell
+
+```php
+$api->linkshell->search($name, $server, $page);
+$api->linkshell->get($id, $data = []);
+$api->linkshell->update($id);
+$api->linkshell->delete($id);
+```
+
+### PvPTeam
+
+```php
+$api->pvpteam->search($name, $server, $page);
+$api->pvpteam->get($id, $data = []);
+$api->pvpteam->update($id);
+$api->pvpteam->delete($id);
+```
diff --git a/src/XIVAPI/Api/Character.php b/src/XIVAPI/Api/Character.php
@@ -0,0 +1,52 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use GuzzleHttp\RequestOptions;
+use XIVAPI\Guzzle\Guzzle;
+
+class Character
+{
+    public function search(string $name, string $server, int $page = 1)
+    {
+        return Guzzle::get("/freecompany/search", [
+            RequestOptions::QUERY => [
+                'name'   => $name,
+                'server' => ucwords($server),
+                'page'   => $page,
+            ]
+        ]);
+    }
+
+    public function get(int $id, array $data = [], bool $extended = false)
+    {
+        $options = [
+            RequestOptions::QUERY
+        ];
+
+        if ($data) {
+            $options[RequestOptions::QUERY]['data'] = implode(",", $data);
+        }
+
+        if ($extended) {
+            $options[RequestOptions::QUERY]['extended'] = 1;
+        }
+
+        return Guzzle::get("/character/{$id}", $options);
+    }
+
+    public function verify(int $id)
+    {
+        return Guzzle::get("/character/{$id}/verification");
+    }
+
+    public function update(int $id)
+    {
+        return Guzzle::get("/character/{$id}/update");
+    }
+
+    public function delete(int $id)
+    {
+        return Guzzle::get("/character/{$id}/delete");
+    }
+}
diff --git a/src/XIVAPI/Api/FreeCompany.php b/src/XIVAPI/Api/FreeCompany.php
@@ -0,0 +1,43 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use GuzzleHttp\RequestOptions;
+use XIVAPI\Guzzle\Guzzle;
+
+class FreeCompany
+{
+    public function search(string $name, string $server, int $page = 1)
+    {
+        return Guzzle::get("/freecompany/search", [
+            RequestOptions::QUERY => [
+                'name'   => $name,
+                'server' => ucwords($server),
+                'page'   => $page,
+            ]
+        ]);
+    }
+
+    public function get(int $id, array $data = [])
+    {
+        $options = [
+            RequestOptions::QUERY
+        ];
+
+        if ($data) {
+            $options[RequestOptions::QUERY]['data'] = implode(",", $data);
+        }
+
+        return Guzzle::get("/freecompany/{$id}", $options);
+    }
+
+    public function update(int $id)
+    {
+        return Guzzle::get("/freecompany/{$id}/update");
+    }
+
+    public function delete(int $id)
+    {
+        return Guzzle::get("/freecompany/{$id}/delete");
+    }
+}
diff --git a/src/XIVAPI/Api/Linkshell.php b/src/XIVAPI/Api/Linkshell.php
@@ -0,0 +1,43 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use GuzzleHttp\RequestOptions;
+use XIVAPI\Guzzle\Guzzle;
+
+class Linkshell
+{
+    public function search(string $name, string $server, int $page = 1)
+    {
+        return Guzzle::get("/linkshell/search", [
+            RequestOptions::QUERY => [
+                'name'   => $name,
+                'server' => ucwords($server),
+                'page'   => $page,
+            ]
+        ]);
+    }
+
+    public function get(int $id, array $data = [])
+    {
+        $options = [
+            RequestOptions::QUERY
+        ];
+
+        if ($data) {
+            $options[RequestOptions::QUERY]['data'] = implode(",", $data);
+        }
+
+        return Guzzle::get("/linkshell/{$id}", $options);
+    }
+
+    public function update(int $id)
+    {
+        return Guzzle::get("/linkshell/{$id}/update");
+    }
+
+    public function delete(int $id)
+    {
+        return Guzzle::get("/linkshell/{$id}/delete");
+    }
+}
diff --git a/src/XIVAPI/Api/Lodestone.php b/src/XIVAPI/Api/Lodestone.php
@@ -0,0 +1,64 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use XIVAPI\Guzzle\Guzzle;
+
+class Lodestone
+{
+    public function all()
+    {
+        return Guzzle::get("/lodestone");
+    }
+
+    public function news()
+    {
+        return Guzzle::get("/lodestone/news");
+    }
+
+    public function notices()
+    {
+        return Guzzle::get("/lodestone/notices");
+    }
+
+    public function maintenance()
+    {
+        return Guzzle::get("/lodestone/maintenance");
+    }
+
+    public function updates()
+    {
+        return Guzzle::get("/lodestone/updates");
+    }
+
+    public function status()
+    {
+        return Guzzle::get("/lodestone/status");
+    }
+
+    public function worldstatus()
+    {
+        return Guzzle::get("/lodestone/worldstatus");
+    }
+
+    public function devblogs()
+    {
+        return Guzzle::get("/lodestone/devblogs");
+    }
+
+    public function devposts()
+    {
+        return Guzzle::get("/lodestone/devposts");
+    }
+
+    public function feasts(int $season = 4)
+    {
+        return Guzzle::get("/lodestone/feasts");
+    }
+
+    public function deepdungeon()
+    {
+        return Guzzle::get("/lodestone/news");
+    }
+
+}
diff --git a/src/XIVAPI/Api/Market.php b/src/XIVAPI/Api/Market.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use GuzzleHttp\RequestOptions;
+use XIVAPI\Guzzle\Guzzle;
+
+class Market
+{
+    public function price(string $server, int $itemId)
+    {
+        return Guzzle::get("/market/{$server}/items/{$itemId}");
+    }
+
+    public function history(string $server, int $itemId)
+    {
+        return Guzzle::get("/market/{$server}/items/{$itemId}/history");
+    }
+
+    public function stock(string $server, int $categoryId)
+    {
+        return Guzzle::get("/market/{$server}/category/{$categoryId}");
+    }
+
+    public function categories()
+    {
+        return Guzzle::get("/market/categories");
+    }
+
+    public function tokens($password)
+    {
+        return Guzzle::get("/market/categories", [
+            RequestOptions::QUERY => [
+                'password' => $password
+            ]
+        ]);
+    }
+}
diff --git a/src/XIVAPI/Api/PatchList.php b/src/XIVAPI/Api/PatchList.php
@@ -0,0 +1,13 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use XIVAPI\Guzzle\Guzzle;
+
+class PatchList
+{
+    public function list()
+    {
+        return Guzzle::get("/patchlist");
+    }
+}
diff --git a/src/XIVAPI/Api/PvPTeam.php b/src/XIVAPI/Api/PvPTeam.php
diff --git a/src/XIVAPI/Api/Search.php b/src/XIVAPI/Api/Search.php
diff --git a/src/XIVAPI/XIVAPI.php b/src/XIVAPI/XIVAPI.php
