\MainWP\DashboardMainWP_Live_Reports

Class MainWP_Live_Reports()

Private static variable to hold the buffer.

Summary

Methods

Properties

Constants

__construct()
init()
admin_init()
managesite_backup()
managesite_schedule_backup()
mainwp_postprocess_backup_sites_feedback()
cal_schedule_nextsend()
calc_next_schedule_send_date()
save_report()
delete_attach_files()
handle_upload_files()
gen_report_content()
do_filter_content()
filter_report()
filter_report_website()
section_mark_header()
section_mark_body()
section_mark_footer()
sucuri_scan_done()
replace_content()
replace_section_content()
parse_report_content()
remove_section_tokens()
ga_data()
piwik_data()
aum_data()
woocomstatus_data()
pagespeed_tokens()
brokenlinks_tokens()
sec2hms()
fetch_stream_data()
manage_site_token()
update_site_update_tokens()
delete_site_delete_tokens()

$enabled_pagespeed
$enabled_brokenlinks

No constants found

No protected methods found

No protected properties found

N/A

format_stats_values()

$buffer
$enabled_piwik
$enabled_sucuri
$enabled_ga
$enabled_aum
$enabled_woocomstatus
$count_sec_header
$count_sec_body
$count_sec_footer

N/A

File: mainwp/class/class-mainwp-live-report.php
Package: MainWP/Dashboard
Class hierarchy: \MainWP\Dashboard\MainWP_Live_Reports

Tags

None found

Properties

$enabled_pagespeed

$enabled_pagespeed :

Type

— Enabled check for Google Pagespeed.

Tags

static

$enabled_brokenlinks

$enabled_brokenlinks :

Type

— Enabled check for Broken Links Checker.

Tags

static

$buffer

$buffer :

Type

— Sync buffer.

Tags

static

$enabled_piwik

$enabled_piwik :

Type

— Enabled check for piwiki.

Tags

static

$enabled_sucuri

$enabled_sucuri :

Type

— Enabled check for sucuri.

Tags

static

$enabled_ga

$enabled_ga :

Type

— Enabled check for Google Authenticator.

Tags

static

$enabled_aum

$enabled_aum :

Type

— Enabled check for Advanced Uptime Monitor.

Tags

static

$enabled_woocomstatus

$enabled_woocomstatus :

Type

— Enabled check for Woocommerce status extension.

Tags

static

$count_sec_header

$count_sec_header :

Type

— Count of header sections.

Tags

static

$count_sec_body

$count_sec_body :

Type

— Count of body sections.

Tags

static

$count_sec_footer

$count_sec_footer :

Type

— Count of footer sections.

Tags

static

Methods

__construct()

__construct()

MainWP_Live_Reports constructor.

Run each time the class is called.

init()

init()

Set up constants with default values, unless user overrides.

admin_init()

admin_init()

Initiates the admin page when loaded & sets initial Class Variables.

managesite_backup()

managesite_backup(array  $website, array  $args, array  $information) : mixed

Manage child site backup.

Parameters

array	$website	Child site array.
array	$args	Backup arguments array.
array	$information	Backup status information array.

Returns

mixed —

The filtered value after all hooked functions are applied to it.

managesite_schedule_backup()

managesite_schedule_backup(array  $website, array  $args, string  $backupResult) : boolean

Manage child site schedualed backups.

Parameters

array	$website	Child site.
array	$args	Backup type. full\|db.
string	$backupResult	Backup results. error\|success.

Returns

boolean —

true|false Stores in class variables.

mainwp_postprocess_backup_sites_feedback()

mainwp_postprocess_backup_sites_feedback(array  $output, mixed  $unique) : string

Child sites backup post process feedback.

Parameters

array	$output	Feedback output key.
mixed	$unique	Unique ID.

Returns

string —

$output Post process feedback.

cal_schedule_nextsend()

cal_schedule_nextsend(mixed  $schedule, mixed  $start_recurring_date, integer|string  $scheduleLastSend) : string

Schedule when to send the next report.

Parameters

