Store Locator Plus®

SLP_Admin_Settings extends SLP_Object_With_Objects
in package

Store Locator Plus Admin Settings tab.

Table of Contents

Properties

$class_prefix  : string
$dir  : mixed
$dir  : string
$group_params  : array<string|int, mixed>
$map_languages  : array<string|int, string>
$objects  : array<string|int, mixed>
$option_cache  : array<string|int, string>
$Settings  : SLP_Settings
$slplus  : SLPlus
$update_info  : array<string|int, string>
$uses_slplus  : bool
$class_prefix  : mixed
$objects  : mixed
$slplus  : mixed
$uses_slplus  : mixed
$group_params  : mixed
$map_languages  : mixed
$update_info  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
add_map()  : mixed
Add the map tab to the admin settings page.
add_object()  : mixed
add_results()  : mixed
Add the results admin tab.
add_search()  : mixed
Add the admin Search tab
add_tools()  : mixed
Tools
add_view()  : mixed
View
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.
initialize()  : mixed
Setup the group params at startup.
instantiate()  : null|object
Instantiate an object of the noted class.
save_options()  : mixed
Save the options to the WP database options table.
set_properties()  : mixed
Set our properties.
at_startup()  : mixed
Things to do at startup after this baby is initialized. Override in your class.
set_default_object_options()  : mixed
Set our object options.
add_map_functionality()  : mixed
Map / Functionality
add_search_appearance()  : mixed
Search / Appearance
add_search_functionality()  : mixed
Search / Functionality
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.
save_custom_css()  : mixed
Save or update custom CSS
set_map_languages()  : mixed
Set the map languages when needed.

Properties

$map_languages read-only

public array<string|int, string> $map_languages

The Map Languages supported by the base plugin.

$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

$update_info read-only

public array<string|int, string> $update_info

A string array store user notify message

$uses_slplus

public bool $uses_slplus

Set to true (default) if the object needs access to the SLPlus plugin object.

$objects

protected mixed $objects = array('Settings' => array('auto_instantiate' => \true, 'subdir' => 'include/module/settings/'))

Methods

__construct()

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

__isset()

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

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

save_options()

Save the options to the WP database options table.

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

set_default_object_options()

Set our object options.

protected set_default_object_options() : mixed

add_map_functionality()

Map / Functionality

private add_map_functionality() : mixed

add_search_appearance()

Search / Appearance

private add_search_appearance() : mixed

add_search_functionality()

Search / Functionality

private add_search_functionality() : 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
string

auto_instantiate()

Any object with auto_instantiate set to true is instantiate during initialization.

private auto_instantiate() : mixed

save_custom_css()

Save or update custom CSS

private save_custom_css() : mixed

Called when "Save Settings" button is clicked

set_map_languages()

Set the map languages when needed.

private set_map_languages() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results