SLP® phpDocs

SLP_REST_Environment extends SLPlus_BaseClass_Object
in package

Handle the Environment apiGroup endpoints

Read the REST API documentation for more details.

Table of Contents

Properties

$addon  : object
$myslp  : MySLP
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$slug  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
get()  : void
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
set_properties()  : mixed
Set our properties.
initialize()  : mixed
Do these things when this object is invoked. Override in your class.
is_cache_expired()  : bool
Return true if the cache is expired.
update_cache_timestamp()  : mixed
Update cache timestamp Note: keep this to cache REST data possibly for News/Docs endpoints

Properties

$uses_myslp

public bool $uses_myslp

Set to true to add a $myslp property pointing to global $myslp

$uses_slplus

public bool $uses_slplus

Set to true (default) if the object needs access to the SLPlus plugin object.

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

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

set_properties()

Set our properties.

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

initialize()

Do these things when this object is invoked. Override in your class.

protected initialize() : mixed

is_cache_expired()

Return true if the cache is expired.

private is_cache_expired() : bool

Note: keep this to cache REST data possibly for News/Docs endpoints

1 H = 3600s

Return values
bool

update_cache_timestamp()

Update cache timestamp Note: keep this to cache REST data possibly for News/Docs endpoints

private update_cache_timestamp() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results