LocalPlatformDatabaseBackupStorage
in package
implements
PlatformDatabaseBackupStorageInterface
Table of Contents
Interfaces
Properties
- $allowInEnvironments : array<string|int, mixed>
- $enabled : bool
- $environment : string
- $rootPath : string
Methods
- __construct() : mixed
- delete() : void
- Delete a stored encrypted archive.
- retrieve() : TenantBackupStoredObject
- Retrieve and verify basic metadata for an encrypted archive.
- store() : TenantBackupStoredObject
- Persist an encrypted platform database archive.
- workPath() : string
- Return an isolated local staging path for an archive.
- assertEnabled() : void
- assertSafeSegment() : void
- assertSafeSuffix() : void
- ensureDirectory() : void
- join() : string
- pathFromUri() : string
Properties
$allowInEnvironments read-only
private
array<string|int, mixed>
$allowInEnvironments
= ['local', 'development', 'dev', 'test', 'ci']
$enabled read-only
private
bool
$enabled
$environment read-only
private
string
$environment
= 'production'
$rootPath read-only
private
string
$rootPath
Methods
__construct()
public
__construct(string $rootPath, bool $enabled[, string $environment = 'production' ][, array<string|int, mixed> $allowInEnvironments = ['local', 'development', 'dev', 'test', 'ci'] ]) : mixed
Parameters
- $rootPath : string
- $enabled : bool
- $environment : string = 'production'
- $allowInEnvironments : array<string|int, mixed> = ['local', 'development', 'dev', 'test', 'ci']
delete()
Delete a stored encrypted archive.
public
delete(string $objectUri) : void
Parameters
- $objectUri : string
retrieve()
Retrieve and verify basic metadata for an encrypted archive.
public
retrieve(string $objectUri, string $destinationPath) : TenantBackupStoredObject
Parameters
- $objectUri : string
- $destinationPath : string
Return values
TenantBackupStoredObjectstore()
Persist an encrypted platform database archive.
public
store(string $backupId, string $encryptedPath) : TenantBackupStoredObject
Parameters
- $backupId : string
- $encryptedPath : string
Return values
TenantBackupStoredObjectworkPath()
Return an isolated local staging path for an archive.
public
workPath(string $backupId, string $suffix) : string
Parameters
- $backupId : string
- $suffix : string
Return values
stringassertEnabled()
private
assertEnabled() : void
assertSafeSegment()
private
assertSafeSegment(string $segment, string $label) : void
Parameters
- $segment : string
- $label : string
assertSafeSuffix()
private
assertSafeSuffix(string $suffix) : void
Parameters
- $suffix : string
ensureDirectory()
private
ensureDirectory(string $dir) : void
Parameters
- $dir : string
join()
private
join(string $left, string $right) : string
Parameters
- $left : string
- $right : string
Return values
stringpathFromUri()
private
pathFromUri(string $objectUri) : string
Parameters
- $objectUri : string