MainWP Code Reference
\
MainWP
Child
Dashboard
Module
ApiBackups
CostTracker
Log

\MainWP\DashboardMainWP_Manage_Backups_Handler

Class MainWP_Manage_Backups_Handler

Summary

Methods
Properties
Constants
instance()
get_class_name()
validate_backup_tasks()
can_edit_backuptask()
update_backup()
add_backup()
execute_backup_task()
backup()
get_backup_task_sites()
remove_backup()
resume_backup()
pause_backup()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$instance
N/A

Properties

$instance

$instance : null

Instance variable.

Type

null

Methods

instance()

instance() : self

Create instance.

Returns

self —

$instance.

get_class_name()

get_class_name() : string

Get Class Name.

Returns

string —

CLASS

validate_backup_tasks()

validate_backup_tasks(array  $pBackupTasks) : boolean

Validate Backup Tasks.

Parameters

array $pBackupTasks

Backup tasks.

Returns

boolean —

true|false.

can_edit_backuptask()

can_edit_backuptask(object  $task) : boolean

Can Edit Backup Task.

Parameters

object $task

Backup task.

Returns

boolean —

true|false.

update_backup()

update_backup()

Update backup task.

add_backup()

add_backup()

Add backup task.

execute_backup_task()

execute_backup_task(mixed  $task, integer  $nrOfSites, boolean  $updateRun = true) : mixed

Execute the backup task.

Parameters

mixed $task

Task to perform.
integer $nrOfSites

Number of Child Sites to perform the task on.
boolean $updateRun

ture|false.

Returns

mixed —

$errorOutput.

backup()

backup(mixed  $pTaskId, mixed  $pSiteId, mixed  $pFileNameUID) : self

Prepare Child Site to be backed up.

Parameters

mixed $pTaskId

Task ID.
mixed $pSiteId

Child Site ID.
mixed $pFileNameUID

Filename Unique ID.

Throws

\MainWP\Dashboard\MainWP_Exception

Error message.

Returns

self —

MainWP_Manage_Sites_Handler()

get_backup_task_sites()

get_backup_task_sites(mixed  $pTaskId) : array

Get backup tasks and site ID.

Parameters

mixed $pTaskId

Task ID.

Returns

array —

$allSites All Sites array. $remoteDestinations Remote destinations array.

remove_backup()

remove_backup()

Remove Backup.

resume_backup()

resume_backup()

Resume Backup.

pause_backup()

pause_backup()

Pause Backup.