MainWP Code Reference
\
MainWP
Child
Dashboard
Module
ApiBackups
CostTracker
Log

\MainWP\ChildMainWP_Client_Report

Class MainWP_Client_Report

MainWP Client Reports extension handler.

Summary

Methods
Properties
Constants
get_class_name()
instance()
get_compatible_context()
get_connector_by_compatible_context()
get_compatible_action()
get_stream_get_params()
get_stream_others_tokens()
get_stream_sections_data()
get_other_tokens_data()
get_section_loop_data()
get_section_loop_records()
is_backup_action()
get_section_token_value()
get_stream_meta_data()
wfc_getblockedcount()
wfc_getissuecount()
ithemes_query_events_count()
ithemes_get_lockouts()
__construct()
init()
current_agent()
sync_others_data()
do_reports_log()
action()
save_sucuri_stream()
save_backup_stream()
get_stream()
set_showhide()
creport_init()
hide_update_notice()
remove_update_nag()
creport_branding_plugin()
creport_remove_menu()
$instance
$date_from
$date_to
No constants found
No protected methods found
No protected properties found
N/A
get_stream_get_not_in_params()
get_other_tokens_count()
get_section_loop_token_values()
get_author_data_token_value()
get_result_data_token_value()
get_sucuri_scan_token_value()
get_mainwp_maintenance_token_value()
No private properties found
N/A

Properties

$instance

$instance : mixed

Public static variable to hold the single instance of the class.

Type

mixed — Default null

$date_from

$date_from : integer

Static variable to hold date from.

Type

integer

$date_to

$date_to : integer

Static variable to hold date to.

Type

integer

Methods

get_class_name()

get_class_name() : string

Method get_class_name()

Get class name.

Returns

string —

CLASS Class name.

get_compatible_context()

get_compatible_context(string  $context) : string

Convert context name of tokens to context name saved in child reports.

Parameters

string $context

Context name to be converted.

Returns

string —

$context Converted context name.

get_connector_by_compatible_context()

get_connector_by_compatible_context(string  $context) : string

Get connector by compatible context.

Parameters

string $context

Context name as reference.

Returns

string —

$connector Required connector.

get_compatible_action()

get_compatible_action(string  $action, string  $context = '') : string

Get compatible action by context.

Parameters

string $action

Action name as reference.
string $context

Context name as reference.

Returns

string —

$action Compatible action.

get_stream_get_params()

get_stream_get_params(array  $other_tokens, array  $sections) : array

Get the Stream parameters.

Parameters

array $other_tokens

An array containing other tokens.
array $sections

An array containing sections.

Returns

array —

Arguments array.

get_stream_others_tokens()

get_stream_others_tokens(array  $records, array  $other_tokens, array  $skip_records) : array

Get the Stream other tokens.

Parameters

array $records

An array containg actions records.
array $other_tokens

An array containing other tokens.
array $skip_records

An array containing skipped records.

Returns

array —

Other tokens data.

get_stream_sections_data()

get_stream_sections_data(array  $records, array  $sections, array  $skip_records) : array

Get the Stream sections data.

Parameters

array $records

An array containg actions records.
array $sections

An array containing sections.
array $skip_records

An array containing skipped records.

Returns

array —

Sections data.

get_other_tokens_data()

get_other_tokens_data(array  $records, array  $tokens, array  $skip_records) : array

Get the other tokens data.

Parameters

array $records

An array containg actions records.
array $tokens

An array containg the tokens list.
array $skip_records

An array containg records to skip.

Returns

array —

An array containg the tokens values.

get_section_loop_data()

get_section_loop_data(object  $records, array  $tokens, string  $section, array  $skip_records = array()) : array

Get the section loop data.

Parameters

object $records

Object containng reports records.
array $tokens

An array containing report tokens.
string $section

Section name.
array $skip_records

Records to skip.

Returns

array —

Section loop records.

get_section_loop_records()

get_section_loop_records(object  $records, array  $tokens, string  $connector, string  $context, string  $action, array  $skip_records) : array

Get the section loop records.

Parameters

object $records

Object containng reports records.
array $tokens

An array containing report tokens.
string $connector

Record connector.
string $context

Record context.
string $action

Record action.
array $skip_records

Records to skip.

Returns

array —

Loops.

is_backup_action()

is_backup_action(string  $action) : boolean

Check if it's backup action.

Parameters

string $action

Record action.

Returns

boolean —

If backup action, return trie, if not, false.

get_section_token_value()

get_section_token_value(object  $record, string  $data, string  $context, string  $token) : array

Get the section token value.

Parameters

object $record

Object containing the record data.
string $data

Data to process.
string $context

Record context.
string $token

Requested token.

Returns

array —

Token value.

get_stream_meta_data()

get_stream_meta_data(object  $record, string  $data) : string

Get the Stream meta data for a certain record.

Parameters

object $record

