\MainWP\Dashboard\Module\LogConnector_User

Class Connector_User

Summary

Methods
Properties
Constants
is_registered()
register()
callback()
log()
get_changed_keys()
get_label()
get_action_labels()
get_context_labels()
callback_mainwp_user_action()
$name
$actions
No constants found
sanitize_data()
No protected properties found
N/A
No private methods found
$is_registered
N/A

Properties

$name

$name : string

Connector slug

Type

string

$actions

$actions : array

Actions registered for this connector

Type

array

$is_registered

$is_registered : boolean

Holds connector registration status flag.

Type

boolean

Methods

is_registered()

is_registered() : boolean

Is the connector currently registered?

Returns

boolean

register()

register() 

Register all context hooks

callback()

callback() 

Callback for all registered hooks throughout Log Looks for a class method with the convention: "callback_{action name}"

log()

log(string  $message, array  $args, integer  $site_id, string  $context, string  $action, integer|null  $state = null, integer  $user_id = null) : boolean

Log handler

Parameters

string $message

sprintf-ready error message string.

array $args

sprintf (and extra) arguments to use.

integer $site_id

Target site id.

string $context

Context of the event.

string $action

Action of the event.

integer|null $state

action status: null - N/A, 0 - failed, 1 - success.

integer $user_id

User responsible for the event.

Returns

boolean

get_changed_keys()

get_changed_keys(mixed  $old_value, mixed  $new_value, boolean|integer  $deep = false) : array

Compare two values and return changed keys if they are arrays

Parameters

mixed $old_value

Value before change.

mixed $new_value

Value after change.

boolean|integer $deep

Get array children changes keys as well, not just parents.

Returns

array

get_label()

get_label() : string

Return translated connector label

Returns

string —

Translated connector label

get_action_labels()

get_action_labels() : array

Return translated action term labels

Returns

array —

Action terms label translation

get_context_labels()

get_context_labels() : array

Return translated context labels

Returns

array —

Context label translations

callback_mainwp_user_action()

callback_mainwp_user_action(object  $website, string  $pAction, array  $data, mixed  $extra = array(), boolean  $optimize = false) 

Log user actions.

Parameters

object $website

website data.

string $pAction

post action.

array $data

data array.

mixed $extra

extra info.

boolean $optimize

true|false optimize big site or not.

sanitize_data()

sanitize_data(array  $data) : array

Handle sanitize POST data.

Parameters

array $data

input data.

Returns

array