mirror of
https://github.com/archtechx/tenancy.git
synced 2025-12-12 09:34:04 +00:00
Samuel Štancl
657e165cc8
* cleanup, resolve todos, add immediate todos * Improve path_identification_middleware docblock * rename leave() method in tests * wip fix hardcoded values making assumptions about the parameters used in routing * defaultParameterNames * fix CreatesDatabaseUsers return values * $tenant -> tenant() * resolve more todos * make comment block a complete block * Correct useTenantRoutesInFortify(), delete unused import * test fixes * remove todos * remove JobPipeline todo * simplify comment example * remove todo * fix VERSION_PREFIX in queue.yml --------- Co-authored-by: lukinovec <lukinovec@gmail.com>
97 lines
2.9 KiB
PHP
97 lines
2.9 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Stancl\Tenancy\Database\Concerns;
|
|
|
|
use Carbon\Carbon;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Stancl\Tenancy\Contracts\Tenant;
|
|
use Stancl\Tenancy\Events\CreatingPendingTenant;
|
|
use Stancl\Tenancy\Events\PendingTenantCreated;
|
|
use Stancl\Tenancy\Events\PendingTenantPulled;
|
|
use Stancl\Tenancy\Events\PullingPendingTenant;
|
|
|
|
// todo consider adding a method that sets pending_since to null — to flag tenants as not-pending
|
|
|
|
/**
|
|
* @property ?Carbon $pending_since
|
|
*
|
|
* @method static static|\Illuminate\Database\Eloquent\Builder<static>|\Illuminate\Database\Query\Builder withPending(bool $withPending = true)
|
|
* @method static static|\Illuminate\Database\Eloquent\Builder<static>|\Illuminate\Database\Query\Builder onlyPending()
|
|
* @method static static|\Illuminate\Database\Eloquent\Builder<static>|\Illuminate\Database\Query\Builder withoutPending()
|
|
*/
|
|
trait HasPending
|
|
{
|
|
public static string $pendingSinceCast = 'timestamp';
|
|
|
|
/** Boot the trait. */
|
|
public static function bootHasPending(): void
|
|
{
|
|
static::addGlobalScope(new PendingScope());
|
|
}
|
|
|
|
/** Initialize the trait. */
|
|
public function initializeHasPending(): void
|
|
{
|
|
$this->casts['pending_since'] = static::$pendingSinceCast;
|
|
}
|
|
|
|
/** Determine if the model instance is in a pending state. */
|
|
public function pending(): bool
|
|
{
|
|
return ! is_null($this->pending_since);
|
|
}
|
|
|
|
/**
|
|
* Create a pending tenant.
|
|
*
|
|
* @param array<string, mixed> $attributes
|
|
*/
|
|
public static function createPending(array $attributes = []): Model&Tenant
|
|
{
|
|
$tenant = static::create($attributes);
|
|
|
|
event(new CreatingPendingTenant($tenant));
|
|
|
|
// Update the pending_since value only after the tenant is created so it's
|
|
// Not marked as pending until finishing running the migrations, seeders, etc.
|
|
$tenant->update([
|
|
'pending_since' => now()->timestamp,
|
|
]);
|
|
|
|
event(new PendingTenantCreated($tenant));
|
|
|
|
return $tenant;
|
|
}
|
|
|
|
/** Pull a pending tenant. */
|
|
public static function pullPending(): Model&Tenant
|
|
{
|
|
/** @var Model&Tenant $pendingTenant */
|
|
$pendingTenant = static::pullPendingFromPool(true);
|
|
|
|
return $pendingTenant;
|
|
}
|
|
|
|
/** Try to pull a tenant from the pool of pending tenants. */
|
|
public static function pullPendingFromPool(bool $firstOrCreate = true, array $attributes = []): ?Tenant
|
|
{
|
|
/** @var (Model&Tenant)|null $tenant */
|
|
$tenant = static::onlyPending()->first();
|
|
|
|
if ($tenant === null) {
|
|
return $firstOrCreate ? static::create($attributes) : null;
|
|
}
|
|
|
|
event(new PullingPendingTenant($tenant));
|
|
|
|
$tenant->update(array_merge($attributes, [
|
|
'pending_since' => null,
|
|
]));
|
|
|
|
event(new PendingTenantPulled($tenant));
|
|
|
|
return $tenant;
|
|
}
|
|
}
|