SLP® phpDocs

SLP_Object_WithOptions extends SLP_Object_With_Objects
in package

Class SLP_Object_WithOptions

Table of Contents

Properties

$addon  : object
$dir  : mixed
$myslp  : MySLP
$objects  : array<string|int, mixed>
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$class_prefix  : mixed
$option_name  : mixed
$options  : mixed
$slug  : mixed

Methods

__construct()  : mixed
__get()  : mixed
Get the value, running it through a filter.
__isset()  : bool
Allow isset to be called on private properties.
__set()  : SLP_Option|null
Allow value to be set directly.
add_object()  : mixed
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
get_option()  : mixed
Get an option attribute.
instantiate()  : null|object
Instantiate an object of the noted class.
load_options()  : mixed
Grab the specified option from wp_options and put it on top of any default values we've got.
set_option()  : bool
Set an option attribute.
set_properties()  : mixed
Set our properties.
at_startup()  : mixed
Things to do at startup after this baby is initialized. Override in your class.
initialize()  : mixed
Set the dir property.
set_default_object_options()  : mixed
Set default options for objects. Override in your class.

Properties

$objects

public array<string|int, mixed> $objects

key = class name, array of attributes() object = the instantiated object subdir = the subdirectory (from theme root) that contains the class definition

$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()

__get()

Get the value, running it through a filter.

public __get(string $property) : mixed
Parameters
$property : string
Return values
mixed —

null if not set or the value

__isset()

Allow isset to be called on private properties.

public __isset(mixed $property) : bool
Parameters
$property : mixed
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

get_option()

Get an option attribute.

public get_option(string $property, string $attribute) : mixed
Parameters
$property : string
$attribute : string

instantiate()

Instantiate an object of the noted class.

public instantiate(string $class[, array<string|int, mixed> $options = array() ]) : null|object
Parameters
$class : string
$options : array<string|int, mixed> = array()
Return values
null|object

load_options()

Grab the specified option from wp_options and put it on top of any default values we've got.

public load_options() : mixed

set_option()

Set an option attribute.

public set_option(string $property, string $attribute, mixed $value) : bool
Parameters
$property : string
$attribute : string
$value : mixed
Return values
bool

set_properties()

Set our properties.

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

at_startup()

Things to do at startup after this baby is initialized. Override in your class.

protected at_startup() : mixed

NOTE: this will not run at initialization if $this->objects is empty.

initialize()

Set the dir property.

protected initialize() : mixed

Fires from \SLPlus_BaseClass_Object::__construct

set_default_object_options()

Set default options for objects. Override in your class.

protected set_default_object_options() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results