SLP® phpDocs

SLP_SmartOptions extends SLPlus_BaseClass_Object
in package

Smart Options setup defines user settings and manages event triggers.

The Smart Options is an object that defines the user settings for Store Locator Plus. It helps define properties that are used to render the administrative UI, default values, and the behavior of the setting throughout the application.

Does things like execute functions when a value changes, set defaults.

The options management for the base plugin (replaces SLPlus->options / SLPlus->options_nojs)

Table of Contents

Properties

$active_style_css  : mixed
$add_tel_to_phone  : mixed
$addon  : object
$address_placeholder  : mixed
$admin_notice_dismissed  : mixed
$ajax_orderby_catcount  : mixed
$append_to_search  : mixed
$bubblelayout  : mixed
$default_country  : mixed
$default_icons  : mixed
$delete_history_before_this_date  : mixed
$distance_unit  : mixed
$dropdown_style  : mixed
$email_link_format  : mixed
$first_entry_for_radius_selector  : mixed
$force_load_js  : mixed
$google_geocode_key  : mixed
$google_map_style  : mixed
$google_server_key  : mixed
$has_been_setup  : mixed
$hide_address_entry  : mixed
$hide_bubble  : mixed
$hide_distance  : mixed
$hide_empty  : mixed
$hide_map  : mixed
$hide_radius_selections  : SLP_Option
$hide_radius_selector  : mixed
$hide_search_form  : mixed
$highlight_uncoded  : SLP_Option
$immediately_show_locations  : mixed
$initial_radius  : mixed
$initial_results_returned  : mixed
$instructions  : mixed
$invalid_query_message  : mixed
$label_category  : mixed
$label_directions  : mixed
$label_email  : mixed
$label_fax  : mixed
$label_for_find_button  : mixed
$label_for_map_toggle  : mixed
$label_for_name  : mixed
$label_hours  : mixed
$label_image  : mixed
$label_phone  : mixed
$label_radius  : mixed
$label_search  : mixed
$label_website  : mixed
$last_geocoded_location  : mixed
$layout  : mixed
$loading_indicator  : mixed
$log_import_messages  : mixed
$log_schedule_messages  : mixed
$map_center  : mixed
$map_center_lat  : mixed
$map_center_lng  : mixed
$map_controls_subheader  : mixed
$map_end_icon  : mixed
$map_height  : mixed
$map_height_units  : mixed
$map_home_icon  : mixed
$map_initial_display  : mixed
$map_marker_tooltip  : mixed
$map_options_mapTypeControl  : mixed
$map_options_scaleControl  : mixed
$map_type  : mixed
$map_width  : mixed
$map_width_units  : mixed
$maplayout  : mixed
$max_results_returned  : mixed
$message_bad_address  : mixed
$message_no_results  : mixed
$myslp  : MySLP
$name_placeholder  : mixed
$no_autozoom  : mixed
$no_homeicon_at_start  : mixed
$page_layout  : mixed
$pages_directory_entry_css_class  : mixed
$pages_directory_wrapper_css_class  : mixed
$permalink_flush_needed  : mixed
$premium_subscription_id  : mixed
$premium_user_id  : mixed
$radii  : mixed
$remove_credits  : mixed
$reporting_enabled  : mixed
$results_box_title  : mixed
$resultslayout  : mixed
$search_appearance_category_header  : mixed
$search_appearance_tag_header  : mixed
$search_box_title  : mixed
$search_by_name  : mixed
$searchlayout  : mixed
$show_cats_on_search  : mixed
$show_country  : mixed
$show_hours  : mixed
$show_icon_array  : mixed
$show_legend_text  : mixed
$show_maptoggle  : mixed
$show_option_all  : mixed
$slplus  : SLPlus
$starting_image  : mixed
$style  : mixed
$style_id  : mixed
$tag_autosubmit  : mixed
$tag_dropdown_first_entry  : mixed
$tag_label  : mixed
$tag_output_processing  : mixed
$tag_selections  : mixed
$tag_selector  : mixed
$text_options  : mixed
$theme  : mixed
$url_allow_address  : mixed
$url_control_description  : mixed
$use_contact_fields  : mixed
$use_nonces  : mixed
$use_pages  : mixed
$use_sensor  : mixed
$uses_myslp  : bool
$uses_slplus  : bool
$zoom_level  : mixed
$zoom_tweak  : mixed
$change_callbacks  : mixed
$slug  : mixed
$time_callbacks  : mixed
$allow_limit_in_url  : mixed
$allow_location_in_url  : mixed
$allow_tag_in_url  : mixed
$block_ip_limit  : mixed
$block_ip_period  : mixed
$block_ip_release_after  : mixed
$boundaries_influence_type  : mixed
$bubble_footnote  : mixed
$cluster_gridsize  : mixed
$cluster_minimum  : mixed
$clusters_enabled  : mixed
$current_callback  : mixed
$current_checkboxes  : mixed
$db_loading  : mixed
$first_entry_for_zip_selector  : mixed
$initial_distance_already_calculated  : mixed
$initialized  : mixed
$ip_whitelist  : mixed
$label_for_zip_selector  : mixed
$loading_indicator_color  : mixed
$loading_indicator_location  : mixed
$map_appearance_cluster_header  : mixed
$map_option_fullscreenControl  : mixed
$map_option_hide_streetview  : mixed
$map_option_zoomControl  : mixed
$map_options_clickableIcons  : mixed
$no_results_gf_id  : mixed
$no_results_gf_landing_page  : mixed
$no_results_interface  : mixed
$page_options  : mixed
$pagination_enabled  : mixed
$phone_extension_delimiter  : mixed
$results_click_animate_marker  : mixed
$results_click_label_marker  : mixed
$results_click_map_movement  : mixed
$results_click_marker_icon  : mixed
$results_click_marker_icon_behavior  : mixed
$results_header  : mixed
$results_header_1  : mixed
$results_header_2  : mixed
$results_header_3  : mixed
$results_header_4  : mixed
$results_no_wrapper  : mixed
$schedule_for_geocoding  : mixed
$schedule_for_initial_distance  : mixed
$search_box_subtitle  : mixed
$search_on_map_move  : mixed
$smart_properties  : mixed
$use_territory_bounds  : mixed
$zip_selector  : mixed

