SLP_Location_Manager
extends SLPlus_BaseClass_Object
in package
Class SLP_Location_Manager
Table of Contents
Properties
- $location_count : int
- $location_limit : int
- $location_limit : mixed
- $location_limit_int : mixed
- $slplus : SLPlus
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : mixed
- $location_count : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- create_notification() : mixed
- Add status messages to the admin UI.
- decrement_location_count() : mixed
- Decrement the location count.
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- get_location_count() : array<string|int, mixed>
- Get the current location count.
- has_max_locations() : bool
- Check if we have hit our max locations limit.
- increment_location_count() : mixed
- Increment the location count.
- recalculate_initial_distance() : mixed
- Recalculate the initial distance for all locations.
- recalculate_initial_distance_where_zero() : mixed
- Recalculate initial distance where distance is zero.
- set_properties() : mixed
- Set our properties.
- initialize() : mixed
- Things we do at the start.
Properties
$location_count read-only
public
int
$location_count
Current location count, init with get_location_count.
$location_limit
public
int
$location_limit
Limit on locations allowed to be processed.
$location_limit
public
mixed
$location_limit
$location_limit_int
public
mixed
$location_limit_int
$slplus
public
SLPlus
$slplus
$uses_slplus
public
bool
$uses_slplus
Set to true (default) if the object needs access to the SLPlus plugin object.
$slplus
protected
mixed
$slplus
$uses_slplus
protected
mixed
$uses_slplus
= \true
$location_count
private
mixed
$location_count
Methods
__construct()
public
__construct([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
__get()
public
__get(string $property) : SLPlus_BaseClass_Object
Parameters
- $property : string
Return values
SLPlus_BaseClass_Object__isset()
public
__isset(string $property) : bool
Parameters
- $property : string
Return values
boolcreate_notification()
Add status messages to the admin UI.
public
create_notification(string $response_code) : mixed
Parameters
- $response_code : string
decrement_location_count()
Decrement the location count.
public
decrement_location_count() : mixed
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() ]) : SLPlus_BaseClass_Object
TODO: PHP7.4 and PHP8.0 the static instance variable returns an object matching $class TODO: PHP8.1 the static instance continually returns the FIRST object (SLP_Admin_Helper) every time -- it is like PHP8.1 static instance is bound to base_class-object versus the calling class object
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
SLPlus_BaseClass_Objectget_location_count()
Get the current location count.
public
get_location_count([bool $force = false ]) : array<string|int, mixed>
Parameters
- $force : bool = false
Return values
array<string|int, mixed>has_max_locations()
Check if we have hit our max locations limit.
public
has_max_locations([bool $force = false ]) : bool
Parameters
- $force : bool = false
-
force a recount if true
Return values
boolincrement_location_count()
Increment the location count.
public
increment_location_count() : mixed
recalculate_initial_distance()
Recalculate the initial distance for all locations.
public
recalculate_initial_distance([SLP_Message_Manager $messages = null ][, string $where = null ]) : mixed
Parameters
- $messages : SLP_Message_Manager = null
- $where : string = null
-
SQL where clause
recalculate_initial_distance_where_zero()
Recalculate initial distance where distance is zero.
public
recalculate_initial_distance_where_zero([SLP_Message_Manager $messages = null ]) : mixed
Parameters
- $messages : SLP_Message_Manager = null
set_properties()
Set our properties.
public
set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
initialize()
Things we do at the start.
protected
initialize() : mixed