Merge branch 'master' into 515-complete

src/Database/Concerns/BelongsToTenant.php

@@ -12,11 +12,14 @@ use Stancl\Tenancy\Database\TenantScope;
  */
 trait BelongsToTenant
 {
-    public static $tenantIdColumn = 'tenant_id';
-
     public function tenant()
     {
-        return $this->belongsTo(config('tenancy.tenant_model'), BelongsToTenant::$tenantIdColumn);
+        return $this->belongsTo(config('tenancy.tenant_model'), static::tenantIdColumn());
+    }
+
+    public static function tenantIdColumn(): string
+    {
+        return config('tenancy.single_db.tenant_id_column');
     }
 
     public static function bootBelongsToTenant(): void
@@ -24,9 +27,9 @@ trait BelongsToTenant
         static::addGlobalScope(new TenantScope);
 
         static::creating(function ($model) {
-            if (! $model->getAttribute(BelongsToTenant::$tenantIdColumn) && ! $model->relationLoaded('tenant')) {
+            if (! $model->getAttribute(static::tenantIdColumn()) && ! $model->relationLoaded('tenant')) {
                 if (tenancy()->initialized) {
-                    $model->setAttribute(BelongsToTenant::$tenantIdColumn, tenant()->getTenantKey());
+                    $model->setAttribute(static::tenantIdColumn(), tenant()->getTenantKey());
                     $model->setRelation('tenant', tenant());
                 }
             }

src/Database/Concerns/HasDomains.php

@@ -10,6 +10,8 @@ use Stancl\Tenancy\Contracts\Domain;
 
 /**
  * @property-read Domain[]|\Illuminate\Database\Eloquent\Collection $domains
+ * @mixin \Illuminate\Database\Eloquent\Model
+ * @mixin \Stancl\Tenancy\Contracts\Tenant
  */
 trait HasDomains
 {

src/Database/Concerns/HasScopedValidationRules.php

@@ -11,11 +11,11 @@ trait HasScopedValidationRules
 {
     public function unique($table, $column = 'NULL')
     {
-        return (new Unique($table, $column))->where(BelongsToTenant::$tenantIdColumn, $this->getTenantKey());
+        return (new Unique($table, $column))->where(BelongsToTenant::tenantIdColumn(), $this->getTenantKey());
     }
 
     public function exists($table, $column = 'NULL')
     {
-        return (new Exists($table, $column))->where(BelongsToTenant::$tenantIdColumn, $this->getTenantKey());
+        return (new Exists($table, $column))->where(BelongsToTenant::tenantIdColumn(), $this->getTenantKey());
     }
 }

src/Database/Concerns/InitializationHelpers.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Database\Concerns;
+
+/**
+ * @mixin \Stancl\Tenancy\Contracts\Tenant
+ */
+trait InitializationHelpers
+{
+    public function enter(): void
+    {
+        tenancy()->initialize($this);
+    }
+
+    public function leave(): void
+    {
+        tenancy()->end();
+    }
+}

src/Database/Concerns/InvalidatesResolverCache.php

@@ -5,21 +5,15 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Database\Concerns;
 
 use Stancl\Tenancy\Contracts\Tenant;
-use Stancl\Tenancy\Resolvers;
 use Stancl\Tenancy\Resolvers\Contracts\CachedTenantResolver;
+use Stancl\Tenancy\Tenancy;
 
 trait InvalidatesResolverCache
 {
-    public static $resolvers = [
-        Resolvers\DomainTenantResolver::class,
-        Resolvers\PathTenantResolver::class,
-        Resolvers\RequestDataTenantResolver::class,
-    ];
-
     public static function bootInvalidatesResolverCache(): void
     {
         static::saved(function (Tenant $tenant) {
-            foreach (static::$resolvers as $resolver) {
+            foreach (Tenancy::cachedResolvers() as $resolver) {
                 /** @var CachedTenantResolver $resolver */
                 $resolver = app($resolver);
 

src/Database/Concerns/InvalidatesTenantsResolverCache.php

@@ -5,24 +5,18 @@ declare(strict_types=1);
 namespace Stancl\Tenancy\Database\Concerns;
 
 use Illuminate\Database\Eloquent\Model;
-use Stancl\Tenancy\Resolvers;
 use Stancl\Tenancy\Resolvers\Contracts\CachedTenantResolver;
+use Stancl\Tenancy\Tenancy;
 
 /**
  * Meant to be used on models that belong to tenants.
  */
 trait InvalidatesTenantsResolverCache
 {
-    public static $resolvers = [
-        Resolvers\DomainTenantResolver::class,
-        Resolvers\PathTenantResolver::class,
-        Resolvers\RequestDataTenantResolver::class,
-    ];
-
     public static function bootInvalidatesTenantsResolverCache(): void
     {
         static::saved(function (Model $model) {
-            foreach (static::$resolvers as $resolver) {
+            foreach (Tenancy::cachedResolvers() as $resolver) {
                 /** @var CachedTenantResolver $resolver */
                 $resolver = app($resolver);
 

src/Database/Concerns/MaintenanceMode.php

@@ -4,17 +4,27 @@ declare(strict_types=1);
 
 namespace Stancl\Tenancy\Database\Concerns;
 
-use Carbon\Carbon;
-
+/**
+ * @mixin \Illuminate\Database\Eloquent\Model
+ */
 trait MaintenanceMode
 {
-    public function putDownForMaintenance($data = [])
+    public function putDownForMaintenance($data = []): void
     {
-        $this->update(['maintenance_mode' => [
-            'time' => $data['time'] ?? Carbon::now()->getTimestamp(),
-            'message' => $data['message'] ?? null,
-            'retry' => $data['retry'] ?? null,
-            'allowed' => $data['allowed'] ?? [],
-        ]]);
+        $this->update([
+            'maintenance_mode' => [
+                'except' => $data['except'] ?? null,
+                'redirect' => $data['redirect'] ?? null,
+                'retry' => $data['retry'] ?? null,
+                'refresh' => $data['refresh'] ?? null,
+                'secret' => $data['secret'] ?? null,
+                'status' => $data['status'] ?? 503,
+            ],
+        ]);
+    }
+
+    public function bringUpFromMaintenance(): void
+    {
+        $this->update(['maintenance_mode' => null]);
     }
 }

src/Database/Contracts/TenantWithDatabase.php

@@ -9,5 +9,15 @@ use Stancl\Tenancy\Database\DatabaseConfig;
 
 interface TenantWithDatabase extends Tenant
 {
+    /** Get the tenant's database config. */
     public function database(): DatabaseConfig;
+
+    /** Get the internal prefix. */
+    public static function internalPrefix(): string;
+
+    /** Get an internal key. */
+    public function getInternal(string $key): mixed;
+
+    /** Set internal key. */
+    public function setInternal(string $key, mixed $value): static;
 }

src/Database/DatabaseConfig.php

@@ -28,20 +28,20 @@ class DatabaseConfig
 
     public static function __constructStatic(): void
     {
-        static::$usernameGenerator = static::$usernameGenerator ?? function (Tenant $tenant) {
+        static::$usernameGenerator = static::$usernameGenerator ?? function (Model&Tenant $tenant) {
             return Str::random(16);
         };
 
-        static::$passwordGenerator = static::$passwordGenerator ?? function (Tenant $tenant) {
+        static::$passwordGenerator = static::$passwordGenerator ?? function (Model&Tenant $tenant) {
             return Hash::make(Str::random(32));
         };
 
-        static::$databaseNameGenerator = static::$databaseNameGenerator ?? function (Tenant $tenant) {
+        static::$databaseNameGenerator = static::$databaseNameGenerator ?? function (Model&Tenant $tenant) {
             return config('tenancy.database.prefix') . $tenant->getTenantKey() . config('tenancy.database.suffix');
         };
     }
 
-    public function __construct(Tenant $tenant)
+    public function __construct(Model&Tenant $tenant)
     {
         static::__constructStatic();
 
@@ -63,7 +63,7 @@ class DatabaseConfig
         static::$passwordGenerator = $passwordGenerator;
     }
 
-    public function getName(): ?string
+    public function getName(): string
     {
         return $this->tenant->getInternal('db_name') ?? (static::$databaseNameGenerator)($this->tenant);
     }
@@ -83,7 +83,7 @@ class DatabaseConfig
      */
     public function makeCredentials(): void
     {
-        $this->tenant->setInternal('db_name', $this->getName() ?? (static::$databaseNameGenerator)($this->tenant));
+        $this->tenant->setInternal('db_name', $this->getName());
 
         if ($this->manager() instanceof Contracts\ManagesDatabaseUsers) {
             $this->tenant->setInternal('db_username', $this->getUsername() ?? (static::$usernameGenerator)($this->tenant));

src/Database/DatabaseManager.php

@@ -15,25 +15,14 @@ use Stancl\Tenancy\Database\Contracts\TenantWithDatabase;
  */
 class DatabaseManager
 {
-    /** @var Application */
-    protected $app;
-
-    /** @var BaseDatabaseManager */
-    protected $database;
-
-    /** @var Repository */
-    protected $config;
-
-    public function __construct(Application $app, BaseDatabaseManager $database, Repository $config)
-    {
-        $this->app = $app;
-        $this->database = $database;
-        $this->config = $config;
+    public function __construct(
+        protected Application $app,
+        protected BaseDatabaseManager $database,
+        protected Repository $config,
+    ) {
     }
 
-    /**
-     * Connect to a tenant's database.
-     */
+    /** Connect to a tenant's database. */
     public function connectToTenant(TenantWithDatabase $tenant): void
     {
         $this->purgeTenantConnection();
@@ -41,35 +30,27 @@ class DatabaseManager
         $this->setDefaultConnection('tenant');
     }
 
-    /**
-     * Reconnect to the default non-tenant connection.
-     */
+    /** Reconnect to the default non-tenant connection. */
     public function reconnectToCentral(): void
     {
         $this->purgeTenantConnection();
         $this->setDefaultConnection($this->config->get('tenancy.database.central_connection'));
     }
 
-    /**
-     * Change the default database connection config.
-     */
+    /** Change the default database connection config. */
     public function setDefaultConnection(string $connection): void
     {
         $this->config['database.default'] = $connection;
         $this->database->setDefaultConnection($connection);
     }
 
-    /**
-     * Create the tenant database connection.
-     */
+    /** Create the tenant database connection. */
     public function createTenantConnection(TenantWithDatabase $tenant): void
     {
         $this->config['database.connections.tenant'] = $tenant->database()->connection();
     }
 
-    /**
-     * Purge the tenant database connection.
-     */
+    /** Purge the tenant database connection. */
     public function purgeTenantConnection(): void
     {
         if (array_key_exists('tenant', $this->database->getConnections())) {
@@ -83,8 +64,8 @@ class DatabaseManager
      * Check if a tenant can be created.
      *
      * @throws TenantCannotBeCreatedException
-     * @throws DatabaseManagerNotRegisteredException
-     * @throws TenantDatabaseAlreadyExistsException
+     * @throws Exceptions\DatabaseManagerNotRegisteredException
+     * @throws Exceptions\TenantDatabaseAlreadyExistsException
      */
     public function ensureTenantCanBeCreated(TenantWithDatabase $tenant): void
     {
@@ -94,8 +75,13 @@ class DatabaseManager
             throw new Exceptions\TenantDatabaseAlreadyExistsException($database);
         }
 
-        if ($manager instanceof Contracts\ManagesDatabaseUsers && $manager->userExists($username = $tenant->database()->getUsername())) {
-            throw new Exceptions\TenantDatabaseUserAlreadyExistsException($username);
+        if ($manager instanceof Contracts\ManagesDatabaseUsers) {
+            /** @var string $username */
+            $username = $tenant->database()->getUsername();
+
+            if ($manager->userExists($username)) {
+                throw new Exceptions\TenantDatabaseUserAlreadyExistsException($username);
+            }
         }
     }
 }

src/Database/Models/Tenant.php

@@ -26,6 +26,7 @@ class Tenant extends Model implements Contracts\Tenant
         Concerns\HasDataColumn,
         Concerns\HasInternalKeys,
         Concerns\TenantRun,
+        Concerns\InitializationHelpers,
         Concerns\InvalidatesResolverCache;
 
     protected $table = 'tenants';

src/Database/ParentModelScope.php

@@ -19,7 +19,7 @@ class ParentModelScope implements Scope
         $builder->whereHas($builder->getModel()->getRelationshipToPrimaryModel());
     }
 
-    public function extend(Builder $builder)
+    public function extend(Builder $builder): void
     {
         $builder->macro('withoutParentModel', function (Builder $builder) {
             return $builder->withoutGlobalScope($this);

src/Database/TenantDatabaseManagers/PermissionControlledMySQLDatabaseManager.php

@@ -12,7 +12,8 @@ class PermissionControlledMySQLDatabaseManager extends MySQLDatabaseManager impl
 {
     use CreatesDatabaseUsers;
 
-    public static $grants = [
+    /** @var string[] */
+    public static array $grants = [
         'ALTER', 'ALTER ROUTINE', 'CREATE', 'CREATE ROUTINE', 'CREATE TEMPORARY TABLES', 'CREATE VIEW',
         'DELETE', 'DROP', 'EVENT', 'EXECUTE', 'INDEX', 'INSERT', 'LOCK TABLES', 'REFERENCES', 'SELECT',
         'SHOW VIEW', 'TRIGGER', 'UPDATE',

src/Database/TenantDatabaseManagers/PostgreSQLSchemaManager.php

@@ -25,11 +25,7 @@ class PostgreSQLSchemaManager extends TenantDatabaseManager
 
     public function makeConnectionConfig(array $baseConfig, string $databaseName): array
     {
-        if (version_compare(app()->version(), '9.0', '>=')) {
-            $baseConfig['search_path'] = $databaseName;
-        } else {
-            $baseConfig['schema'] = $databaseName;
-        }
+        $baseConfig['search_path'] = $databaseName;
 
         return $baseConfig;
     }

src/Database/TenantDatabaseManagers/SQLiteDatabaseManager.php

@@ -10,10 +10,15 @@ use Throwable;
 
 class SQLiteDatabaseManager implements TenantDatabaseManager
 {
+    /**
+     * SQLite Database path without ending slash.
+     */
+    public static string|null $path = null;
+
     public function createDatabase(TenantWithDatabase $tenant): bool
     {
         try {
-            return file_put_contents(database_path($tenant->database()->getName()), '');
+            return (bool) file_put_contents($this->getPath($tenant->database()->getName()), '');
         } catch (Throwable) {
             return false;
         }
@@ -22,7 +27,7 @@ class SQLiteDatabaseManager implements TenantDatabaseManager
     public function deleteDatabase(TenantWithDatabase $tenant): bool
     {
         try {
-            return unlink(database_path($tenant->database()->getName()));
+            return unlink($this->getPath($tenant->database()->getName()));
         } catch (Throwable) {
             return false;
         }
@@ -30,7 +35,7 @@ class SQLiteDatabaseManager implements TenantDatabaseManager
 
     public function databaseExists(string $name): bool
     {
-        return file_exists(database_path($name));
+        return file_exists($this->getPath($name));
     }
 
     public function makeConnectionConfig(array $baseConfig, string $databaseName): array
@@ -44,4 +49,13 @@ class SQLiteDatabaseManager implements TenantDatabaseManager
     {
         //
     }
+
+    public function getPath(string $name): string
+    {
+        if (static::$path) {
+            return static::$path . DIRECTORY_SEPARATOR . $name;
+        }
+
+        return database_path($name);
+    }
 }

src/Database/TenantScope.php

@@ -17,10 +17,10 @@ class TenantScope implements Scope
             return;
         }
 
-        $builder->where($model->qualifyColumn(BelongsToTenant::$tenantIdColumn), tenant()->getTenantKey());
+        $builder->where($model->qualifyColumn(BelongsToTenant::tenantIdColumn()), tenant()->getTenantKey());
     }
 
-    public function extend(Builder $builder)
+    public function extend(Builder $builder): void
     {
         $builder->macro('withoutTenancy', function (Builder $builder) {
             return $builder->withoutGlobalScope($this);