mixed	$schedule	Schedule type. Options are: daily, weekly, biweekly, monthly, quarterly, twice_a_year.
mixed	$start_recurring_date	Recuring report start date.
integer\|string	$scheduleLastSend	0\|start_recurring_date.

Returns

string —

$next_report_date_to Date to send next report.

calc_next_schedule_send_date()

calc_next_schedule_send_date(mixed  $recurring_date, mixed  $lastSend, integer  $monthSteps) : string

Calculate next schedualed send date.

Parameters

mixed	$recurring_date	Schedualed recurring start date & time.
mixed	$lastSend	Date & time of last sent report.
integer	$monthSteps	Number of months to use in calculation. Options: 3\|6\|12.

Returns

string —

When to send next report. Returns a timestamp on success. FALSE on failure 2020-month-day 23:59:59 ( Y-m-d 23:59:59 ).

save_report()

save_report() : array|null

Save client report.

Returns

array|null —

$return Response array on success or null on failure.

delete_attach_files()

delete_attach_files(array  $files, mixed  $dir) : boolean

Delete attatched files.

Parameters

array	$files	Array of files to delete.
mixed	$dir	Directory files are located.

Returns

boolean —

Returns TRUE on success or FALSE on failure.

handle_upload_files()

handle_upload_files(mixed  $file_input, mixed  $dest_dir) : array

Upload files handler.

Parameters

mixed	$file_input	File to upload.
mixed	$dest_dir	Destination directory.

Returns

array —

$output Array of results.

gen_report_content()

gen_report_content(array  $reports, boolean  $combine_report = false) : string

Generate report content.

Parameters

array	$reports	Reports data.
boolean	$combine_report	Whether or not to combine the reports. Default: false.

Returns

string —

Report content HTML.

do_filter_content()

do_filter_content(mixed  $content) : mixed

Filter content.

Parameters

mixed

$content

Content to filter.

Returns

mixed —

$content Return the same content.

filter_report()

filter_report(array  $report, array  $allowed_tokens) : array

Filter report.

Parameters

array	$report	Report data.
array	$allowed_tokens	Allowed report tokens.

Returns

array —

$filtered_reports Array of filtered reports.

filter_report_website()

filter_report_website(array  $report, object  $website, array  $allowed_tokens = array()) : array

Filter child site report.

Parameters

array	$report	Report data.
object	$website	Child site data.
array	$allowed_tokens	Allowed report tokens.

Returns

array —

$output Filtered child site report.

section_mark_header()

section_mark_header(array  $matches) : string

Header section.

Parameters

array

$matches

Matches.

Returns

string —

Report Header html.

section_mark_body()

section_mark_body(array  $matches) : string

Report body section.

Parameters

array

$matches

Matches.

Returns

string —

Report Body html.

section_mark_footer()

section_mark_footer(array  $matches) : string

Report footer section.

Parameters

array

$matches

Matches.

Returns

string —

Report footer html.

sucuri_scan_done()

sucuri_scan_done(integer  $website_id, mixed  $scan_status, array  $data) : mixed

Sucuri scan content.

Parameters

integer	$website_id	Child site ID.
mixed	$scan_status	Sucuri scan status.
array	$data	Scan data.

Returns

mixed —

The filtered value after all hooked functions are applied to it.

replace_content()

replace_content(mixed  $content, mixed  $tokens, mixed  $replace_tokens) : string

Replace report content.

Parameters

mixed	$content	Content to replace.
mixed	$tokens	Tokens to replace.
mixed	$replace_tokens	Token replacing with.

Returns

string —

$content This function returns a string or an array with the replaced values.

replace_section_content()

replace_section_content(mixed  $content, mixed  $tokens, mixed  $replace_tokens) : string

Replace section content.

Parameters

mixed	$content	Content to replace.
mixed	$tokens	Tokens to replace.
mixed	$replace_tokens	Token replacing with.

Returns

string —

This function returns a string with the replaced values.

parse_report_content()

parse_report_content(array  $content, array  $replaceTokensValues, array  $allowed_tokens) : array

Parse report content.

Parameters

