Documentation

pm_Hook_Backup_Server
in package
implements pm_Hook_Backup

Hook for backing up and restoring the server configuration

Tags
since
17.0

Interfaces, Classes and Traits

pm_Hook_Backup
Interface for backup and restore hooks

Table of Contents

backup()  : array<string|int, mixed>
Define the content to be stored
getExcludedSettings()  : array<string|int, string>
Define the list of module settings that will not be stored in the backup
postBackup()  : mixed
Define the logic after backup server configuration
restore()  : mixed
Define the logic on restoring the server configuration

Methods

backup()

Define the content to be stored

public backup() : array<string|int, mixed>
[
    string, // Serialized server configuration
    array,  // Array of relative paths inside extension's 'var' directory that will be include in backup
    array,  // Array of relative paths inside extension's 'var' directory that will be exclude from backup
]
Return values
array<string|int, mixed>

getExcludedSettings()

Define the list of module settings that will not be stored in the backup

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

postBackup()

Define the logic after backup server configuration

public postBackup() : mixed
Return values
mixed

restore()

Define the logic on restoring the server configuration

public restore(string $pleskVersion, string $extVersion, string $config, string $contentDir) : mixed
Parameters
$pleskVersion : string

Version of Plesk when backup was created

$extVersion : string

Version of extension when backup was created

$config : string

Stored serialized configuration

$contentDir : string

Directory with stored content

Return values
mixed

Search results