Methods

__construct()  : mixed
__get()  : SLP_Option|null
Get something for non-existent properties.
__isset()  : bool
change_map_center()  : mixed
Things we do when a new map center is set.
change_style_id()  : mixed
Run this when the style ID changes.
create_smart_options()  : mixed
Create smart option objects and set to default_if_empty values.
execute_change_callbacks()  : mixed
Execute the stack of change callbacks.
execute_time_callbacks()  : mixed
Execute the stack of time callbacks.
exists()  : bool
Does the specified slug exist as a smart option?
exists_and_active()  : bool
Check if a property exists and is active.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
get_option_name()  : string
Return the property formatted option name.
get_options()  : mixed
Get a list of Smart Options
get_page_options()  : array<string|int, mixed>
Get a list of options that reside on the specified admin page.
get_setting_params()  : array<string|int, mixed>
Get the parameters needed for the SLP_Settings entry.
get_text_options()  : array<string|int, string>
Return a list of option slugs that are text options.
get_TypeOf()  : string|null
Get the type for the Smart Option.
get_ValueOf()  : mixed|null
Check if a given property exists and return the value.
initialize()  : mixed
Things we do at the start.
is_false()  : bool
Check if a given property is false.
is_true()  : bool
Check if a given property is true.
only_smart_options()  : bool
Return true if the element is an SLP_Option -- call get_options()
recalculate_initial_distance()  : mixed
Recalculate the initial distance for a location from the map center.
save()  : mixed
Save the options for the given admin page.
set()  : bool
Set the smart option value and the legacy options/options_nojs
set_checkboxes()  : mixed
Set incoming REQUEST checkboxes for the current admin page. Only run on admin pages.
set_properties()  : mixed
Set our properties.
set_valid_options()  : bool
Set valid slplus->options and copy to SmartOptions
set_valid_options_nojs()  : bool
Set valid slplus->options_nojs and copy to SmartOptions
slp_init_complete()  : void
Call when slp_init_complete is called, which is after user is authenticated (wp init)
slp_specific_setup()  : mixed
Initialize the options properties from the WordPress database.
strip_slashes_if_text()  : mixed
Strip slashes from value if this is a text entry.
trim()  : mixed
Trim the string.
create_general_options()  : mixed
General
create_settings_options()  : mixed
Settings
create_system_wide_options()  : mixed
System Wide Smart Options
experience_map_appearance()  : mixed
Settings / Map / Appearance
experience_map_at_startup()  : mixed
Settings / Map / At Startup
experience_map_functionality()  : mixed
Settings / Map / Functionality
experience_map_markers()  : mixed
Settings / Map / Markers
experience_results_after_search()  : mixed
Settings / Results / After Search
experience_results_at_startup()  : mixed
Settings / Results / At Startup
experience_results_labels()  : mixed
Settings / Results / Labels
experience_search_functionality()  : mixed
Settings / Search / Functionality
experience_search_labels()  : mixed
Settings / Search / Labels
general_admin_addons()  : mixed
General > Admin > Addons
general_admin_messages()  : mixed
General / Admin
general_app_map_services()  : mixed
General | App | Map Services
general_user_interface()  : mixed
General | User Interface | URL Controls
get_original_value()  : mixed
Remember the original value of a setting before we change it.
get_string_default()  : string
Get string defaults.
results_appearance()  : mixed
Results / Appearance
results_appearance_no_results()  : mixed
Results | Appearance | No Results
set_current_checkboxes()  : mixed
Builds a list of checkboxes for the current admin settings page.
set_text_string_defaults()  : mixed
Set text string defaults.
set_the_val()  : mixed
Set the value of a smart option & legacy option array copy
set_valid_option()  : bool
Set an option in an array only if the key already exists, for empty values set to default.
settings_search_appearance()  : mixed
Settings / Search / Appearance
setup_smart_callback()  : mixed
Set value change callback methods for smart options.
view_appearance()  : mixed
Settings / View / Appearance

