MySLP_Settings_History_Dashboard
extends SLP_Base_ReactObject
in package
Represents the settings history dashboard for the MySLP plugin.
Extends the base React object to provide functionality specific to rendering the settings history component.
Table of Contents
Properties
- $addon : object
- $buildDir : string
- $buildURL : string
- $myslp : MySLP
- $scriptAssetFile : string
- $scriptFile : string
- $scriptURL : string
- $slplus : SLPlus
- $uses_myslp : bool
- $uses_slplus : bool
- $pageName : mixed
- $pluginDir : mixed
- $pluginURL : mixed
- $scriptFilebase : mixed
- $scriptHandle : mixed
- $slug : mixed
- $wrapper_class : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- get_instance() : static
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- render() : void
- Render admin page - default can be overriden.
- set_properties() : void
- Set our properties.
- enqueueReact() : void
- Things we normally want to do before each render
- get_vars_for_react() : array<string|int, mixed>
- Retrieves variables for use in a React application.
- initialize() : void
- On invocation
Properties
$addon
public
object
$addon
$buildDir read-only
public
string
$buildDir
The build directory where the React script lives.
$buildURL read-only
public
string
$buildURL
The build URL where the React script lives.
$myslp
public
MySLP
$myslp
$scriptAssetFile read-only
public
string
$scriptAssetFile
The fully qualified file name for the React script supporting an asset PHP file.
$scriptFile read-only
public
string
$scriptFile
The fully qualified file name for the React script.
$scriptURL read-only
public
string
$scriptURL
The URL for the React script.
$slplus
public
SLPlus
$slplus
$uses_myslp
public
bool
$uses_myslp
Set to true to add a $myslp property pointing to global $myslp
$uses_slplus
public
bool
$uses_slplus
Default false try to use SLPlus::get_instance() legacy models that use $this->slplus must set this to true.
$pageName
protected
mixed
$pageName
= 'Settings History'
$pluginDir
protected
mixed
$pluginDir
= \MYSLP_PLUGIN_DIR
$pluginURL
protected
mixed
$pluginURL
= \MYSLP_URL
$scriptFilebase
protected
mixed
$scriptFilebase
= 'settings_history'
$scriptHandle
protected
mixed
$scriptHandle
= 'settings_history'
$slug
protected
mixed
$slug
$wrapper_class
protected
mixed
$wrapper_class
= 'react-wrapper settings-history-component'
Methods
__construct()
public
__construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
__get()
public
__get(string $property) : SLPlus_BaseClass_Object
Parameters
- $property : string
Return values
SLPlus_BaseClass_Object__isset()
public
__isset(string $property) : bool
Parameters
- $property : string
Return values
boolget_instance()
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
public
static get_instance([bool $no_global = false ][, mixed $params = array() ]) : static
Parameters
- $no_global : bool = false
-
set to true to skip assigning object to SLP global as a property.
- $params : mixed = array()
-
object init params
Return values
staticrender()
Render admin page - default can be overriden.
public
render() : void
Provide the DOM element where the React app will render: slp-full-page-react-app
set_properties()
Set our properties.
public
set_properties([array<string|int, mixed> $options = array() ]) : void
Parameters
- $options : array<string|int, mixed> = array()
enqueueReact()
Things we normally want to do before each render
protected
enqueueReact() : void
get_vars_for_react()
Retrieves variables for use in a React application.
protected
get_vars_for_react() : array<string|int, mixed>
Return values
array<string|int, mixed> —The variables passed from the parent method.
initialize()
On invocation
protected
initialize() : void