SLP_Settings_Group
extends SLPlus_BaseClass_Object
in package
Groups are collections of individual settings (items).
Table of Contents
Properties
- $div_group : string
- $div_group : mixed
- $header : string
- $header : mixed
- $intro : string
- $intro : mixed
- $items : array<string|int, SLP_Settings_default>
- $items : mixed
- $SLP_Settings : mixed
- $slplus : SLPlus
- $slug : string
- $slug : mixed
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- add_item() : mixed
- Add an item to the group.
- display() : mixed
- Output the group.
- get_instance() : SLPlus_BaseClass_Object
- 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.
- display_header() : mixed
- Output the group header.
- get_object_definition() : string
- Load a class file if it exists for the item type.
- get_type() : string
- Map old types to new ones and set default to 'custom' if not set.
Properties
$div_group
public
string
$div_group
the div group we belong in
$div_group
public
mixed
$div_group
$header
public
string
$header
the header
$header
public
mixed
$header
$intro
public
string
$intro
the starting text
$intro
public
mixed
$intro
$items read-only
public
array<string|int, SLP_Settings_default>
$items
$items
public
mixed
$items
$SLP_Settings
public
mixed
$SLP_Settings
$slplus
public
SLPlus
$slplus
$slug
public
string
$slug
the slug
$slug
public
mixed
$slug
$uses_slplus
public
bool
$uses_slplus
Set to true (default) if the object needs access to the SLPlus plugin object.
$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()
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
booladd_item()
Add an item to the group.
public
add_item(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
display()
Output the group.
public
display() : mixed
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_Objectset_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
display_header()
Output the group header.
private
display_header() : mixed
get_object_definition()
Load a class file if it exists for the item type.
private
get_object_definition(string $type) : string
Parameters
- $type : string
Return values
stringget_type()
Map old types to new ones and set default to 'custom' if not set.
private
get_type( $params) : string