SLP_Object_With_Objects
extends SLPlus_BaseClass_Object
in package
Class SLP_Object_With_Objects
Table of Contents
Properties
- $class_prefix : string
- $dir : string
- $dir : mixed
- $objects : array<string|int, mixed>
- $slplus : SLPlus
- $uses_slplus : bool
- $class_prefix : mixed
- $objects : mixed
- $slplus : mixed
- $uses_slplus : mixed
Methods
- __construct() : mixed
- __get() : mixed
- Get the value, running it through a filter.
- __isset() : bool
- Allow isset to be called on private properties.
- add_object() : mixed
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- instantiate() : null|object
- Instantiate an object of the noted class.
- 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.
- augment_class() : string
- Augment the class names so we can reference simple property names.
- auto_instantiate() : mixed
- Any object with auto_instantiate set to true is instantiate during initialization.
Properties
$class_prefix
public
string
$class_prefix
the prefix that goes before all our classes
$dir
public
string
$dir
the root directory for this theme
$dir
public
mixed
$dir
$objects
public
array<string|int, mixed>
$objects
key = class name, array of attributes() auto_instantiate = true , instantiate the object when this object initializes object = the instantiated object options = default startup options subdir = the subdirectory (from theme root) that contains the class definition
$slplus
public
SLPlus
$slplus
$uses_slplus
public
bool
$uses_slplus
Set to true (default) if the object needs access to the SLPlus plugin object.
$class_prefix
protected
mixed
$class_prefix
$objects
protected
mixed
$objects
= array()
$slplus
protected
mixed
$slplus
$uses_slplus
protected
mixed
$uses_slplus
= \true
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(string $property) : bool
Parameters
- $property : string
Return values
booladd_object()
public
add_object( $object) : mixed
Parameters
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() ]) : SLPlus_BaseClass_Object
TODO: PHP7.4 and PHP8.0 the static instance variable returns an object matching $class TODO: PHP8.1 the static instance continually returns the FIRST object (SLP_Admin_Helper) every time -- it is like PHP8.1 static instance is bound to base_class-object versus the calling class object
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
SLPlus_BaseClass_Objectinstantiate()
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|objectset_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
initialize()
Set the dir property.
protected
initialize() : mixed
set_default_object_options()
Set default options for objects. Override in your class.
protected
set_default_object_options() : mixed
augment_class()
Augment the class names so we can reference simple property names.
private
augment_class(string $class) : string
Parameters
- $class : string
Return values
stringauto_instantiate()
Any object with auto_instantiate set to true is instantiate during initialization.
private
auto_instantiate() : mixed