SLP® phpDocs

Customer_Profile_Invoices extends SLP_Base_ReactObject
in package

Invoices React Block

Table of Contents

Properties

$addon  : object
$buildDir  : string
$buildURL  : string
$myslp  : MySLP
$pageName  : string
$scriptAssetFile  : string
$scriptFile  : string
$scriptURL  : string
$slplus  : SLPlus
$uses_slplus  : bool
$pluginDir  : mixed
$pluginURL  : mixed
$scriptFilebase  : mixed
$scriptHandle  : mixed
$slug  : mixed
$uses_myslp  : bool
$wrapper_class  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
extendReactVars()  : array<string|int, mixed>
Retrieves and modifies variables used for integration with React front-end.
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()  : mixed
Set our properties.
enqueueReact()  : void
Things we normally want to do before each render
get_vars_for_react()  : array<string|int, mixed>
Pass data from PHP to React JavaScript environment.
initialize()  : void
Initializes the necessary hooks and filters for the component.

Properties

$buildDir read-only

public string $buildDir

The build directory where the React script lives.

$pageName

public string $pageName

The page name for React, update with initialize() override.

$scriptAssetFile read-only

public string $scriptAssetFile

The fully qualified file name for the React script supporting asset PHP file.

$scriptFile read-only

public string $scriptFile

The fully qualified file name for the React script.

$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.

Methods

__construct()

public __construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

__isset()

public __isset(string $property) : bool
Parameters
$property : string
Return values
bool

extendReactVars()

Retrieves and modifies variables used for integration with React front-end.

public extendReactVars(mixed $vars) : array<string|int, mixed>

This method extends the parent method by adding additional variables specific to MySLP, including site URL, location count, map view details, and related overage information.

Parameters
$vars : mixed
Return values
array<string|int, mixed> —

An associative array of variables including updated MySLP-specific data.

get_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
static

render()

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() ]) : mixed
Parameters
$options : array<string|int, mixed> = array()

enqueueReact()

Things we normally want to do before each render

protected enqueueReact() : void

get_vars_for_react()

Pass data from PHP to React JavaScript environment.

protected get_vars_for_react() : array<string|int, mixed>

Use this for one-time setup, things that are mostly static in PHP but you need to send to JS.

Return values
array<string|int, mixed>

initialize()

Initializes the necessary hooks and filters for the component.

protected final initialize() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results