Store Locator Plus®

SLPlus_Location

in package

• StoreLocatorPlus

Store Locator Plus location interface and management class.

Table of Contents

Constants

MaxDelay  = 6000000

StartingDelay  = 2000000

Properties

$active_radius  : float

$address  : string

$address2  : string

$all  : bool

$all  : mixed

$attributes  : array<string|int, mixed>

$attributes  : mixed

$city  : string

$count  : int

$country  : string

$data_is_loading  : bool

$dataChanged  : bool

$dataChanged  : mixed

$db  : wpdb

$dbFieldPrefix  : string

$dbFieldPrefix  : mixed

$dbFields  : array<string|int, string>

$dbfields  : array<string|int, string>

$delay  : int

$description  : string

$email  : string

$exdata  : array<string|int, mixed>

$exdata  : mixed

$fax  : string

$geocodeIssuesRendered  : bool

$geocodeSkipOKNotices  : bool

$geocodeSkipOKNotices  : mixed

$hours  : string

$id  : int

$image  : string

$initial_distance  : float

$lastupdated  : datetime

$latitude  : string

$linked_postid  : int

$locationData  : array<string|int, mixed>

$longitude  : string

$map_center_valid  : bool

$neat_title  : string

$option_value  : string

$pageData  : array<string|int, mixed>

$pageDefaultStatus  : string

$pages_on  : bool

$pages_url  : string

$phone  : string

$private  : bool

$retry_maximum_delayms  : int

$settings  : array<string|int, mixed>

$slplus  : SLPlus

$state  : string

$store  : string

$tags  : string

$url  : string

$validate_fields  : bool

$validate_fields  : mixed

$zip  : string

$active_radius  : mixed

$address  : mixed

$address2  : mixed

$city  : mixed

$count  : mixed

$country  : mixed

$data_is_loading  : mixed

$db  : mixed

$dbFields  : mixed

$delay  : mixed

$description  : mixed

$display_types  : mixed

$email  : mixed

$fax  : mixed

$geocodeIssuesRendered  : mixed

$hours  : mixed

$id  : mixed

$image  : mixed

$initial_distance  : mixed

$lastupdated  : mixed

$latitude  : mixed

$legacy_field_map  : mixed

$linked_postid  : mixed

$locationData  : mixed

$longitude  : mixed

$map_center_valid  : mixed

$neat_title  : mixed

$option_value  : mixed

$pageData  : mixed

$pageDefaultStatus  : mixed

$pages_on  : mixed

$pages_url  : mixed

$phone  : mixed

$private  : mixed

$property_names  : mixed

$slplus  : mixed

$state  : mixed

$store  : mixed

$tags  : mixed

$temporary  : mixed

$url  : mixed

$zip  : mixed

Methods

__construct()  : mixed

Initialize a new location

__get()  : null

Fetch a location property from the valid object properties list.

__isset()  : bool

Allow isset to be called on private properties.

__set()  : SLPlus_Location

Set a location property in the valid object properties list to the given value.

add_to_database()  : string

Add an address into the SLP locations database.

crupdate_Page()  : int

Create or update the custom store_page page type for this location.

delete()  : WP_Error|int|false

Delete this location permanently.

delete_extended_data()  : mixed

Delete extended data.

delete_page_links()  : mixed

Delete the associated page.

delete_store_pages()  : mixed

Delete store pages.

do_geocoding()  : mixed

GeoCode a given location, updating the slplus_plugin currentLocation object lat/long.

get()  : $this|array<string|int, mixed>

Return location as OBJECT (default) , named array (ARRAY_A), or numeric array (ARRAY_N)

get_display_type()  : null|string

Get the display type for the specified property.

get_formatted_address()  : mixed

Return a formatted address. Unlike get_formatted_name this is used for a typical "postal address block".

get_formatted_name()  : mixed|null

Send back a formatted name including the store, city, and state space separated by default.

get_location()  : SLPLus_location

Set the current location to the given location ID and return the SLPlus_Location object.

get_PersistentProperty()  : mixed

Return the values for each of the persistent properties of this location.

get_property_name()  : string

Return the base name without the leading sl_.

get_property_using_fieldname()  : string|null

Get a property value by the DB field name.

is_base_field()  : bool

Return true if the field slug or sl_<field_slug> is a base field.

is_valid_lat()  : bool

Latitude is valid.

is_valid_lng()  : bool

Longitude is valid.

isvalid_ID()  : bool

Return true of the given string is an int greater than 0.

MakePersistent()  : bool

Make the location data persistent.

MakePersistentIfChanged()  : mixed

Write a location record to the database if dataChanged is true.

only_delete_store_pages()  : mixed

Filter to make sure we only delete SLP Store Pages

page_exists()  : mixed

Return true if the Store Page actually exists for the current location.

reset()  : mixed

Set all the db field properties to blank.

set_PropertiesViaArray()  : mixed

Set location properties via a named array containing the field data.

set_PropertiesViaDB()  : SLPlus_Location

Load a location from the database.

update_Attributes()  : mixed

Update the location attributes, merging existing attributes with new attributes.

valid_location_property()  : bool

Return true if the property is valid.

calculate_initial_distance()  : mixed

Calculate the initial distance from the map center point.

decode_Base64UrlSafe()  : string

Decode a string from URL-safe base64.

is_map_center_valid()  : bool

Return if map center is valid.

make_extended_data_persistent()  : bool

Make extended data persistent.

mapPropertyToField()  : array<string|int, mixed>

Return a named array that sets key = db field name, value = location property

set_LatLong()  : mixed

Set latitude & longitude for this location.

set_PageData()  : array<string|int, mixed>

Setup the data for the current page, run through augmentation filters.

val_or_blank()  : mixed

Return the value of the specified location data element or blank if not set.