SLP® phpDocs

SLP_Power_REST_Handler extends SLPlus_BaseClass_Object
in package

Configure the REST handler and connect to WordPress engine.

Table of Contents

Properties

$addon  : object
$myslp  : MySLP
$slplus  : SLPlus
$uses_myslp  : bool
$uses_slplus  : bool
$slug  : mixed

Methods

__construct()  : mixed
__get()  : SLPlus_BaseClass_Object
__isset()  : bool
get_geocoding()  : WP_Error|WP_REST_Response
Return a list of active location imports by attachment ID.
get_imports()  : WP_Error|WP_REST_Response
Return a list of active location imports by attachment ID.
get_instance()  : static
Return an instance of the object which is also registered to the slplus global less the SLP_ part.
GetReportLocationResultHistoryCount()  : WP_REST_Response
Handle the REST requests coming in on /report/location/result_history_count
GetReportLocationSearchHistory()  : WP_REST_Response
Handle the REST requests coming in on /report/location/search_history
GetReportLocationSearchHistoryCount()  : WP_REST_Response
Handle the REST requests coming in on /report/location/search_history_count
GetReportLocationSearchResultHistory()  : WP_REST_Response
Handle the REST requests coming in on /report/location/search_result_history
initialize()  : mixed
Get us going.
set_properties()  : mixed
Set our properties.
setup_endpoints()  : mixed
Setup endpoints.

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

Return a list of active location imports by attachment ID.

public get_geocoding(WP_REST_Request $request) : WP_Error|WP_REST_Response
APIYes
Parameters
$request : WP_REST_Request
Tags
used-by

\SLP_Power_REST_Handler::setup_endpoints via READABLE REST Route store-locator-plus/location_imports/

Return values
WP_Error|WP_REST_Response

get_imports()

Return a list of active location imports by attachment ID.

public get_imports(WP_REST_Request $request) : WP_Error|WP_REST_Response
APIYes
Parameters
$request : WP_REST_Request
Tags
used-by

\SLP_Power_REST_Handler::setup_endpoints via READABLE REST Route store-locator-plus/location_imports/

Return values
WP_Error|WP_REST_Response

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

GetReportLocationResultHistoryCount()

Handle the REST requests coming in on /report/location/result_history_count

public GetReportLocationResultHistoryCount(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

GetReportLocationSearchHistory()

Handle the REST requests coming in on /report/location/search_history

public GetReportLocationSearchHistory(WP_REST_Request $request) : WP_REST_Response
APIYes
Parameters
$request : WP_REST_Request
Tags
route

{get} /report/location/search_history Get data for location search history report.

apiName

GetReportLocationSearchHistory

apiGroup

Report

apiParam

{string} start The start date as a string (YYYY-MM-DD)

apiParam

{string} end The end date as a string (YYYY-MM-DD)

apiParam

{number} limit Max records to return from SQL query.

Return values
WP_REST_Response

GetReportLocationSearchHistoryCount()

Handle the REST requests coming in on /report/location/search_history_count

public GetReportLocationSearchHistoryCount(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

GetReportLocationSearchResultHistory()

Handle the REST requests coming in on /report/location/search_result_history

public GetReportLocationSearchResultHistory(WP_REST_Request $request) : WP_REST_Response
Parameters
$request : WP_REST_Request
Return values
WP_REST_Response

set_properties()

Set our properties.

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

setup_endpoints()

Setup endpoints.

private setup_endpoints() : mixed
Tags
route

GET wp-json/store-locator-plus/v2/imports/ Get list of running imports.

route

GET wp-json/store-locator-plus/v2/geocoding/ Get list of running geocodes.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results