SLP_Settings_Section
extends SLPlus_BaseClass_Object
in package
Sections are collections of groups.
Table of Contents
Properties
- $auto : bool
- $auto : mixed
- $closing_html : string
- $closing_html : mixed
- $description : string
- $description : mixed
- $div_id : string
- $div_id : mixed
- $first : string
- $first : mixed
- $group_slug : mixed
- $groups : array<string|int, SLP_Settings_Group>
- $groups : mixed
- $innerdiv : bool
- $innerdiv : mixed
- $is_topmenu : bool
- $is_topmenu : mixed
- $name : string
- $name : mixed
- $opening_html : string
- $opening_html : mixed
- $SLP_Settings : mixed
- $slplus : SLPlus
- $slug : string
- $slug : mixed
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : mixed
- $current_div_group : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- add_group() : mixed
- Add a group to the section.
- add_item() : mixed
- Add an item to a section.
- display() : mixed
- Render a section panel.
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- get_params() : array<string|int, mixed>
- Return a named array of our most desired attributes.
- set_properties() : mixed
- Set our properties.
- initialize() : mixed
- Do these things when this object is invoked. Override in your class.
- footer() : mixed
- Render a section footer.
- header() : mixed
- Render a section header.
Properties
$auto
public
bool
$auto
$auto
public
mixed
$auto
= \true
$closing_html
public
string
$closing_html
$closing_html
public
mixed
$closing_html
= ''
$description
public
string
$description
$description
public
mixed
$description
= ''
$div_id
public
string
$div_id
$div_id
public
mixed
$div_id
$first
public
string
$first
True if the first rendered section on the panel.
$first
public
mixed
$first
= \false
$group_slug
public
mixed
$group_slug
$groups
public
array<string|int, SLP_Settings_Group>
$groups
$groups
public
mixed
$groups
$innerdiv
public
bool
$innerdiv
$innerdiv
public
mixed
$innerdiv
= \true
$is_topmenu
public
bool
$is_topmenu
$is_topmenu
public
mixed
$is_topmenu
= \false
$name
public
string
$name
$name
public
mixed
$name
$opening_html
public
string
$opening_html
$opening_html
public
mixed
$opening_html
= ''
$SLP_Settings
public
mixed
$SLP_Settings
$slplus
public
SLPlus
$slplus
$slug
public
string
$slug
The normalized section 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
$current_div_group
private
mixed
$current_div_group
= ''
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_group()
Add a group to the section.
public
add_group(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
add_item()
Add an item to a section.
public
add_item(array<string|int, mixed> $params) : mixed
Parameters
- $params : array<string|int, mixed>
display()
Render a section panel.
public
display() : mixed
Panels are rendered in the order they are put in the stack, FIFO.
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_Objectget_params()
Return a named array of our most desired attributes.
public
get_params() : array<string|int, mixed>
Return values
array<string|int, mixed>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
footer()
Render a section footer.
private
footer() : mixed
header()
Render a section header.
private
header() : mixed