SLP_Admin_General
extends SLP_Object_With_Objects
in package
Store Locator Plus General Settings Interface
Table of Contents
Properties
- $Admin_General_Text : SLP_Admin_General_Text
- $class_prefix : string
- $dir : mixed
- $dir : string
- $Message_Manager : SLP_Message_Manager
- $objects : array<string|int, mixed>
- $Settings : SLP_Settings
- $slplus : SLPlus
- $uses_slplus : bool
- $class_prefix : mixed
- $objects : mixed
- $slplus : mixed
- $uses_slplus : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- add_object() : mixed
- add_premium_subscription_settings() : mixed
- Add Premium Subscription section to settings page.
- build_admin_tab() : mixed
- Build the admin tab.
- build_app_tab() : mixed
- Build the app (was server) tab.
- build_schedule_tab() : mixed
- Add the schedule messages group.
- build_user_interface_tab() : mixed
- Build the User Settings Panel
- display() : mixed
- Render the map settings admin page.
- 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.
- save_options() : mixed
- Execute the save settings action.
- 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
- Do these things when this object is invoked. Override in your class.
- set_default_object_options() : mixed
- Set our object options.
- add_admin_add_on_packs_group() : mixed
- Add Admin Add On Packs group
- add_admin_locations_group() : mixed
- Add the Admin Locations Group
- add_network_aware_addon_settings() : mixed
- Add on settings with multisite awareness. Display different things depend on the WP mode.
- 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
$Admin_General_Text
public
SLP_Admin_General_Text
$Admin_General_Text
$class_prefix
public
string
$class_prefix
the prefix that goes before all our classes
$dir
public
mixed
$dir
$dir
public
string
$dir
the root directory for this theme
$Message_Manager
public
SLP_Message_Manager
$Message_Manager
$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
$Settings
public
SLP_Settings
$Settings
$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('Admin_General_Text' => array('auto_instantiate' => \true, 'subdir' => 'include/module/admin/'), 'Message_Manager' => array('auto_instantiate' => \true, 'subdir' => 'include/module/message/'), 'Settings' => array('auto_instantiate' => \true, 'subdir' => 'include/module/settings/'))
$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_object()
public
add_object( $object) : mixed
Parameters
add_premium_subscription_settings()
Add Premium Subscription section to settings page.
public
add_premium_subscription_settings(array<string|int, mixed> $group_params) : mixed
Parameters
- $group_params : array<string|int, mixed>
build_admin_tab()
Build the admin tab.
public
build_admin_tab() : mixed
build_app_tab()
Build the app (was server) tab.
public
build_app_tab() : mixed
build_schedule_tab()
Add the schedule messages group.
public
build_schedule_tab(SLP_Settings $settings) : mixed
Parameters
- $settings : SLP_Settings
build_user_interface_tab()
Build the User Settings Panel
public
build_user_interface_tab() : mixed
display()
Render the map settings admin page.
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_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|objectsave_options()
Execute the save settings action.
public
save_options() : mixed
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
initialize()
Do these things when this object is invoked. Override in your class.
protected
initialize() : mixed
set_default_object_options()
Set our object options.
protected
set_default_object_options() : mixed
add_admin_add_on_packs_group()
Add Admin Add On Packs group
private
add_admin_add_on_packs_group(string $section_slug) : mixed
Parameters
- $section_slug : string
add_admin_locations_group()
Add the Admin Locations Group
private
add_admin_locations_group(string $section_slug) : mixed
Parameters
- $section_slug : string
add_network_aware_addon_settings()
Add on settings with multisite awareness. Display different things depend on the WP mode.
private
add_network_aware_addon_settings( $group_params) : mixed
Parameters
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