Properties

$mainwp_wpcreport_db_version

$mainwp_wpcreport_db_version : string

Type

string — Wordpress Client Report database version.

$table_prefix

$table_prefix : string

Type

string — Table prefix.

$instance

$instance : null

Type

null — Public static instance.

Methods

__construct()

__construct() 

MainWP_Live_Reports_Responder_DB constructor.

Run each time the class is called. Initialize default tokens upon creation of the object.

table_name()

table_name(mixed  $suffix) : string

Method table_name()

Add suffix to table_prefix.

Parameters

mixed $suffix

Given table suffix.

Returns

string —

Table name.

use_mysqli()

use_mysqli() : \MainWP\Dashboard\(bool)

Method use_mysqli()

Determine whether a $wpdb variable is an instantiated object of mysqli.

Returns

\MainWP\Dashboard\(bool) —

Return true on seuccess and false on failer.

install()

install() : \MainWP\Dashboard\(int|\MainWP\Dashboard\false)

Method install()

Create database structure.

Returns

\MainWP\Dashboard\(int|\MainWP\Dashboard\false) —

Return report ID on success and false on failer.

get_instance()

get_instance() : void

Method get_instance()

Create a new public static instance of MainWP_Live_Reports_Responder_DB().

add_token()

add_token(array  $token) : \MainWP\Dashboard\(int|\MainWP\Dashboard\bool)

Method add_token()

Add Report token.

Parameters

array $token

Token Array.

Returns

\MainWP\Dashboard\(int|\MainWP\Dashboard\bool) —

Return int Token ID on success and false on failer.

update_token()

update_token(mixed  $id, mixed  $token) : \MainWP\Dashboard\(int|\MainWP\Dashboard\bool)

Method update_token()

Update report token.

Parameters

mixed $id

Report ID.

mixed $token

Token ID.

Returns

\MainWP\Dashboard\(int|\MainWP\Dashboard\bool) —

Return int token ID or false on failer.

get_tokens_by()

get_tokens_by(string  $by = 'id', null  $value = null, string  $site_url = '') : \MainWP\Dashboard\(array|object|null|\MainWP\Dashboard\void)

Method get_tokens_by()

Get report tokens by ID, name or URL.

Parameters

string $by

By token name or token ID. Default: id.

null $value

Token ID.

string $site_url

Child Site URL.

Returns

\MainWP\Dashboard\(array|object|null|\MainWP\Dashboard\void) —

Database query result by token or null on failure

get_tokens()

get_tokens() : \MainWP\Dashboard\(array|object|\MainWP\Dashboard\null)

Method get_tokens()

Get all report tokens.

Returns

\MainWP\Dashboard\(array|object|\MainWP\Dashboard\null) —

Database query results.

get_site_token_values()

get_site_token_values(mixed  $id) : \MainWP\Dashboard\(array|object|\MainWP\Dashboard\null)

Method get_site_token_values()

Get Child site token values.

Parameters

mixed $id

Token ID.

Returns

\MainWP\Dashboard\(array|object|\MainWP\Dashboard\null) —

Database query results.

get_site_tokens()

get_site_tokens(mixed  $site_url, string  $index = 'id') : array

Method get_site_tokens()

Parameters

mixed $site_url

Child Site URL.

string $index

Default: id.

Returns

array —

$return Array of tokens.

get_default_token_site()

get_default_token_site(mixed  $token_name, mixed  $site_url) : \MainWP\Dashboard\(string|\MainWP\Dashboard\bool)

Method get_default_token_site()

Get default Child Site token.

Parameters

mixed $token_name

Token name.

mixed $site_url

Child ite URL.

Returns

\MainWP\Dashboard\(string|\MainWP\Dashboard\bool) —

Return string Child Site name|URL or false on failer.

add_token_site()

add_token_site(mixed  $token_id, mixed  $token_value, mixed  $site_url) : string

Method add_token_site()

Add Child Site token.

Parameters

mixed $token_id

Token ID.

mixed $token_value

Token value.

mixed $site_url

Child Site URL.

Returns

string —

Child Site token value.

update_token_site()

update_token_site(mixed  $token_id, mixed  $token_value, mixed  $site_url) : \MainWP\Dashboard\(string|\MainWP\Dashboard\bool)

Method update_token_site()

Update Child Site token value.

Parameters

mixed $token_id

Token ID.

mixed $token_value

Token value.

mixed $site_url

Child Site URL.

Returns

\MainWP\Dashboard\(string|\MainWP\Dashboard\bool) —

