LocalTenantBackupStorage
in package
implements
TenantBackupStorageInterface
Table of Contents
Interfaces
Properties
Methods
- __construct() : mixed
- delete() : void
- Delete a stored encrypted archive.
- retrieve() : TenantBackupStoredObject
- Retrieve and verify basic metadata for an encrypted archive.
- store() : TenantBackupStoredObject
- workPath() : string
- Return an isolated local staging path for an archive.
- assertEnabled() : void
- assertSafePath() : void
- assertSafeSegment() : void
- assertSafeSuffix() : void
- ensureDirectory() : void
- join() : string
- pathFromUri() : string
Properties
$enabled read-only
private
bool
$enabled
$rootPath read-only
private
string
$rootPath
Methods
__construct()
public
__construct(string $rootPath, bool $enabled) : mixed
Parameters
- $rootPath : string
- $enabled : bool
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()
public
store(TenantMetadata $tenant, string $backupId, string $encryptedPath) : TenantBackupStoredObject
Parameters
- $tenant : TenantMetadata
- $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
assertSafePath()
private
assertSafePath(string $path, string $label) : void
Parameters
- $path : string
- $label : string
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