SLP_Power_Data_Reports
extends SLPlus_BaseClass_Object
in package
Admin Report Data Interface for Power
Table of Contents
Properties
- $result_count_history : mixed
- $search_count_history : mixed
- $slplus : SLPlus
- $table : array<string|int, string>
- $table : mixed
- $top_results : array<string|int, string>
- $top_results : mixed
- $top_searches : array<string|int, string>
- $top_searches : mixed
- $uses_slplus : bool
- $slplus : mixed
- $uses_slplus : mixed
Methods
- __construct() : mixed
- __get() : SLPlus_BaseClass_Object
- __isset() : bool
- delete_history_before() : int|bool
- Delete all history entries before the specified date.
- delete_older_report_data() : mixed
- Delete report data more than 13 months old, max 100 records at a time.
- get_instance() : SLPlus_BaseClass_Object
- Return an instance of the object which is also registered to the slplus global less the SLP_ part.
- initialize() : mixed
- Things to do at the start.
- set_properties() : mixed
- Set our properties.
- set_result_count() : mixed
- Set the search count with dates for the given date range.
- set_search_count() : mixed
- Set the search count with dates for the given date range.
- set_top_results() : mixed
- Set the top_results dataset for the given date range.
- set_top_searches() : mixed
- Set the top searches dataset for the given date range.
Properties
$result_count_history
public
mixed
$result_count_history
$search_count_history
public
mixed
$search_count_history
$slplus
public
SLPlus
$slplus
$table
public
array<string|int, string>
$table
The SQL data table names.
$table
public
mixed
$table
= array('query' => 'slp_rep_query', 'results' => 'slp_rep_query_results', 'locations' => 'store_locator')
$top_results
public
array<string|int, string>
$top_results
Top results array.
$top_results
public
mixed
$top_results
$top_searches
public
array<string|int, string>
$top_searches
Top searches array.
$top_searches
public
mixed
$top_searches
$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
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
booldelete_history_before()
Delete all history entries before the specified date.
public
delete_history_before( $date[, string $limit = '10000' ]) : int|bool
Parameters
Return values
int|booldelete_older_report_data()
Delete report data more than 13 months old, max 100 records at a time.
public
delete_older_report_data() : 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_Objectinitialize()
Things to do at the start.
public
initialize() : mixed
set_properties()
Set our properties.
public
set_properties([array<string|int, mixed> $options = array() ]) : mixed
Parameters
- $options : array<string|int, mixed> = array()
set_result_count()
Set the search count with dates for the given date range.
public
set_result_count(string $start_date, string $end_date) : mixed
dataset['count'] = count (*) dataset['date'] = the date.
Parameters
- $start_date : string
- $end_date : string
set_search_count()
Set the search count with dates for the given date range.
public
set_search_count(string $start_date, string $end_date) : mixed
dataset['count'] = count (*) dataset['date'] = the date.
Parameters
- $start_date : string
- $end_date : string
set_top_results()
Set the top_results dataset for the given date range.
public
set_top_results( $start_date, $end_date[, $limit = 10 ]) : mixed
Parameters
set_top_searches()
Set the top searches dataset for the given date range.
public
set_top_searches( $start_date, $end_date[, $limit = 10 ][, $return_type = OBJECT ]) : mixed