TenantAtlas/app/Support/Tenants/TenantLifecyclePresentation.php
ahmido 6ca496233b feat: centralize tenant lifecycle presentation (#175)
## Summary
- add a shared tenant lifecycle presentation contract and referenced-tenant adapter for canonical lifecycle labels and helper copy
- align tenant, chooser, onboarding, archived-banner, and tenantless operation viewer surfaces with the shared lifecycle vocabulary
- add Spec 146 design artifacts, audit notes, and regression coverage for lifecycle presentation across Filament and onboarding surfaces

## Validation
- `vendor/bin/sail bin pint --dirty --format agent`
- `vendor/bin/sail artisan test --compact tests/Feature/Badges/TenantStatusBadgeTest.php tests/Unit/Badges/TenantBadgesTest.php tests/Unit/Tenants/TenantLifecycleTest.php tests/Unit/Support/Tenants/TenantLifecyclePresentationTest.php tests/Feature/Filament/TenantLifecyclePresentationAcrossTenantSurfacesTest.php tests/Feature/Filament/ReferencedTenantLifecyclePresentationTest.php tests/Feature/Filament/TenantLifecycleStatusDomainSeparationTest.php tests/Feature/Filament/TenantViewHeaderUiEnforcementTest.php tests/Feature/Onboarding/TenantLifecyclePresentationCopyTest.php tests/Feature/Onboarding/OnboardingDraftAuthorizationTest.php tests/Feature/Onboarding/OnboardingDraftLifecycleTest.php`

## Notes
- Livewire v4.0+ compliance preserved; this change is presentation-only on existing Filament v5 surfaces.
- Panel provider registration remains unchanged in `bootstrap/providers.php`.
- No global-search behavior changed; no resource was newly made globally searchable or disabled.
- No destructive actions were added or changed.
- No asset registration strategy changed; existing deploy flow for `php artisan filament:assets` remains unchanged.

Co-authored-by: Ahmed Darrazi <ahmed.darrazi@live.de>
Reviewed-on: #175
2026-03-16 18:18:53 +00:00

129 lines
4.7 KiB
PHP

<?php
declare(strict_types=1);
namespace App\Support\Tenants;
use App\Models\Tenant;
use App\Support\Badges\BadgeSpec;
final readonly class TenantLifecyclePresentation
{
private function __construct(
public string $value,
public string $label,
public string $badgeColor,
public ?string $badgeIcon,
public ?string $badgeIconColor,
public string $shortDescription,
public string $longDescription,
public bool $isInvalidFallback,
public ?TenantLifecycle $lifecycle,
) {}
public static function fromTenant(Tenant $tenant): self
{
if ($tenant->trashed()) {
return self::forLifecycle(TenantLifecycle::Archived);
}
return self::fromValue($tenant->status);
}
public static function fromValue(mixed $value): self
{
$lifecycle = TenantLifecycle::tryFromValue($value);
if ($lifecycle instanceof TenantLifecycle) {
return self::forLifecycle($lifecycle);
}
return self::invalid(TenantLifecycle::normalize($value));
}
public static function forLifecycle(TenantLifecycle $lifecycle): self
{
return match ($lifecycle) {
TenantLifecycle::Draft => new self(
value: $lifecycle->value,
label: $lifecycle->label(),
badgeColor: 'gray',
badgeIcon: 'heroicon-m-document',
badgeIconColor: null,
shortDescription: 'Draft tenant awaiting onboarding completion.',
longDescription: 'This tenant is still in draft and remains available for setup and review, but it is not selectable as active context until onboarding progresses.',
isInvalidFallback: false,
lifecycle: $lifecycle,
),
TenantLifecycle::Onboarding => new self(
value: $lifecycle->value,
label: $lifecycle->label(),
badgeColor: 'warning',
badgeIcon: 'heroicon-m-arrow-path',
badgeIconColor: null,
shortDescription: 'Onboarding is in progress.',
longDescription: 'This tenant is still onboarding. It remains visible on management and review surfaces, but it is not selectable as active context until onboarding completes.',
isInvalidFallback: false,
lifecycle: $lifecycle,
),
TenantLifecycle::Active => new self(
value: $lifecycle->value,
label: $lifecycle->label(),
badgeColor: 'success',
badgeIcon: 'heroicon-m-check-circle',
badgeIconColor: null,
shortDescription: 'Active tenant available for normal operations.',
longDescription: 'This tenant is active and available across normal management, tenant selection, and operational follow-up flows.',
isInvalidFallback: false,
lifecycle: $lifecycle,
),
TenantLifecycle::Archived => new self(
value: $lifecycle->value,
label: $lifecycle->label(),
badgeColor: 'gray',
badgeIcon: 'heroicon-m-archive-box',
badgeIconColor: null,
shortDescription: 'Archived tenant retained for inspection only.',
longDescription: 'This tenant remains available for inspection and audit history, but it is not selectable as active context until you restore it.',
isInvalidFallback: false,
lifecycle: $lifecycle,
),
};
}
public static function invalid(?string $normalizedValue = null): self
{
return new self(
value: $normalizedValue ?? 'invalid',
label: 'Invalid lifecycle',
badgeColor: 'danger',
badgeIcon: 'heroicon-m-exclamation-triangle',
badgeIconColor: 'danger',
shortDescription: 'Lifecycle data is invalid and requires review.',
longDescription: 'The stored tenant lifecycle value is not canonical. Review the source data before treating this tenant as draft, onboarding, active, or archived.',
isInvalidFallback: true,
lifecycle: null,
);
}
public function badge(): BadgeSpec
{
return new BadgeSpec(
label: $this->label,
color: $this->badgeColor,
icon: $this->badgeIcon,
iconColor: $this->badgeIconColor,
);
}
public function isSelectableAsContext(): bool
{
return $this->lifecycle?->canSelectAsContext() ?? false;
}
public function lowercaseLabel(): string
{
return strtolower($this->label);
}
}