Merge pull request #1 from Fortnite-API/creator-codes

michel-pi · web-flow · commit 8dade175b4c8 · 2019-12-03T05:47:21.000+01:00
Adds the creatorcodes endpoint
diff --git a/README.md b/README.md
@@ -47,6 +47,9 @@ $api->news->...
 
 // accesses the shop endpoint (https://fortnite-api.com/shop)
 $api->shop->...
+
+// accesses the creatorcode endpoint (https://fortnite-api.com/creatorcode)
+$api->creatorCode->...
 ```
 
 ```php
diff --git a/src/Components/Endpoints/CreatorCodeEndpoint.php b/src/Components/Endpoints/CreatorCodeEndpoint.php
@@ -0,0 +1,152 @@
+<?php
+
+namespace FortniteApi\Components\Endpoints;
+
+use FortniteApi\Components\HttpClient;
+use FortniteApi\Components\Tasks\CreatorCodeArrayTask;
+use FortniteApi\Components\Tasks\CreatorCodeTask;
+use FortniteApi\FortniteApiError;
+
+/**
+ * Provides access to the /creatorcode endpoint.
+ */
+class CreatorCodeEndpoint
+{
+    /**
+     * Returns the creator code data for a given slug.
+     *
+     * @param string|array|mixed $slug
+     * @return null|CreatorCode
+     */
+    public function get($slug)
+    {
+        $promise = $this->getAsync($slug);
+
+        if ($promise == null) {
+            return null;
+        } else {
+            return $promise->await();
+        }
+    }
+
+    /**
+     * Returns the creator code data for a given slug.
+     *
+     * @param string|array|mixed $slug
+     * @return null|CreatorCodeTask
+     */
+    public function getAsync($slug)
+    {
+        FortniteApiError::clearLastError();
+
+        if (empty($slug)) {
+            FortniteApiError::setLastError("Missing paramter 'slug'.");
+
+            return null;
+        }
+
+        $path = "/creatorcode";
+
+        $query = [
+            "slug" => $slug
+        ];
+
+        $promise = HttpClient::getInstance()->getAsync($path, [
+            "query" => $query
+        ]);
+
+        return new CreatorCodeTask($promise);
+    }
+
+    /**
+     * Returns the first creator code matching the given slug.
+     *
+     * @param string|array|mixed $slug
+     * @return null|CreatorCode
+     */
+    public function search($slug)
+    {
+        $promise = $this->searchAsync($slug);
+
+        if ($promise == null) {
+            return null;
+        } else {
+            return $promise->await();
+        }
+    }
+
+    /**
+     * Returns the first creator code matching the given slug.
+     *
+     * @param string|array|mixed $slug
+     * @return null|CreatorCodeTask
+     */
+    public function searchAsync($slug)
+    {
+        FortniteApiError::clearLastError();
+
+        if (empty($slug)) {
+            FortniteApiError::setLastError("Missing paramter 'slug'.");
+
+            return null;
+        }
+
+        $path = "/creatorcode/search";
+
+        $query = [
+            "slug" => $slug
+        ];
+
+        $promise = HttpClient::getInstance()->getAsync($path, [
+            "query" => $query
+        ]);
+
+        return new CreatorCodeTask($promise);
+    }
+
+    /**
+     * Returns the all creator codes matching the given slug.
+     *
+     * @param string|array|mixed $slug
+     * @return null|CreatorCode[]|array|mixed
+     */
+    public function searchAll($slug)
+    {
+        $promise = $this->searchAllAsync($slug);
+
+        if ($promise == null) {
+            return null;
+        } else {
+            return $promise->await();
+        }
+    }
+
+    /**
+     * Returns the all creator codes matching the given slug.
+     *
+     * @param string|array|mixed $slug
+     * @return null|CreatorCodeArrayTask
+     */
+    public function searchAllAsync($slug)
+    {
+        FortniteApiError::clearLastError();
+
+        if (empty($slug)) {
+            FortniteApiError::setLastError("Missing paramter 'slug'.");
+
+            return null;
+        }
+
+        $path = "/creatorcode/search/all";
+
+        $query = [
+            "slug" => $slug
+        ];
+
+        $promise = HttpClient::getInstance()->getAsync($path, [
+            "query" => $query
+        ]);
+
+        return new CreatorCodeArrayTask($promise);
+    }
+}
diff --git a/src/Components/Objects/CreatorCode.php b/src/Components/Objects/CreatorCode.php
@@ -0,0 +1,100 @@
+<?php
+
+namespace FortniteApi\Components\Objects;
+
+use Exception;
+use FortniteApi\Components\Objects\Reflection\Activator;
+
+class CreatorCode
+{
+    /**
+     * Undocumented variable
+     *
+     * @var Activator
+     */
+    private static $_activator;
+
+    /**
+     * Undocumented variable
+     *
+     * @var string
+     */
+    public $id;
+    /**
+     * Undocumented variable
+     *
+     * @var string
+     */
+    public $slug;
+    
+    /**
+     * Undocumented variable
+     *
+     * @var string
+     */
+    public $displayName;
+
+    /**
+     * Undocumented variable
+     *
+     * @var null|string
+     */
+    public $status;
+
+    /**
+     * Undocumented variable
+     *
+     * @var bool
+     */
+    public $verified;
+
+    public static function createObject($body)
+    {
+        return self::getActivator()->createObjectFromBody($body);
+    }
+
+    public static function createObjectArray($body)
+    {
+        return self::getActivator()->createArrayFromBody($body);
+    }
+
+    /**
+     * Undocumented function
+     *
+     * @param CreatorCode $obj
+     * @param array|mixed $body
+     * @return bool
+     */
+    private static function initializeObject(&$obj, &$body)
+    {
+        try {
+            $obj->id = $body["id"];
+            $obj->slug = $body["slug"];
+            $obj->displayName = $body["displayName"];
+            $obj->status = $body["status"];
+            $obj->verified = $body["verified"];
+            
+            return true;
+        } catch (Exception $ex) {
+            return false;
+        }
+    }
+
+    /**
+     * Undocumented function
+     *
+     * @return Activator
+     */
+    private static function getActivator()
+    {
+        if (empty(self::$_activator)) {
+            self::$_activator = new Activator(function () {
+                return new CreatorCode();
+            }, function (&$obj, &$body) {
+                return self::initializeObject($obj, $body);
+            });
+        }
+
+        return self::$_activator;
+    }
+}
diff --git a/src/Components/Tasks/CreatorCodeArrayTask.php b/src/Components/Tasks/CreatorCodeArrayTask.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace FortniteApi\Components\Tasks;
+
+use Exception;
+use FortniteApi\Components\HttpClient;
+use FortniteApi\Components\Objects\CreatorCode;
+use FortniteApi\FortniteApiError;
+use Psr\Http\Message\ResponseInterface as Response;
+
+class CreatorCodeArrayTask extends Awaitable
+{
+    /**
+     * Awaits the response and returns the parsed body.
+     *
+     * @return null|CreatorCode[]|array
+     */
+    public function await()
+    {
+        FortniteApiError::clearLastError();
+
+        try {
+            /** @var Response $response */
+            $response = parent::await();
+
+            if (empty($response)) {
+                return null;
+            }
+
+            $statusCode = $response->getStatusCode();
+
+            if (!HttpClient::isSuccess($statusCode)) {
+                FortniteApiError::setLastError("Request failed.", $response);
+
+                return null;
+            }
+            
+            $body = $response->getBody();
+
+            if (empty($body)) {
+                return CreatorCode::createObjectArray(null);
+            }
+            
+            $text = (string)$body;
+
+            return CreatorCode::createObjectArray($text);
+        } catch (Exception $ex) {
+            FortniteApiError::setLastError($ex->getMessage());
+
+            return null;
+        }
+    }
+}
diff --git a/src/Components/Tasks/CreatorCodeTask.php b/src/Components/Tasks/CreatorCodeTask.php
@@ -0,0 +1,53 @@
+<?php
+
+namespace FortniteApi\Components\Tasks;
+
+use Exception;
+use FortniteApi\Components\HttpClient;
+use FortniteApi\Components\Objects\CreatorCode;
+use FortniteApi\FortniteApiError;
+use Psr\Http\Message\ResponseInterface as Response;
+
+class CreatorCodeTask extends Awaitable
+{
+    /**
+     * Awaits the response and returns the parsed body.
+     *
+     * @return null|CreatorCode
+     */
+    public function await()
+    {
+        FortniteApiError::clearLastError();
+
+        try {
+            /** @var Response $response */
+            $response = parent::await();
+
+            if (empty($response)) {
+                return null;
+            }
+
+            $statusCode = $response->getStatusCode();
+
+            if (!HttpClient::isSuccess($statusCode)) {
+                FortniteApiError::setLastError("Request failed.", $response);
+
+                return null;
+            }
+            
+            $body = $response->getBody();
+
+            if (empty($body)) {
+                return CreatorCode::createObject(null);
+            }
+            
+            $text = (string)$body;
+
+            return CreatorCode::createObject($text);
+        } catch (Exception $ex) {
+            FortniteApiError::setLastError($ex->getMessage());
+
+            return null;
+        }
+    }
+}
diff --git a/src/FortniteApi.php b/src/FortniteApi.php
diff --git a/test/index.php b/test/index.php