Properties

$delete_history_before_this_date

public mixed $delete_history_before_this_date

$first_entry_for_radius_selector

public mixed $first_entry_for_radius_selector

$pages_directory_entry_css_class

public mixed $pages_directory_entry_css_class

$pages_directory_wrapper_css_class

public mixed $pages_directory_wrapper_css_class

$search_appearance_category_header

public mixed $search_appearance_category_header

$search_appearance_tag_header

public mixed $search_appearance_tag_header

$uses_myslp

public bool $uses_myslp

Set to true to add a $myslp property pointing to global $myslp

$uses_slplus

public bool $uses_slplus

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

$first_entry_for_zip_selector

private mixed $first_entry_for_zip_selector

$initial_distance_already_calculated

private mixed $initial_distance_already_calculated = \false

$map_appearance_cluster_header

private mixed $map_appearance_cluster_header

$map_option_fullscreenControl

private mixed $map_option_fullscreenControl

$results_click_animate_marker

private mixed $results_click_animate_marker

$results_click_marker_icon_behavior

private mixed $results_click_marker_icon_behavior

$schedule_for_initial_distance

private mixed $schedule_for_initial_distance

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

change_map_center()

Things we do when a new map center is set.

public change_map_center() : mixed

TODO: look up the address and set the lat/long.

change_style_id()

Run this when the style ID changes.

public change_style_id(mixed $key, mixed $old_val, mixed $new_val) : mixed
Parameters
$key : mixed
$old_val : mixed
$new_val : mixed

create_smart_options()

Create smart option objects and set to default_if_empty values.

public create_smart_options(array<string|int, mixed> $smart_option_params[, array<string|int, mixed> $defaults = array() ]) : mixed
Parameters
$smart_option_params : array<string|int, mixed>

An array of smart option attributes.

$defaults : array<string|int, mixed> = array()

If not empty, set this as the default for every smart_option_params entry.

execute_change_callbacks()

Execute the stack of change callbacks.