Return token value or false on failer.

delete_site_tokens()

delete_site_tokens(null  $token_id = null, null  $site_url = null) : \MainWP\Dashboard\(int|\MainWP\Dashboard\bool)

Method delete_site_tokens()

Delete Child Site token value.

Parameters

null $token_id

Token ID.

null $site_url

Child SIte URL.

Returns

\MainWP\Dashboard\(int|\MainWP\Dashboard\bool) —

Number of rows affected/selected for all other queries and Boolean true. Boolean false on error.

delete_token_by()

delete_token_by(string  $by = 'id', null  $value = null) : \MainWP\Dashboard\(bool)

Method delete_token_by()

Delete Child Site token by id.

Parameters

string $by

Query type. Default: 'id'.

null $value

Token id.

Returns

\MainWP\Dashboard\(bool) —

Boolean true on success. Boolean false on error.

update_report()

update_report(array  $report) : \MainWP\Dashboard\(string|\MainWP\Dashboard\bool)

Method update_report()

Update Client Report.

Parameters

array $report

Client Report array.

Returns

\MainWP\Dashboard\(string|\MainWP\Dashboard\bool) —

Client Report token value. Boolean false on failer.

get_report_by()

get_report_by(string  $by = 'id', null  $value = null, string  $orderby = null, string  $order = null, object  $output = OBJECT) : \MainWP\Dashboard\(object|\MainWP\Dashboard\bool)

Method get_report_by()

Get Client Report by given query type $by.

Parameters

string $by

Query type. Default: 'id'. Choices: id, client, site, title, all.

null $value

Further variables to substitute into the query's placeholders if being called with individual arguments.

string $orderby

Order By. Default: null. Choices: client, name.

string $order

Order. Default: null. Choices: client, name.

object $output

Report object.

Returns

\MainWP\Dashboard\(object|\MainWP\Dashboard\bool) —

Return Client Report object or false on failer.

get_avail_archive_reports()

get_avail_archive_reports() : \MainWP\Dashboard\(object|\MainWP\Dashboard\bool)

Method get_avail_archive_reports()

Get available achived client reports.

Returns

\MainWP\Dashboard\(object|\MainWP\Dashboard\bool) —

Return Client Report object or false on failer.

get_schedule_reports()

get_schedule_reports() : \MainWP\Dashboard\(object|\MainWP\Dashboard\bool)

Method get_schedule_reports()

Get schedualed client reports.

Returns

\MainWP\Dashboard\(object|\MainWP\Dashboard\bool) —

Return Client Report object or false on failer.

delete_report_by()

delete_report_by(string  $by = 'id', null  $value = null) : \MainWP\Dashboard\(bool)

Method delete_report_by()

Delete Client Report by id.

Parameters

string $by

Query type. Default: 'id'.

null $value

Client Report ID.

Returns

\MainWP\Dashboard\(bool) —

Return true on success and false on failer.

get_clients()

get_clients() : \MainWP\Dashboard\(object|\MainWP\Dashboard\bool)

Method get_clients()

Get all clients.

Returns

\MainWP\Dashboard\(object|\MainWP\Dashboard\bool) —

Return Clients object or false on failer.

get_client_by()

get_client_by(string  $by = 'clientid', null  $value = null) : \MainWP\Dashboard\(array|object|null|\MainWP\Dashboard\void)

Method get_client_by()

Get client by clientid.

Parameters

string $by

Query type. Defualt: 'clientid'.

null $value

Query value placeholder.

Returns

\MainWP\Dashboard\(array|object|null|\MainWP\Dashboard\void) —

Database query result for client or null on failure.

update_client()

update_client(object  $client) : \MainWP\Dashboard\(int|\MainWP\Dashboard\bool)

Method update_client()

Update Client.

Parameters

object $client

Client object.

Returns

\MainWP\Dashboard\(int|\MainWP\Dashboard\bool) —

int Client ID or false on failer.

get_formats()

get_formats(null  $type = null) : \MainWP\Dashboard\(object|\MainWP\Dashboard\bool)

Method get_formats()

Get Client Report format.

Parameters

null $type

Format type.

Returns

\MainWP\Dashboard\(object|\MainWP\Dashboard\bool) —

Return report format object or false on failer.

get_format_by()

get_format_by(string  $by, mixed  $value, null  $type = null) : \MainWP\Dashboard\(array|object|null|\MainWP\Dashboard\void)

Method get_format_by()

Get Client Report format by.

Parameters

string $by

