SLP® phpDocs

SLPWidget_Legacy_Settings extends SLPlus_BaseClass_Object

Class SLPWidget_Settings

Tags
author

Lance Cleveland lance@charlestonsw.com

copyright

2015 Charleston Software Associates, LLC

Text Domain: slp-experience

Table of Contents

Properties

$addon  : object
$button_label  : mixed
$default_title  : mixed
$maximum_result_set  : mixed
$myslp  : MySLP
$radius_label  : mixed
$search_label  : mixed
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$slug  : mixed
$settings_array  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
applySettings()  : mixed
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
getSettings()  : mixed
Reduces the class's settings to an array and returns them
initialize()  : mixed
Create a settings class
options()  : mixed
Loads default options or gets them from the db if they already exist
set_properties()  : mixed
Set our properties.
Settings()  : array<string|int, mixed>
Gets the plugin settings
reduceSettings()  : mixed
Reduces all class vars into an array for saving or distribution

Properties

$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

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

getSettings()

Reduces the class's settings to an array and returns them

public getSettings(mixed $settings) : mixed
Parameters
$settings : mixed
Return values
mixed

The settings array

options()

Loads default options or gets them from the db if they already exist

public options(mixed $default) : mixed
Parameters
$default : mixed
Return values
mixed

The options from the db or the defaults

set_properties()

Set our properties.

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

Settings()

Gets the plugin settings

public static Settings() : array<string|int, mixed>
Return values
array<string|int, mixed>

This plugin's settings class


        
On this page

Search results