public execute_change_callbacks() : mixed

Use this to run callbacks after all options have been updated.

Tags
used-by

\SLP_SmartOptions::save

used-by

\SLP_Admin_General::save_options

used-by

\SLP_Admin_Settings::save_options

used-by

\SLP_AJAX::slp_change_option

used-by

\SLP_SmartOptions::set

used-by

\SLP_UI::localize_script

used-by

\SLP_BaseClass_Activation::convert_to_smartoptions

execute_time_callbacks()

Execute the stack of time callbacks.

public execute_time_callbacks() : mixed

Use this to run callbacks after all options have been updated.

exists()

Does the specified slug exist as a smart option?

public exists(string $property) : bool
Parameters
$property : string
Return values
bool

exists_and_active()

Check if a property exists and is active.

public exists_and_active(string $property) : bool
Parameters
$property : string

The name of the property to check.

Return values
bool —

Returns true if the property exists and is not null, false otherwise.

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() ]) : static
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
static

get_option_name()

Return the property formatted option name.

public get_option_name(mixed $property) : string
Parameters
$property : mixed
Return values
string

get_options()

Get a list of Smart Options

public get_options() : mixed
Tags
uses
SLP_SmartOptions::only_smart_options

get_page_options()

Get a list of options that reside on the specified admin page.

public get_page_options(string $admin_page) : array<string|int, mixed>
Parameters
$admin_page : string
Return values
array<string|int, mixed>

get_setting_params()

Get the parameters needed for the SLP_Settings entry.

