TenantMetadata
in package
FinalYes
Immutable platform metadata required to bind a tenant-scoped request or job.
Table of Contents
Properties
- $dbName : string
- $dbRole : string
- $dbServer : string
- $displayName : string
- $id : string
- $schemaVersion : string|null
- $slug : string
- $status : string
- $tenantConfig : array<string|int, mixed>
Methods
- __construct() : mixed
- Constructor.
- fromPlatformRow() : self
Properties
$dbName read-only
public
string
$dbName
$dbRole read-only
public
string
$dbRole
$dbServer read-only
public
string
$dbServer
$displayName read-only
public
string
$displayName
$id read-only
public
string
$id
$schemaVersion read-only
public
string|null
$schemaVersion
= null
$slug read-only
public
string
$slug
$status read-only
public
string
$status
$tenantConfig read-only
public
array<string|int, mixed>
$tenantConfig
= []
Methods
__construct()
Constructor.
public
__construct(string $id, string $slug, string $displayName, string $status, string $dbServer, string $dbName, string $dbRole[, string|null $schemaVersion = null ][, array<string, mixed> $tenantConfig = [] ]) : mixed
Parameters
- $id : string
-
Tenant UUID
- $slug : string
-
Tenant slug
- $displayName : string
-
Human-readable tenant name
- $status : string
-
Tenant lifecycle status
- $dbServer : string
-
Tenant database host
- $dbName : string
-
Tenant database name
- $dbRole : string
-
Tenant database role/user
- $schemaVersion : string|null = null
-
Last applied tenant schema version
- $tenantConfig : array<string, mixed> = []
-
Tenant-specific platform configuration
fromPlatformRow()
public
static fromPlatformRow(array<string, mixed> $row) : self
Parameters
- $row : array<string, mixed>
-
Platform tenant row