KMP PHP API Reference

TenantProvisioningRequest
in package

FinalYes

Immutable tenant provisioning inputs shared by CLI and platform jobs.

Table of Contents

Constants

STATUS_ACTIVE  : mixed = 'active'
STATUS_PROVISIONING  : mixed = 'provisioning'

Properties

$blobContainer  : string|null
$createDatabase  : bool
$dbName  : string|null
$dbRole  : string|null
$dbServer  : string|null
$displayName  : string
$finalStatus  : string
$host  : string
$initialSuperUserEmail  : string|null
$region  : string
$rotatePassword  : bool
$runMigrations  : bool
$skipCreateDatabase  : bool
$slug  : string
$smokeTable  : string
$tenantConfig  : array<string|int, mixed>

Methods

__construct()  : mixed
Constructor.
fromArray()  : self
normalized()  : self
Return a copy with normalized, defaulted values.
boolValue()  : bool
Normalize booleans from form, CLI, and JSON payload values.
nullableString()  : string|null
Normalize nullable string input.

Constants

Properties

Methods

__construct()

Constructor.

public __construct(string $slug, string $displayName, string $host[, string|null $dbServer = null ][, string|null $dbName = null ][, string|null $dbRole = null ][, string|null $blobContainer = null ][, string $region = 'us' ][, array<string, mixed> $tenantConfig = [] ][, string $finalStatus = self::STATUS_ACTIVE ][, bool $createDatabase = false ][, bool $skipCreateDatabase = false ][, bool $runMigrations = true ][, string $smokeTable = 'members' ][, bool $rotatePassword = false ][, string|null $initialSuperUserEmail = null ]) : mixed
Parameters
$slug : string
$displayName : string
$host : string
$dbServer : string|null = null
$dbName : string|null = null
$dbRole : string|null = null
$blobContainer : string|null = null
$region : string = 'us'
$tenantConfig : array<string, mixed> = []

Safe tenant config

$finalStatus : string = self::STATUS_ACTIVE
$createDatabase : bool = false
$skipCreateDatabase : bool = false
$runMigrations : bool = true
$smokeTable : string = 'members'
$rotatePassword : bool = false
$initialSuperUserEmail : string|null = null

fromArray()

public static fromArray(array<string, mixed> $data) : self
Parameters
$data : array<string, mixed>

Request data

Return values
self

normalized()

Return a copy with normalized, defaulted values.

public normalized(string $defaultDbServer) : self
Parameters
$defaultDbServer : string
Return values
self

boolValue()

Normalize booleans from form, CLI, and JSON payload values.

private static boolValue(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

nullableString()

Normalize nullable string input.

private static nullableString(mixed $value) : string|null
Parameters
$value : mixed
Return values
string|null
On this page

Search results