From 89bf90f595fc40c0413793f8aede330e2057317d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Samuel=20=C5=A0tancl?= <samuel.stancl@gmail.com>
Date: Thu, 5 Sep 2019 19:25:32 +0200
Subject: [PATCH] Interfaces -> Contracts

---
 src/Contracts/StorageDriver.php             | 29 +++++++++++++++++++++
 src/Contracts/TenancyBootstrapper.php       | 11 ++++++++
 src/Contracts/TenantDatabaseManager.php     | 24 +++++++++++++++++
 src/Contracts/UniqueIdentifierGenerator.php | 17 ++++++++++++
 4 files changed, 81 insertions(+)
 create mode 100644 src/Contracts/StorageDriver.php
 create mode 100644 src/Contracts/TenancyBootstrapper.php
 create mode 100644 src/Contracts/TenantDatabaseManager.php
 create mode 100644 src/Contracts/UniqueIdentifierGenerator.php

diff --git a/src/Contracts/StorageDriver.php b/src/Contracts/StorageDriver.php
new file mode 100644
index 00000000..ec21b18a
--- /dev/null
+++ b/src/Contracts/StorageDriver.php
@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Contracts;
+
+interface StorageDriver
+{
+    public function identifyTenant(string $domain): array;
+
+    /** @return array[] */
+    public function getAllTenants(array $uuids = []): array;
+
+    public function getTenantById(string $uuid, array $fields = []): array;
+
+    public function getTenantIdByDomain(string $domain): ?string;
+
+    public function createTenant(string $domain, string $uuid): array;
+
+    public function deleteTenant(string $uuid): bool;
+
+    public function get(string $uuid, string $key);
+
+    public function getMany(string $uuid, array $keys): array;
+
+    public function put(string $uuid, string $key, $value);
+
+    public function putMany(string $uuid, array $values): array;
+}
diff --git a/src/Contracts/TenancyBootstrapper.php b/src/Contracts/TenancyBootstrapper.php
new file mode 100644
index 00000000..7fbb22a6
--- /dev/null
+++ b/src/Contracts/TenancyBootstrapper.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Stancl\Tenancy\Contracts;
+
+use Stancl\Tenancy\Tenant;
+
+interface TenancyBootstrapper
+{
+    public function start(Tenant $tenant); // todo better name?
+    public function end(Tenant $tenant); // todo arg?
+}
\ No newline at end of file
diff --git a/src/Contracts/TenantDatabaseManager.php b/src/Contracts/TenantDatabaseManager.php
new file mode 100644
index 00000000..8439894d
--- /dev/null
+++ b/src/Contracts/TenantDatabaseManager.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Contracts;
+
+interface TenantDatabaseManager
+{
+    /**
+     * Create a database.
+     *
+     * @param  string $name Name of the database.
+     * @return bool
+     */
+    public function createDatabase(string $name): bool;
+
+    /**
+     * Delete a database.
+     *
+     * @param  string $name Name of the database.
+     * @return bool
+     */
+    public function deleteDatabase(string $name): bool;
+}
diff --git a/src/Contracts/UniqueIdentifierGenerator.php b/src/Contracts/UniqueIdentifierGenerator.php
new file mode 100644
index 00000000..5b4a17ae
--- /dev/null
+++ b/src/Contracts/UniqueIdentifierGenerator.php
@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Contracts;
+
+interface UniqueIdentifierGenerator
+{
+    /**
+     * Generate a unique identifier.
+     *
+     * @param string $domain
+     * @param array $data
+     * @return string
+     */
+    public static function handle(string $domain, array $data = []): string;
+}