KMP PHP API Reference

BackupPayloadUpgradeService
in package

Applies ordered object-level upgrades to decoded backup payloads.

Table of Contents

Properties

$migrators  : array<string|int, mixed>|null

Methods

__construct()  : mixed
upgrade()  : array{payload: array, stats: array}
detectSourceVersion()  : string
migrators()  : array<int, BackupPayloadMigratorInterface>
reportProgress()  : void

Properties

Methods

upgrade()

public upgrade(array<string, mixed> $payload[, callable(array<string, mixed>): void|null $progressReporter = null ]) : array{payload: array, stats: array}
Parameters
$payload : array<string, mixed>

Decoded backup payload.

$progressReporter : callable(array<string, mixed>): void|null = null
Return values
array{payload: array, stats: array}

detectSourceVersion()

private detectSourceVersion(array<string, mixed> $payload) : string
Parameters
$payload : array<string, mixed>

Decoded backup payload.

Return values
string

reportProgress()

private reportProgress(callable(array<string, mixed>): void|null $progressReporter, string $phase, string $message[, array<string, mixed> $context = [] ]) : void
Parameters
$progressReporter : callable(array<string, mixed>): void|null
$phase : string
$message : string
$context : array<string, mixed> = []
On this page

Search results