SLP® phpDocs

SLP_Premier_Options extends SLP_AddOn_Options
in package

Class SLP_Premier_Options

The options management for the premier add on

Tags
@property

SLP_Premier addon

@property-read

boolean subscription_is_valid

Table of Contents

Properties

$addon  : object
$initialized  : bool
$myslp  : MySLP
$our_options  : array<string|int, string>
$slplus  : SLPlus
$slug  : mixed
$uses_myslp  : bool
$uses_slplus  : bool
$subscription_is_valid  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
fix_form_action()  : string|array<string|int, string>|null
Fix up the action in the form when embedded in another page.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
get_no_results_message()  : string
Modify the no results message output.
initialize()  : mixed
Things we do at the start.
register_cron_hooks()  : mixed
Register cron hooks.
schedule_changes()  : mixed
Process schedule changes.
set_boundary_influence_lat_lng()  : mixed
Set the boundary influence to a border around all locations.
set_properties()  : mixed
Set our properties.
toggle_option()  : mixed
Toggle options on and off.
attach_to_slp()  : mixed
Go and create the smart options.
create_options()  : mixed
Create our options.
augment_settings_search_functionality()  : mixed
Settings / Search / Functionality
create_general_schedule_options()  : mixed
General / Schedule / Tasks
general_server_security()  : mixed
General / App / Security
general_server_web_app_settings()  : mixed
General / App / Features
general_ui_url_control()  : mixed
General / User Interface / URL Controls
map_appearance()  : mixed
Map | Appearance
map_functionality()  : mixed
Map > Functionality
map_markers()  : mixed
Map > Markers
results_appearance()  : mixed
Results | Appearance
results_appearance_no_results()  : mixed
Results | Appearance | No results
results_interaction()  : mixed
Results | Interaction
results_labels()  : mixed
Results | Labels
search_appearance()  : mixed
Search | Appearance
search_appearance_search_form_style()  : mixed
Search | Appearance | Search Form Style
search_labels()  : mixed
Search | Labels

Properties

$initialized read-only

public bool $initialized

Have our options been initialized

$our_options

public array<string|int, string> $our_options

The slugs for options that this add on manipulates

$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.

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

fix_form_action()

Fix up the action in the form when embedded in another page.

public fix_form_action(mixed $form_string, mixed $form) : string|array<string|int, string>|null
Parameters
$form_string : mixed
$form : mixed
Return values
string|array<string|int, string>|null

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_no_results_message()

Modify the no results message output.

public get_no_results_message(mixed $value) : string
Parameters
$value : mixed
Tags
used-by

\SLP_Premier_Options::results_appearance_no_results

Return values
string

register_cron_hooks()

Register cron hooks.

public register_cron_hooks(string $slug) : mixed
Parameters
$slug : string

the property "name"

Tags
used-by

\SLP_Premier_Options::create_general_schedule_options

schedule_changes()

Process schedule changes.

public schedule_changes(string $slug, string $old_value, string $new_value) : mixed
Parameters
$slug : string

the property "name"

$old_value : string
$new_value : string

set_boundary_influence_lat_lng()

Set the boundary influence to a border around all locations.

public set_boundary_influence_lat_lng(mixed $key, mixed $old_value, mixed $new_value) : mixed
Parameters
$key : mixed
$old_value : mixed
$new_value : mixed

set_properties()

Set our properties.

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

toggle_option()

Toggle options on and off.

public toggle_option(mixed $key, mixed $original, mixed $new) : mixed
Parameters
$key : mixed
$original : mixed
$new : mixed

attach_to_slp()

Go and create the smart options.

protected attach_to_slp(array<string|int, mixed> $these_options[, array<string|int, mixed> $defaults = array() ]) : mixed
Parameters
$these_options : array<string|int, mixed>
$defaults : array<string|int, mixed> = array()

augment_settings_search_functionality()

Settings / Search / Functionality

private augment_settings_search_functionality() : mixed

create_general_schedule_options()

General / Schedule / Tasks

private create_general_schedule_options() : mixed
Tags
uses
SLP_Premier_Options::register_cron_hooks

general_server_security()

General / App / Security

private general_server_security() : mixed

general_server_web_app_settings()

General / App / Features

private general_server_web_app_settings() : mixed

general_ui_url_control()

General / User Interface / URL Controls

private general_ui_url_control() : mixed

results_appearance_no_results()

Results | Appearance | No results

private results_appearance_no_results() : mixed
Tags
uses
SLP_Premier_Options::get_no_results_message

search_appearance_search_form_style()

Search | Appearance | Search Form Style

private search_appearance_search_form_style() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results