KMP PHP API Reference

ReleaseManifest
in package

FinalYes

Immutable deploy manifest describing app image and tenant schema bounds.

Table of Contents

Properties

$appVersion  : string
$compatiblePreviousSchemas  : array<string|int, mixed>
$image  : string
$imageDigest  : string
$maxTenantSchema  : string
$migrationPolicy  : array<string|int, mixed>
$minTenantSchema  : string
$rollbackNotes  : string

Methods

fromArray()  : self
Build a manifest from decoded JSON data.
fromFile()  : self
Load and validate a release manifest JSON file.
toMetadata()  : array<string, mixed>
Return safe metadata for platform job parameters.
__construct()  : mixed
Constructor.
arrayValue()  : array<string, mixed>
schemaListValue()  : array<int, string>
schemaValue()  : string
stringValue()  : string

Properties

$compatiblePreviousSchemas read-only

public array<string|int, mixed> $compatiblePreviousSchemas

$migrationPolicy read-only

public array<string|int, mixed> $migrationPolicy

Methods

fromArray()

Build a manifest from decoded JSON data.

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

fromFile()

Load and validate a release manifest JSON file.

public static fromFile(string $path) : self
Parameters
$path : string
Return values
self

toMetadata()

Return safe metadata for platform job parameters.

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

__construct()

Constructor.

private __construct(string $appVersion, string $image, string $imageDigest, string $minTenantSchema, string $maxTenantSchema, array<int, string> $compatiblePreviousSchemas, array<string, mixed> $migrationPolicy, string $rollbackNotes) : mixed
Parameters
$appVersion : string
$image : string
$imageDigest : string
$minTenantSchema : string
$maxTenantSchema : string
$compatiblePreviousSchemas : array<int, string>
$migrationPolicy : array<string, mixed>
$rollbackNotes : string

arrayValue()

private static arrayValue(array<string, mixed> $data, string $key) : array<string, mixed>
Parameters
$data : array<string, mixed>
$key : string
Return values
array<string, mixed>

schemaListValue()

private static schemaListValue(array<string, mixed> $data, string $key) : array<int, string>
Parameters
$data : array<string, mixed>
$key : string
Return values
array<int, string>

schemaValue()

private static schemaValue(array<string, mixed> $data, string $key) : string
Parameters
$data : array<string, mixed>
$key : string
Return values
string

stringValue()

private static stringValue(array<string, mixed> $data, string $key) : string
Parameters
$data : array<string, mixed>
$key : string
Return values
string
On this page

Search results