array	$content	Report content to parse.
array	$replaceTokensValues	Tokens to replace.
array	$allowed_tokens	Allowed tokens.

Returns

array —

This function returns an array with the replaced values.

remove_section_tokens()

remove_section_tokens(array  $content) : array

Remove section tokens.

Parameters

array

$content

Report content.

Returns

array —

This function returns an array with the removed values.

ga_data()

ga_data(integer  $site_id, mixed  $start_date, mixed  $end_date, boolean  $chart = false) : array

Method ga_data()

Google Analytics data.

Parameters

integer	$site_id	Child site ID.
mixed	$start_date	Report shorraytart date.
mixed	$end_date	Report end date.
boolean	$chart	Whether or not to show the data chart. Default: false.

Returns

array —

$output This function returns an array with the google analytics data.

piwik_data()

piwik_data(integer  $site_id, mixed  $start_date, mixed  $end_date) : array|boolean

Piwiki report data.

Parameters

integer	$site_id	Child site ID.
mixed	$start_date	Report Start date.
mixed	$end_date	Report End date.

Returns

array|boolean —

$output This function returns an array of data or FALSE on failer.

aum_data()

aum_data(integer  $site_id, mixed  $start_date, mixed  $end_date) : array|boolean

Advanced Uptime Monitor report data.

Parameters

integer	$site_id	Child site ID.
mixed	$start_date	Report start date.
mixed	$end_date	Report end date.

Returns

array|boolean —

$output This function returns an array of data or FALSE on failer.

woocomstatus_data()

woocomstatus_data(integer  $site_id, mixed  $start_date, mixed  $end_date) : array|boolean

Woocomerce status report data.

Parameters

integer	$site_id	Child site ID.
mixed	$start_date	Report start date.
mixed	$end_date	Report end date.

Returns

array|boolean —

$output This function returns an array of data or FALSE on failer.

pagespeed_tokens()

pagespeed_tokens(integer  $site_id, mixed  $start_date, mixed  $end_date) : array|boolean

Method pagespeed_tokens()

Google pagespeed tokens report data.

Parameters

integer	$site_id	Child site ID.
mixed	$start_date	Report Start date.
mixed	$end_date	Report End date.

Returns

array|boolean —

$data This function returns an array of data or FALSE on failer.

brokenlinks_tokens()

brokenlinks_tokens(integer  $site_id, mixed  $start_date, mixed  $end_date) : array|boolean

Broken links report data.

Parameters

integer	$site_id	Child site ID.
mixed	$start_date	Report Start date.
mixed	$end_date	Report End date.

Returns

array|boolean —

$data This function returns an array of data or FALSE on failer.

sec2hms()

sec2hms(integer  $sec, boolean  $padHours = false) : string

Convert seconds to Hours:Minutes.

Parameters

integer	$sec	Time in seconds.
boolean	$padHours	Hpurs to pad.

Returns

string —

$hms Time in Hours:Minutes.

fetch_stream_data()

fetch_stream_data(object  $website, array  $report, array  $sections, array  $tokens) : array

Method fetch_stream_data()

Parameters

object	$website	Child Site data.
array	$report	Report data.
array	$sections	Sections to show.
array	$tokens	Tokens to show.

Returns

array —

$information or error.

manage_site_token()

manage_site_token(object  $site)

Manage child site report data.

Parameters

object

$site

Object containing the website information.

update_site_update_tokens()

update_site_update_tokens(integer  $websiteId)

Update child site report update data.

Parameters

integer

$websiteId

Child site ID.

delete_site_delete_tokens()

delete_site_delete_tokens(object  $website)

Delete child site delete tokens.

Parameters

object

$website

Object containing the website information.

format_stats_values()

format_stats_values(string  $value, boolean  $round = false, boolean  $perc = false, boolean  $showAsTime = false) : string

Format stats values.

Parameters

string	$value	Value to format.
boolean	$round	Whether to round. Default: false.
boolean	$perc	Whether to conver to percentage. Default: false.
boolean	$showAsTime	Whether to convert to time. Default: false.

Returns

string —

$value Converted value.