From 9b1e0fe523e5b03ad229e5239ef5ec4e1eed19a9 Mon Sep 17 00:00:00 2001
From: Benjamin Blake <ben@sitelease.ca>
Date: Tue, 25 Feb 2020 12:09:21 -0700
Subject: [PATCH] Created an interface and abstract class for models

+ Created an interface and abstract class for models to extend
---
 src/Model/Abstracts/AbstractApiModel.php   | 102 +++++++++++++++++++++
 src/Model/Interfaces/ApiModelInterface.php |  77 ++++++++++++++++
 2 files changed, 179 insertions(+)
 create mode 100644 src/Model/Abstracts/AbstractApiModel.php
 create mode 100644 src/Model/Interfaces/ApiModelInterface.php

diff --git a/src/Model/Abstracts/AbstractApiModel.php b/src/Model/Abstracts/AbstractApiModel.php
new file mode 100644
index 0000000..e06f840
--- /dev/null
+++ b/src/Model/Abstracts/AbstractApiModel.php
@@ -0,0 +1,102 @@
+<?php
+
+namespace Gitea\Model\Abstracts;
+
+use Gitea\Client;
+use Gitea\Api\Interfaces\ApiRequesterInterface;
+
+use \stdClass;
+
+use Gitea\Model\Interfaces\ApiModelInterface;
+use \JsonSerializable;
+
+abstract class AbstractApiModel implements ApiModelInterface, JsonSerializable
+{
+    /**
+     * The Gitea client that originally made the
+     * Api request for this object
+     *
+     * @var Client
+     */
+    protected $giteaClient;
+
+    /**
+     * The Api request object that created
+     * this model object
+     *
+     * @var ApiRequesterInterface
+     */
+    protected $apiRequester;
+
+    /**
+     * Create a new API model object from a JSON map object
+     *
+     * Example:
+     * ```
+     * ClassName::fromJson(
+     *     $giteaClient,
+     *     $apiRequester,
+     *     json_decode($jsonString)
+     * );
+     * ```
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @param object $giteaClient The Gitea client that originally made the request for this object's data
+     * @param object $apiRequester The Api requester that created this object
+     * @param object $map A JSON data object
+     */
+    static function fromJson(object $giteaClient, object $apiRequester, object $map) {
+        trigger_error("The abstract 'fromJson()' method must be overwritten");
+        return false;
+    }
+
+    /**
+     * Convert this Api model object to a JSON map.
+     *
+     * NOTE: This method is required for classes that
+     * implement the JsonSerializable interface
+     *
+     * @return stdClass The map in JSON format corresponding to this object.
+     */
+    public function jsonSerialize(): \stdClass {
+        trigger_error("The abstract 'jsonSerialize()' method must be overwritten");
+        return self;
+    }
+
+    /**
+     * Get the Gitea client that originally made the
+     * Api request for this object
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @return Client
+     */
+    public function getGiteaClient() {
+        return $this->giteaClient;
+    }
+
+    public function setGiteaClient($object): self {
+        $this->giteaClient = $object;
+        return $this;
+    }
+
+    /**
+     * Get the Api request object that created
+     * this model object
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @return ApiRequesterInterface
+     */
+    public function getApiRequester() {
+        return $this->apiRequester;
+    }
+
+    public function setApiRequester($object): self {
+        $this->apiRequester = $object;
+        return $this;
+    }
+
+
+}
diff --git a/src/Model/Interfaces/ApiModelInterface.php b/src/Model/Interfaces/ApiModelInterface.php
new file mode 100644
index 0000000..e19fc0d
--- /dev/null
+++ b/src/Model/Interfaces/ApiModelInterface.php
@@ -0,0 +1,77 @@
+<?php
+
+namespace Gitea\Model\Interfaces;
+
+use Gitea\Client;
+use Gitea\Api\Interfaces\ApiRequesterInterface;
+
+use \stdClass;
+
+interface ApiModelInterface
+{
+
+    /**
+     * Creates a new API model object
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @param object $giteaClient The Gitea client that originally made the request for this object's data
+     * @param object $apiRequester The Api requester that created this object
+     * @param mixed $args The organization visibility.
+     */
+    public function __construct(object $giteaClient, object $apiRequester, ...$args);
+
+    /**
+     * Create a new API model object from a JSON map object
+     *
+     * Example:
+     * ```
+     * ClassName::fromJson(
+     *     $giteaClient,
+     *     $apiRequester,
+     *     json_decode($jsonString)
+     * );
+     * ```
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @param object $giteaClient The Gitea client that originally made the request for this object's data
+     * @param object $apiRequester The Api requester that created this object
+     * @param object $map A JSON data object
+     */
+    static function fromJson(object $giteaClient, object $apiRequester, object $map);
+
+    /**
+     * Convert this Api model object to a JSON map.
+     *
+     * NOTE: This method is required for classes that
+     * implement the JsonSerializable interface
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @return stdClass The map in JSON format corresponding to this object.
+     */
+    public function jsonSerialize(): \stdClass;
+
+    /**
+     * Get the Gitea client that originally made the
+     * Api request for this object
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @return Client
+     */
+    public function getGiteaClient();
+
+    /**
+     * Get the Api request object that created
+     * this model object
+     *
+     * @author Benjamin Blake (sitelease.ca)
+     *
+     * @return ApiRequesterInterface
+     */
+    public function getApiRequester();
+
+
+}