Object containing the record data.
string $data

Data to process.

Returns

string —

Return the meta data value.

wfc_getblockedcount()

wfc_getblockedcount(string  $grouping = null) : array

Method wfc_getblockedcount()

Get the number of blocked attackes.

Parameters

string $grouping

Contains the grouping blocked attacks to count blocked attacks.

Returns

array —

Action result.

wfc_getissuecount()

wfc_getissuecount() : array

Method wfc_getissuecount()

Get the issues found in most recent scan.

Returns

array —

Action result.

ithemes_query_events_count()

ithemes_query_events_count(string  $event = 'blocked') : array

Method ithemes_getEventsCount()

Get the number of Events.

Parameters

string $event

event to count.

Returns

array —

Action result.

ithemes_get_lockouts()

ithemes_get_lockouts(string  $type = 'all', array  $args = array()) : array

Shows all lockouts currently in the database.

Parameters

string $type

'all', 'host', 'user' or 'username'.
array $args

Additional arguments.

Returns

array —

all lockouts in the system

__construct()

__construct()

MainWP_Client_Report constructor.

Run any time class is called.

init()

init()

Initiate Client report

current_agent()

current_agent(string  $agent) : string

Get current user agent.

Parameters

string $agent

User agent.

Returns

string —

$agent Current user agent.

sync_others_data()

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

Sync others data.

Parameters

array $information

Holder for returned data.
array $data

Data to sync.

Returns

array —

$information Synced data.

do_reports_log()

do_reports_log(string  $ext = '')

Create reports log file.

Parameters

string $ext

File extension.

action()

action()

Actions: save_sucuri_stream, save_backup_stream, get_stream, set_showhide.

save_sucuri_stream()

save_sucuri_stream() : boolean

Save sucuri stream.

Returns

boolean —

true|false.

save_backup_stream()

save_backup_stream() : boolean

Save backup stream.

Returns

boolean —

true|false.

get_stream()

get_stream() : array

Get stream.

Returns

array —

$information Stream array.

set_showhide()

set_showhide() : array

Set Branding Show/Hide.

Returns

array —

$information Results array.

creport_init()

creport_init()

Initiate Client Reports.

hide_update_notice()

hide_update_notice(array  $slugs) : array

Hide the MainWP Child Reports plugin update notice.

Parameters

array $slugs

An array containing slugs to hide.

Returns

array —

Updated array containing slugs to hide.

remove_update_nag()

remove_update_nag(string  $value) : string

Remove update nag.

Parameters

string $value

Value to remove.

Returns

string —

Response.

creport_branding_plugin()

creport_branding_plugin(array  $plugins) : array

Client Reports Branding plugin.

Parameters

array $plugins

Plugins array.

Returns

array —

Plugins array.

creport_remove_menu()

creport_remove_menu()

Client Remove Menu.

get_stream_get_not_in_params()

get_stream_get_not_in_params(array  $sections, array  $other_tokens) : boolean

Get the Stream excluded parameters.

Parameters

array $sections

An array containing sections.
array $other_tokens

An array containing other tokens.

Returns

boolean —

true|false

get_other_tokens_count()

get_other_tokens_count(object  $records, string  $connector, string  $context, string  $action, array  $skip_records, array  $backups_created_time_to_fix) : integer

Get the other tokens count.

Parameters

object $records

Object containng reports records.
string $connector

Record connector.
string $context

Record context.
string $action

Record action.
array $skip_records

Records to skip.
array $backups_created_time_to_fix

Backups created time.

Returns

integer —

The count number.

get_section_loop_token_values()

get_section_loop_token_values(object  $record, string  $context, array  $tokens) : array

Get the section loop token values.

Parameters

object $record

Object containing the record data.
string $context

Record context.
array $tokens

An array containg the report tokens.

Returns

array —

Token values.

get_author_data_token_value()

get_author_data_token_value(object  $record, string  $connector, string  $context, string  $data) : string

Get the author data token value.

Parameters

object $record

Object containing the record data.
string $connector

Record connector.
string $context

Record context.
string $data

Data to process.

Returns

string —

Author data token value.

get_result_data_token_value()

get_result_data_token_value(object  $record, string  $context, string  $data) : string

Get the result data token value.

Parameters

object $record

Object containing the record data.
string $context

Record context.
string $data

Data to process.

Returns

string —

Result data token value.

get_sucuri_scan_token_value()

get_sucuri_scan_token_value(object  $record, string  $data) : string

Get the Sucuri scan token value.

Parameters

object $record

Object containing the record data.
string $data

Data to process.

Returns

string —

Sucuri scan token value.

get_mainwp_maintenance_token_value()

get_mainwp_maintenance_token_value(object  $record, string  $data) : string

Get the Maintanence token value.

Parameters

object $record

Object containing the record data.
string $data

Data to process.

Returns

string —

Maintanence token value.