Query type. id|title.

mixed $value

Id or title to grab.

null $type

format type. Default: null as query placeholder.

Returns

\MainWP\Dashboard\(array|object|null|\MainWP\Dashboard\void) —

Database query result or null on failure.

update_format()

update_format(object  $format) : \MainWP\Dashboard\(int|\MainWP\Dashboard\false)

Method update_format()

Update Client Report format.

Parameters

object $format

Client Report format object.

Returns

\MainWP\Dashboard\(int|\MainWP\Dashboard\false) —

The number of rows inserted, or false on error.

delete_format_by()

delete_format_by(string  $by = 'id', null  $value = null) : \MainWP\Dashboard\(bool)

Method delete_format_by()

Delete Client Report format by id.

Parameters

string $by

Query type. Default: 'id'.

null $value

Query value placeholder.

Returns

\MainWP\Dashboard\(bool) —

Return true on success and false on failer.

query()

query(mixed  $sql) : \MainWP\Dashboard\(bool|\MainWP\Dashboard\object)

Method query()

SQL Query.

Parameters

mixed $sql

Given SQL Query.

Returns

\MainWP\Dashboard\(bool|\MainWP\Dashboard\object) —

Returns false on failure. For successful SELECT, SHOW, DESCRIBE or EXPLAIN queries mysqli_query() will return a mysqli_result object. For other successful queries mysqli_query() will return TRUE.

m_query()

m_query(mixed  $query, mixed  $link) : \MainWP\Dashboard\(bool)

Method m_query()

MySQLi or MySQL Query.

Parameters

mixed $query

SQL query.

mixed $link

mysqli_connect link.

Returns

\MainWP\Dashboard\(bool) —

Returns false on failure. For successful SELECT, SHOW, DESCRIBE or EXPLAIN queries mysqli_query() will return a mysqli_result object. For other successful queries mysqli_query() will return true.

fetch_object()

fetch_object(object  $result) : \MainWP\Dashboard\(object|\MainWP\Dashboard\null)

Method fetch_object(

MySQLi Query.

Parameters

object $result

SQL Query.

Returns

\MainWP\Dashboard\(object|\MainWP\Dashboard\null) —

Returns an object with string properties that corresponds to the fetched row or null if there are no more rows in resultset.

free_result()

free_result(object  $result) : \MainWP\Dashboard\(bool)

Method free_result()

Parameters

object $result

SQL Query.

Returns

\MainWP\Dashboard\(bool) —

Returns true on success or false on failure.

data_seek()

data_seek(mixed  $result, mixed  $offset) : \MainWP\Dashboard\(bool)

Method data_seek()

Data Seek.

Parameters

mixed $result

Required. Specifies a result set identifier returned by mysqli_query(), mysqli_store_result() or mysqli_use_result()

mixed $offset

Required. Specifies the field offset. Must be between 0 and the total number of rows - 1.

Returns

\MainWP\Dashboard\(bool) —

Returns true on success or false on failure.

fetch_array()

fetch_array(mixed  $result, null  $result_type = null) : array

Method fetch_array()

Fetch array.

Parameters

mixed $result

Required. Specifies which data pointer to use. The data pointer is the result from the mysql_query() function

null $result_type

Optional. Specifies what kind of array to return. Placeholder: null.

Returns

array —

The array that was fetched.

num_rows()

num_rows(mixed  $result) : \MainWP\Dashboard\(int|\MainWP\Dashboard\bool)

Method num_rows()

Num Rows.

Parameters

mixed $result

Returns

\MainWP\Dashboard\(int|\MainWP\Dashboard\bool) —

The number of rows in a result set on success or false on failure.

is_result()

is_result(mixed  $result) : boolean

Method is_result()

Is result.

Parameters

mixed $result

SQL Result.

Returns

boolean —

Returns TRUE if var is a resource, FALSE otherwise.

get_results_result()

get_results_result(mixed  $sql) : \MainWP\Dashboard\(array|object|\MainWP\Dashboard\null)

Method get_results_result()

Get results result.

Parameters

mixed $sql

SQL query.

Returns

\MainWP\Dashboard\(array|object|\MainWP\Dashboard\null) —

Database query results.

escape()

escape(mixed  $data) : \MainWP\Dashboard\(string|\MainWP\Dashboard\bool)

Method escape()

Escape the given data.

Parameters

mixed $data

Given data.

Returns

\MainWP\Dashboard\(string|\MainWP\Dashboard\bool) —

Escaped data or false on failer.