KMP PHP API Reference

JsonTenantBackupRestorer
in package
implements TenantBackupRestorerInterface

FinalYes

Validates and restores KMP JSON logical archives inside a tenant scope.

Table of Contents

Interfaces

TenantBackupRestorerInterface

Properties

$backupServiceFactory  : callable(): BackupService
$migrationRunner  : callable(): void
$tenantConnections  : TenantConnectionManager

Methods

__construct()  : mixed
restore()  : array<string, mixed>
Restore a decrypted tenant backup into the target tenant database.
validate()  : void
Validate a decrypted tenant backup and its target without mutating data.
backupService()  : BackupService
readArchive()  : string

Properties

Methods

restore()

Restore a decrypted tenant backup into the target tenant database.

public restore(TenantMetadata $targetTenant, SensitiveString $databasePassword, string $backupPath[, callable|null $progressReporter = null ]) : array<string, mixed>
Parameters
$targetTenant : TenantMetadata
$databasePassword : SensitiveString
$backupPath : string
$progressReporter : callable|null = null
Return values
array<string, mixed>

Restore statistics

readArchive()

private readArchive(string $backupPath) : string
Parameters
$backupPath : string
Return values
string
On this page

Search results