public get_setting_params(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

get_text_options()

Return a list of option slugs that are text options.

public get_text_options() : array<string|int, string>
Return values
array<string|int, string>

get_TypeOf()

Get the type for the Smart Option.

public get_TypeOf(mixed $property) : string|null
Parameters
$property : mixed
Return values
string|null —

type as a string (i.e. "checkbox") or null if property does not exist.

get_ValueOf()

Check if a given property exists and return the value.

public get_ValueOf(string $property) : mixed|null
Parameters
$property : string

The property to check.

Return values
mixed|null

is_false()

Check if a given property is false.

public is_false(string $property) : bool
Parameters
$property : string

The property to check.

Return values
bool —

Returns true if the property exists and is not null, and its 'is_true' property is true. Otherwise, returns false.

is_true()

Check if a given property is true.

public is_true(string $property) : bool
Parameters
$property : string

The property to check.

Return values
bool —

Returns true if the property exists and is not null, and its 'is_true' property is true. Otherwise, returns false.

only_smart_options()

Return true if the element is an SLP_Option -- call get_options()

public static only_smart_options(mixed $element) : bool
Parameters
$element : mixed
Tags
used-by

\SLP_SmartOptions::get_options

Return values
bool

recalculate_initial_distance()

Recalculate the initial distance for a location from the map center.

public recalculate_initial_distance() : mixed

Called if 'distance_unit' changes.

call_when_changed alway gets 3 params whether or not they are used...

save()

Save the options for the given admin page.

public save([string $admin_page = '' ]) : mixed
Parameters
$admin_page : string = ''

set()

Set the smart option value and the legacy options/options_nojs

public set(mixed $property, mixed $value[, bool $writeToDB = false ]) : bool
Parameters
$property : mixed
$value : mixed
$writeToDB : bool = false
Return values
bool

set_checkboxes()

Set incoming REQUEST checkboxes for the current admin page. Only run on admin pages.

public set_checkboxes(string $admin_page) : mixed
Parameters
$admin_page : string

set_properties()

Set our properties.

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

set_valid_options()

Set valid slplus->options and copy to SmartOptions

public set_valid_options(mixed $val, mixed $key) : bool
Parameters
$val : mixed
$key : mixed
Return values
bool

set_valid_options_nojs()

Set valid slplus->options_nojs and copy to SmartOptions

public set_valid_options_nojs(mixed $val, mixed $key) : bool
Parameters
$val : mixed
$key : mixed
Return values
bool

slp_init_complete()

Call when slp_init_complete is called, which is after user is authenticated (wp init)

public slp_init_complete() : void

slp_specific_setup()

Initialize the options properties from the WordPress database.

public slp_specific_setup() : mixed

Called by MySLP Dashboard.

strip_slashes_if_text()

Strip slashes from value if this is a text entry.

public strip_slashes_if_text(string &$val, string $key) : mixed
Parameters
$val : string
$key : string

trim()

Trim the string.

public trim(string $key, string $old_val, string $new_val) : mixed
Parameters
$key : string
$old_val : string
$new_val : string

create_general_options()

General

private create_general_options() : mixed

create_settings_options()

Settings

private create_settings_options() : mixed

create_system_wide_options()

System Wide Smart Options

private create_system_wide_options() : mixed

experience_map_appearance()

Settings / Map / Appearance

private experience_map_appearance() : mixed

experience_map_at_startup()

Settings / Map / At Startup

private experience_map_at_startup() : mixed

experience_map_functionality()

Settings / Map / Functionality

private experience_map_functionality() : mixed

experience_map_markers()

Settings / Map / Markers

private experience_map_markers() : mixed

experience_results_after_search()

Settings / Results / After Search

private experience_results_after_search() : mixed

experience_results_at_startup()

Settings / Results / At Startup

private experience_results_at_startup() : mixed

experience_results_labels()

Settings / Results / Labels

private experience_results_labels() : mixed

experience_search_functionality()

Settings / Search / Functionality

private experience_search_functionality() : mixed

experience_search_labels()

Settings / Search / Labels

private experience_search_labels() : mixed

general_admin_addons()

General > Admin > Addons

private general_admin_addons() : mixed

general_admin_messages()

General / Admin

private general_admin_messages() : mixed

general_app_map_services()

General | App | Map Services

private general_app_map_services() : mixed

general_user_interface()

General | User Interface | URL Controls

private general_user_interface() : mixed

get_original_value()

Remember the original value of a setting before we change it.

private get_original_value(mixed $new_value, mixed $key, mixed &$option_array, mixed $is_smart_option, mixed $valid_legacy_option) : mixed
Parameters
$new_value : mixed
$key : mixed
$option_array : mixed
$is_smart_option : mixed
$valid_legacy_option : mixed

get_string_default()

Get string defaults.

private get_string_default(string $key) : string
Parameters
$key : string

key name for string to translate

Return values
string

results_appearance()

Results / Appearance

private results_appearance() : mixed

results_appearance_no_results()

Results | Appearance | No Results

private results_appearance_no_results() : mixed

set_current_checkboxes()

Builds a list of checkboxes for the current admin settings page.

private set_current_checkboxes(string $admin_page) : mixed
Parameters
$admin_page : string

set_text_string_defaults()

Set text string defaults.

private set_text_string_defaults() : mixed

set_the_val()

Set the value of a smart option & legacy option array copy

private set_the_val(mixed $value, mixed $key, mixed &$option_array, mixed $is_smart_option, mixed $valid_legacy_option) : mixed
Parameters
$value : mixed
$key : mixed
$option_array : mixed
$is_smart_option : mixed
$valid_legacy_option : mixed

set_valid_option()

Set an option in an array only if the key already exists, for empty values set to default.

private set_valid_option(mixed $val, string $key, string $which_option) : bool

External classes should use set_valid_options / set_valid_options_nojs.

Parameters
$val : mixed

the value of a form var

$key : string

the key for that form var

$which_option : string

which array to use

Return values
bool

settings_search_appearance()

Settings / Search / Appearance

private settings_search_appearance() : mixed

setup_smart_callback()

Set value change callback methods for smart options.

private setup_smart_callback(mixed $key, mixed $original_value) : mixed

That are defined as on this page (or the page is not defined) Whose original value from slplus->options or slplus->options_nojs DOES NOT match the new value (from the DB usually) ... reset the original value temp var to the smart option default value (if provided , null if not provided) ... and set the smart option to the new value if not empty or the smart option default if the new value was empty

Parameters
$key : mixed
$original_value : mixed

view_appearance()

Settings / View / Appearance

private view_appearance() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results