MainWP Code Reference
\
MainWP
Child
Dashboard
Module
ApiBackups
CostTracker
Log

\MainWP\ChildMainWP_Child_Back_Up_Buddy

Class MainWP_Child_Back_Up_Buddy

Summary

Methods
Properties
Constants
instance()
__construct()
hide_update_notice()
remove_update_nag()
all_plugins()
admin_menu()
do_site_stats()
do_reports_log()
action()
set_showhide()
save_settings()
reset_defaults()
get_notifications()
get_schedules_run_time()
schedules_list()
run_scheduled_backup()
save_scheduled_backup()
save_profile()
delete_profile()
delete_backup()
sync_others_data()
get_sync_data()
localize_time()
backup_list()
save_note()
get_hash()
zip_viewer()
exclude_tree()
pb_additional_tables()
restore_file_view()
restore_file_restore()
get_backup_list()
get_recent_backup_list()
delete_scheduled_backup()
view_log()
pb_pretty_results()
view_detail()
reset_integrity()
download_archive()
create_backup()
start_backup()
backup_status()
stop_backup()
remote_save()
remote_list()
remote_delete()
remote_send()
get_main_log()
settings_other()
malware_scan()
live_setup()
live_save_settings()
live_action_disconnect()
live_action()
download_troubleshooting()
get_live_backups()
copy_file_to_local()
delete_file_backup()
get_live_stats()
save_license_settings()
load_products_license()
activate_package()
deactivate_package()
$instance
$plugin_translate
$is_backupbuddy_installed
No constants found
No protected methods found
No protected properties found
N/A
get_error_explanation()
No private properties found
N/A

Properties

$instance

$instance : null

Public static variable to hold the single instance of MainWP_Child_Back_Up_Buddy.

Type

null

$plugin_translate

$plugin_translate : string

Type

string — Plugin translation string.

$is_backupbuddy_installed

$is_backupbuddy_installed : boolean

Type

boolean — Whether or not BackupBuddy is installed. Default: False.

Methods

__construct()

__construct()

MainWP_Child_Back_Up_Buddy constructor.

Run any time class is called.

hide_update_notice()

hide_update_notice(string  $slugs) : string

Hide Backupbuddy update notice.

Parameters

string $slugs

plugin slug.

Returns

string —

$slugs Return slugs array.

remove_update_nag()

remove_update_nag(array  $value) : array

Remove update nag.

Parameters

array $value

Plugin slug array.

Returns

array —

$value Plugin slug array.

all_plugins()

all_plugins(array  $plugins) : array

Remove Backup buddy from plugins list.

Parameters

array $plugins

All plugins array.

Returns

array —

$plugins All plugins array with backupbuddy removed.

admin_menu()

admin_menu()

Remove backupbuddy from admin menu.

do_site_stats()

do_site_stats()

Backupbuddy Client Reports log.

do_reports_log()

do_reports_log(string  $ext = '')

Create BackupBuddy Client Reports log.

Parameters

string $ext

Extension to create log for.

action()

action()

MainWP Child BackupBuddy actions.

set_showhide()

set_showhide() : array

Set show or hide BackupBuddy Plugin from Admin & plugins list.

Returns

array —

$information Return results.

save_settings()

save_settings() : array

Save BackupBuddy settings.

Returns

array —

$out Return response array.

reset_defaults()

reset_defaults() : array

Reset BackupBuddy defaults.

Returns

array —

$information Return success message & result.

get_notifications()

get_notifications() : array

Get BackupBuddy core success notifications.

Returns

array —

Return BackupBuddy SUCCESS notifications.

get_schedules_run_time()

get_schedules_run_time() : array

Get schedules run time.

Returns

array —

Return $schedules_run_time.

schedules_list()

schedules_list() : array

List schedules.

Returns

array —

$information Return results array.

run_scheduled_backup()

run_scheduled_backup() : array

Run scheduled backup.

Returns

array —

$information Return results array.

save_scheduled_backup()

save_scheduled_backup() : array|array<mixed,string>

Save scheduled backup.

Returns

array|array<mixed,string> —

$information Return results array.

save_profile()

save_profile() : array

Save profile.

Returns

array —

$information Return response array.

delete_profile()

delete_profile() : array

Delete profile.

Returns

array —

$information Return results array.

delete_backup()

delete_backup(string  $type = 'default', boolean  $subsite_mode = false) : array

Delete backup.

Parameters

string $type

Type of backup.
boolean $subsite_mode

Whether or not the backup is for a subsite. Default: false.

Returns

array —

$information Return results array.

sync_others_data()

sync_others_data(array  $information, array  $data = array()) : array

Sync other data from $data[] and merge with $information[]

Parameters

array $information

Returned response array for MainWP BackWPup Extension actions.
array $data

Other data to sync to $information array.

Returns

array —

$information Returned information array with both sets of data.

get_sync_data()

get_sync_data()

Get sync data.

localize_time()

localize_time(float  $timestamp) : float|integer

Localize time.

Parameters

float $timestamp

Time to localize.

Returns

float|integer —

Return localized timestamp.

backup_list()

backup_list() : array

Backup list.

Returns

array —

$information Return results array.

save_note()

save_note() : array

Save note.

Returns

array —

$information Return results array.

get_hash()

get_hash() : array|array<mixed,string>

Get hash.

Returns

array|array<mixed,string> —

Return results array.

zip_viewer()

zip_viewer() : array|array<mixed,string>

Zip viewer.

Returns

array|array<mixed,string> —

Return results array.

exclude_tree()

exclude_tree() : array|array<mixed,string>

Exclude tree.

Returns

array|array<mixed,string> —

Return excluded files & directories list html or ERROR message.

pb_additional_tables()

