SLP® phpDocs

SLPlus_Location
in package

Store Locator Plus location interface and management class.

Make a location an in-memory object and handle persistence via data I/O to the MySQL tables.

FIELDS:

Table of Contents

Constants

MaxDelay  = 6000000
StartingDelay  = 2000000

Properties

$all  : mixed
$attributes  : mixed
$dataChanged  : mixed
$dbFieldPrefix  : mixed
$dbfields  : array<string|int, string>
$exdata  : mixed
$geocodeSkipOKNotices  : mixed
$retry_maximum_delayms  : int
$settings  : array<string|int, mixed>
$validate_fields  : mixed
$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
$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()  : mixed
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()  : false|int
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.

Constants

Properties

$dbfields read-only

public array<string|int, string> $dbfields

Array of locator table field names.

$retry_maximum_delayms read-only

public int $retry_maximum_delayms

Maxmium delay in milliseconds.

$settings

public array<string|int, mixed> $settings

The deserialized option_value field

$dbFields

private mixed $dbFields = array('id', 'store', 'address', 'address2', 'city', 'state', 'zip', 'country', 'latitude', 'longitude', 'tags', 'description', 'email', 'url', 'hours', 'phone', 'fax', 'image', 'private', 'neat_title', 'linked_postid', 'pages_url', 'pages_on', 'option_value', 'lastupdated', 'initial_distance')

$geocodeIssuesRendered

private mixed $geocodeIssuesRendered = \false

$legacy_field_map

private mixed $legacy_field_map = array('sl_id' => 'id', 'sl_store' => 'store', 'sl_address' => 'address', 'sl_address2' => 'address2', 'sl_city' => 'city', 'sl_state' => 'state', 'sl_zip' => 'zip', 'sl_country' => 'country', 'sl_latitude' => 'latitude', 'sl_longitude' => 'longitude', 'sl_tags' => 'tags', 'sl_description' => 'description', 'sl_email' => 'email', 'sl_url' => 'url', 'sl_hours' => 'hours', 'sl_phone' => 'phone', 'sl_fax' => 'fax', 'sl_image' => 'image', 'sl_private' => 'private', 'sl_neat_title' => 'neat_title', 'sl_linked_postid' => 'linked_postid', 'sl_pages_url' => 'pages_url', 'sl_pages_on' => 'pages_on', 'sl_option_value' => 'option_value', 'sl_lastupdated' => 'lastupdated', 'sl_initial_distance' => 'initial_distance')

Methods

__construct()

Initialize a new location

