KMP PHP API Reference

TenantMigrationState
in package

FinalYes

Immutable comparison of a tenant database against the migrations in this release.

Table of Contents

Properties

$currentVersion  : string|null
$pendingVersions  : array<string|int, mixed>
$targetVersion  : string
$unexpectedVersions  : array<string|int, mixed>

Methods

__construct()  : mixed
isCurrent()  : bool
Whether every expected migration is applied without history drift.
toMetadata()  : array<string, mixed>
Safe metadata for platform job records and operator output.

Properties

Methods

__construct()

public __construct(string $targetVersion, string|null $currentVersion, array<string, array<int, string>> $pendingVersions, array<string, array<int, string>> $unexpectedVersions) : mixed
Parameters
$targetVersion : string
$currentVersion : string|null
$pendingVersions : array<string, array<int, string>>

Missing versions keyed by migration scope

$unexpectedVersions : array<string, array<int, string>>

Applied versions absent from this release

isCurrent()

Whether every expected migration is applied without history drift.

public isCurrent() : bool
Return values
bool

toMetadata()

Safe metadata for platform job records and operator output.

public toMetadata() : array<string, mixed>
Return values
array<string, mixed>
On this page

Search results