pb_additional_tables(boolean  $display_size = false) : string

Additional tables.

Parameters

boolean $display_size

Display size. Default: false.

Throws

\MainWP\Child\Exception|\Exception

Error message.

Returns

string —

Additional table html.

restore_file_view()

restore_file_view() : array|array<mixed,string>

Restore file view.

Returns

array|array<mixed,string> —

Return results array. ERROR message on failure.

restore_file_restore()

restore_file_restore() : array

Backupbuddy Restore files.

Returns

array —

Return results array.

get_backup_list()

get_backup_list(string  $type = 'default', boolean  $subsite_mode = false) : array

Get backup list.

Parameters

string $type

Type of backup.
boolean $subsite_mode

Whether or not the backup is for a subsite. Default: false.

Returns

array —

Return $sorted_backups array.

get_recent_backup_list()

get_recent_backup_list() : array

Get recent backup list.

Returns

array —

$recentBackups Return recent backups array.

delete_scheduled_backup()

delete_scheduled_backup() : array

Delete sheduled backup.

Returns

array —

$information Return results array.

view_log()

view_log() : array|array<mixed,string>

View log.

Returns

array|array<mixed,string> —

Return log html.

pb_pretty_results()

pb_pretty_results(boolean  $value) : string

Pretty results.

Parameters

boolean $value

Results TRUE|FALSE.

Returns

string —

Return Pass or Fail message.

view_detail()

view_detail() : array|array<mixed,string>

View details.

Returns

array|array<mixed,string> —

Return results array & echo details.

reset_integrity()

reset_integrity() : array

Reset Integrity.

Returns

array —

$information Return results array.

download_archive()

download_archive()

Download backup archive.

create_backup()

create_backup() : array|array<mixed,string>

Create backup.

Returns

array|array<mixed,string> —

Return SUCCESS message or ERROR message.

start_backup()

start_backup() : array|array<mixed,integer>|array<mixed,string>

Start backup.

Returns

array|array<mixed,integer>|array<mixed,string> —

Return results array containing either OK->1 OR ERROR message.

backup_status()

backup_status() : array|array<mixed,string>

Backup status.

Returns

array|array<mixed,string> —

Return results array or ERROR message on failure.

stop_backup()

stop_backup() : array<mixed,integer>

Stop Backup.

Returns

array<mixed,integer> —

Return 1 on success.

remote_save()

remote_save() : array<mixed,integer>|array<mixed,string>

Remove Save.

Returns

array<mixed,integer>|array<mixed,string> —

Return 1 on success or ERROR message on failure.

remote_list()

remote_list() : array

Remove backup list.

Returns

array —

$information Return results array.

remote_delete()

remote_delete() : array|array<mixed,integer>|array<mixed,string>

Remote backup delete.

Returns

array|array<mixed,integer>|array<mixed,string> —

Returm OK on success or ERROR message on failure.

remote_send()

remote_send() : array|array<mixed,integer>|array<mixed,string>

Remove send.

Returns

array|array<mixed,integer>|array<mixed,string> —

Return 1 on sucess or ERROR message on failure.

get_main_log()

get_main_log() : array

Get main log.

Returns

array —

Return result array or ERROR message on failure.

settings_other()

settings_other() : array<mixed,string>

Other settings.

Returns

array<mixed,string> —

Return results array.

malware_scan()

malware_scan() : array

Malware scan.

Returns

array —

$result Return result array.

live_setup()

live_setup() : array|array<mixed,array>

Live setup.

Returns

array|array<mixed,array>

live_save_settings()

live_save_settings() : array<mixed,integer>|array<mixed,string>

Live save settings.

Returns

array<mixed,integer>|array<mixed,string> —

Return 1 on success or ERROR message on failure.

live_action_disconnect()

live_action_disconnect() : array

Live action disconnect.

Returns

array —

$return Return 1 on success or ERROR message on failure.

live_action()

live_action() : array

Live action.

Returns

array —

Return results array.

download_troubleshooting()

download_troubleshooting() : array

Download troubleshooting.

Returns

array —

Return results array.

get_live_backups()

get_live_backups() : array<mixed,array>|array<mixed,string>

Get live backups.

Returns

array<mixed,array>|array<mixed,string> —

Return backup list.

copy_file_to_local()

copy_file_to_local() : array<mixed,integer>|array<mixed,string>

Copy file to local.

Returns

array<mixed,integer>|array<mixed,string> —

Return 1 on success and ERROR message on failure.

delete_file_backup()

delete_file_backup() : array<mixed,integer>|array<mixed,string>

Delete backup file.

Returns

array<mixed,integer>|array<mixed,string> —

Return 1 on success and ERROR message on failure.

get_live_stats()

get_live_stats() : array|array<mixed,string>

Get live stats.

Returns

array|array<mixed,string> —

Return json encoded results or ERROR message on failure.

save_license_settings()

save_license_settings() : boolean|array<mixed,integer>

Save license settings.

Returns

boolean|array<mixed,integer> —

Return 1 on success and FALSE on failure.

load_products_license()

load_products_license() : array

Load product license.

Returns

array —

Return results array.

activate_package()

activate_package() : array

Activate package.

Returns

array —

$return Return response array.

deactivate_package()

deactivate_package(array  $data) : array

Deactivate package.

Parameters

array $data

Data array.

Returns

array —

return$ Return response array.

get_error_explanation()

get_error_explanation(  $error, string  $package = '') : string

Get error code.

Parameters

$error

Returned error to get code for: Bad_Login, Username_Unknown, Username_Invalid, Package_Unknown, Too_Many_Sites, Generate_Failed.
string $package

Ithemes package.

Returns

string —

$message Return ERROR message to display.