public __construct(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>
  • a named array of the plugin options.

__get()

Fetch a location property from the valid object properties list.

public __get(mixed $property) : null

$currentLocation = new SLPlus_Location() print $currentLocation->id

Parameters
$property : mixed
  • which property to set.
Return values
null

__isset()

Allow isset to be called on private properties.

public __isset(mixed $property) : bool
Parameters
$property : mixed
Return values
bool

__set()

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

public __set(mixed $property, mixed $value) : SLPlus_Location

$currentLocation = new SLPlus_Location() $currentLocation->store = 'My Place'

Parameters
$property : mixed
$value : mixed
Return values
SLPlus_Location

add_to_database()

Add an address into the SLP locations database.

public add_to_database(array<string|int, array<string|int, mixed>> $locationData[, string $duplicates_handling = 'none' ][, bool $skipGeocode = false ]) : string

NOTE: Only saves PRIMARY data fields. DOES NOT save extended data. Use the slp_location_added action.

duplicates_handling can be: o none = ignore duplicates o skip = skip duplicates o update = update duplicates

Returns: o added = new location added o location_exists = store id provided and not in update mode o not_updated = existing location not updated o skipped = duplicate skipped o updated = existing location updated

Parameters
$locationData : array<string|int, array<string|int, mixed>>
$duplicates_handling : string = 'none'
$skipGeocode : bool = false
Return values
string

crupdate_Page()

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

public crupdate_Page([bool $MakePersistent = true ]) : int

Set MakePersistent to false if you are going to manage the persistent store later. You can check $this->dataChanged to see if the data is dirty to determine whether or not persistence might be needed.

Parameters
$MakePersistent : bool = true

if true will write the location to disk if the linked_postid was changed.

Return values
int —

return the page ID linked to this location.

delete()

Delete this location permanently.

public delete([int|null $id = null ][, bool $all = false ]) : WP_Error|int|false
Parameters
$id : int|null = null
$all : bool = false
  • Delete all processing
Return values
WP_Error|int|false

delete_extended_data()

Delete extended data.

public delete_extended_data() : mixed

delete_page_links()

Delete the associated page.

public delete_page_links() : mixed

delete_store_pages()

Delete store pages.

public delete_store_pages() : mixed

do_geocoding()

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

public do_geocoding([string $address = null ]) : mixed

Writing to disk is to be handled by the calling function.

slplus_plugin->currentLocation->dataChanged is set to true if the lat/long is updated.

Parameters
$address : string = null

the address to geocode, if not set use currentLocation

get()

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

public get([string $output = object ]) : $this|array<string|int, mixed>
Parameters
$output : string = object
Return values
$this|array<string|int, mixed>

get_display_type()

Get the display type for the specified property.

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

get_formatted_address()

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

public get_formatted_address() : mixed

get_formatted_name()

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

public get_formatted_name() : mixed|null

Use the slp_formatted_location_name_elements filter to change which elements are returned. Use the slp_formatted_location_name filter to change the final string.

Return values
mixed|null

get_location()

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

public get_location(mixed $location_id) : mixed
Parameters
$location_id : mixed
Tags
@return

SLPLus_location || WP_Error

get_PersistentProperty()

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

public get_PersistentProperty([string $property = 'all' ]) : mixed
Parameters
$property : string = 'all'

name of the persistent property to get, defaults to 'all' = array of all properties

Return values
mixed —

the value the property or a named array of all properties (default)

get_property_name()

Return the base name without the leading sl_.

public get_property_name(string $field_slug) : string
Parameters
$field_slug : string
Return values
string

get_property_using_fieldname()

Get a property value by the DB field name.

public get_property_using_fieldname(mixed $fieldname) : string|null
Parameters
$fieldname : mixed
Return values
string|null

is_base_field()

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

public is_base_field(string $field_slug) : bool
Parameters
$field_slug : string
Return values
bool

is_valid_lat()

Latitude is valid.

public is_valid_lat([string $lat = null ]) : bool
Parameters
$lat : string = null

if not passed defaults to current location latitude.

Return values
bool

is_valid_lng()

Longitude is valid.

public is_valid_lng([string $lng = null ]) : bool
Parameters
$lng : string = null

if not passed defaults to current location longitude.

Return values
bool

isvalid_ID()

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

public isvalid_ID([string $id = null ][, string $request_param = null ]) : bool

If not id is presented, check the current location ID.

request_param is used if ID is set to null to try to set the value from a request variable of that name.

Parameters
$id : string = null
$request_param : string = null
Return values
bool

MakePersistent()

Make the location data persistent.

public MakePersistent() : bool
Return values
bool —

data write OK

MakePersistentIfChanged()

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

public MakePersistentIfChanged() : mixed

only_delete_store_pages()

Filter to make sure we only delete SLP Store Pages

public only_delete_store_pages(mixed $value, WP_Post $post) : mixed
Parameters
$value : mixed
$post : WP_Post
Return values
mixed —

returns false to not delete

page_exists()

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

public page_exists() : mixed

reset()

Set all the db field properties to blank.

public reset() : mixed

set_PropertiesViaArray()

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

public set_PropertiesViaArray(array<string|int, mixed> $locationData[, string $mode = 'reset' ]) : mixed

Used to set properties based on the MySQL SQL fetch to ARRAY_A method or on a prepped named array where the field names are keys and field values are the values.

Mode parameter: o dbreset = reset location data to blank before loading it up o reset = reset location data to blank before loading it up o update = do NOT reset location data to blank before updating

Assumes the field names start with 'sl_'.

Parameters
$locationData : array<string|int, mixed>
$mode : string = 'reset'

which mode? 'add' , 'dbreset' , 'load' , 'reset', or 'update' add is called from \SLPlus_Location::add_to_database based when in 'add' mode dbreset is called from \SLPlus_Location::set_PropertiesViaDB which resets if the location ID changed load is used when a process already read the ENTIRE location data from the DB and is setting properties reset is the general default update is called from \SLPlus_Location::add_to_database based when in 'update' mode

set_PropertiesViaDB()

Load a location from the database.

public set_PropertiesViaDB(int $locationID) : SLPlus_Location

Only re-reads database if the location ID has changed.

Parameters
$locationID : int
  • ID of location to be loaded
Return values
SLPlus_Location —

$this - the location object

update_Attributes()

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

public update_Attributes(array<string|int, mixed> $newAttributes) : mixed
Parameters
$newAttributes : array<string|int, mixed>

valid_location_property()

Return true if the property is valid.

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

property name to validate

Tags
used-by

\SLPlus_Location::set_PropertiesViaArray

used-by

\SLP_Admin_Locations_Actions::add_location

used-by

\SLP_Admin_Locations_Actions::save_edited_location

Return values
bool —

true if property is OK

calculate_initial_distance()

Calculate the initial distance from the map center point.

private calculate_initial_distance() : mixed

decode_Base64UrlSafe()

Decode a string from URL-safe base64.

private decode_Base64UrlSafe(mixed $value) : string
Parameters
$value : mixed
Return values
string

is_map_center_valid()

Return if map center is valid.

private is_map_center_valid() : bool

Sets active_radius and map_center_valid for cache in \SLPlus_Location::calculate_initial_distance

Return values
bool

make_extended_data_persistent()

Make extended data persistent.

private make_extended_data_persistent() : false|int
Return values
false|int —

false if update/insert failed or number of records inserted/updated if OK.

mapPropertyToField()

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

private mapPropertyToField(mixed $result, string $property) : array<string|int, mixed>
Parameters
$result : mixed
$property : string
  • name of the location property
Return values
array<string|int, mixed> —
  • key = string of db field name, value = location property value

set_LatLong()

Set latitude & longitude for this location.

private set_LatLong(float $lat, float $lng) : mixed
Parameters
$lat : float
$lng : float

set_PageData()

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

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

This method applies the slp_location_page_attributes filter.

Using that filter allows other parts of the system to change or augment the data before we create or update the page in the WP database.

Return values
array<string|int, mixed> —

WordPress custom post type property array

val_or_blank()

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

private val_or_blank(array<string|int, mixed> $data, string $key) : mixed
Parameters
$data : array<string|int, mixed>

the location data array

$key : string

store locator plus location data array key

Return values
mixed —
  • the data element value or a blank string

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results