Heratio Framework API Reference

BackupService
in package

Table of Contents

Constants

PRESET_AHG  = 'ahg'
PRESET_ATOM_BASE  = 'atom_base'
PRESET_CONTENT  = 'content'
PRESET_DB  = 'db'
Backup presets
PRESET_FULL  = 'full'

Methods

__construct()  : mixed
createBackup()  : array<string|int, mixed>
deleteBackup()  : bool
formatSize()  : string
getAvailablePresets()  : array<string|int, mixed>
Get available presets for UI
getBackupDetails()  : array<string|int, mixed>|null
getPresetConfig()  : array<string|int, mixed>
Get preset configuration
getSettings()  : BackupSettingsService
listBackups()  : array<string|int, mixed>
restoreBackup()  : bool
restoreFromPath()  : array<string|int, mixed>
Restore from a specific path (for uploaded backups)

Constants

PRESET_ATOM_BASE

public mixed PRESET_ATOM_BASE = 'atom_base'

Methods

createBackup()

public createBackup([array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

deleteBackup()

public deleteBackup(string $backupId) : bool
Parameters
$backupId : string
Return values
bool

formatSize()

public formatSize(int $bytes) : string
Parameters
$bytes : int
Return values
string

getAvailablePresets()

Get available presets for UI

public getAvailablePresets() : array<string|int, mixed>
Return values
array<string|int, mixed>

getBackupDetails()

public getBackupDetails(string $backupId) : array<string|int, mixed>|null
Parameters
$backupId : string
Return values
array<string|int, mixed>|null

getPresetConfig()

Get preset configuration

public getPresetConfig(string $preset) : array<string|int, mixed>
Parameters
$preset : string
Return values
array<string|int, mixed>

listBackups()

public listBackups() : array<string|int, mixed>
Return values
array<string|int, mixed>

restoreBackup()

public restoreBackup(string $backupId[, array<string|int, mixed> $options = [] ]) : bool
Parameters
$backupId : string
$options : array<string|int, mixed> = []
Return values
bool

restoreFromPath()

Restore from a specific path (for uploaded backups)

public restoreFromPath(string $backupDir[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
Parameters
$backupDir : string
$options : array<string|int, mixed> = []
Return values
array<string|int, mixed>

        
On this page

Search results