Documentation

pm_Backup_Manager
in package

Manager of backups for extension.

Tags
since
17.8

Table of Contents

OBJECT_TYPE_CLIENT  = 'client'
OBJECT_TYPE_DOMAIN  = 'domain'
OBJECT_TYPE_RESELLER  = 'reseller'
OBJECT_TYPE_SERVER  = 'server'
activateStorage()  : mixed
Activate storage of extension
getBackupUrl()  : string
Retrieve backup form URL
getDumpsDir()  : string
Returns an absolute path to the local backups directory.
getListUrl()  : string
Retrieve backups list URL
getLogsDir()  : string
Returns an absolute path to the logs directory.

Constants

OBJECT_TYPE_CLIENT

public mixed OBJECT_TYPE_CLIENT = 'client'
Tags
since
18.0

OBJECT_TYPE_DOMAIN

public mixed OBJECT_TYPE_DOMAIN = 'domain'
Tags
since
18.0

OBJECT_TYPE_RESELLER

public mixed OBJECT_TYPE_RESELLER = 'reseller'
Tags
since
18.0

OBJECT_TYPE_SERVER

public mixed OBJECT_TYPE_SERVER = 'server'
Tags
since
18.0

Methods

activateStorage()

Activate storage of extension

public static activateStorage(string $objectType[,  $objectId = null ]) : mixed

Object type is the one of

  • pm_Backup_Manager::OBJECT_TYPE_SERVER
  • pm_Backup_Manager::OBJECT_TYPE_RESELLER
  • pm_Backup_Manager::OBJECT_TYPE_CLIENT
  • pm_Backup_Manager::OBJECT_TYPE_DOMAIN
Parameters
$objectType : string
$objectId : = null
Tags
throws
pm_Exception
since
18.0
Return values
mixed

getBackupUrl()

Retrieve backup form URL

public static getBackupUrl(int $domainId, string $context) : string
Parameters
$domainId : int
$context : string
Return values
string

getDumpsDir()

Returns an absolute path to the local backups directory.

public static getDumpsDir() : string
Tags
since
18.0.35
Return values
string

getListUrl()

Retrieve backups list URL

public static getListUrl( $domainId,  $marker) : string
Parameters
$domainId :
$marker :
Return values
string

getLogsDir()

Returns an absolute path to the logs directory.

public static getLogsDir() : string
Tags
since
18.0.35
Return values
string

Search results