Public Member Functions | |
| __construct ($apiUrl, $args=array()) | |
| getConfig () | |
| init ($args=array()) | |
Data Fields | |
| $apiUrl = '' | |
| $dateEnd = '' | |
| $dateRangeOptions = [] | |
| $dateStart = '' | |
| $filters = null | |
| $tableColumns = [] | |
Detailed Description
Definition at line 18 of file PKPStatsComponent.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| PKP\components\PKPStatsComponent::__construct | ( | $apiUrl, | |
$args = array() |
|||
| ) |
Constructor
- Parameters
-
$apiUrl string The URL to fetch stats from $args array Optional arguments
Definition at line 61 of file PKPStatsComponent.inc.php.
References PKP\components\PKPStatsComponent\$apiUrl, PKP\components\PKPStatsComponent\init(), and AppLocale\requireComponents().
Member Function Documentation
◆ getConfig()
| PKP\components\PKPStatsComponent::getConfig | ( | ) |
Retrieve the configuration data to be used when initializing this handler on the frontend
- Returns
- array Configuration data
Reimplemented in PKP\components\PKPStatsPublicationPage, and PKP\components\PKPStatsEditorialPage.
Definition at line 88 of file PKPStatsComponent.inc.php.
References PKP\components\PKPStatsComponent\$apiUrl, PKP\components\PKPStatsComponent\$dateEnd, PKP\components\PKPStatsComponent\$dateRangeOptions, PKP\components\PKPStatsComponent\$dateStart, PKP\components\PKPStatsComponent\$filters, and PKP\components\PKPStatsComponent\$tableColumns.
◆ init()
| PKP\components\PKPStatsComponent::init | ( | $args = array() | ) |
Initialize the handler with config parameters
- Parameters
-
$args array Configuration params
Definition at line 74 of file PKPStatsComponent.inc.php.
Referenced by PKP\components\PKPStatsComponent\__construct().
Field Documentation
◆ $apiUrl
| string PKPStatsComponent::$apiUrl = '' |
The URL to the /stats API endpoint
Definition at line 23 of file PKPStatsComponent.inc.php.
Referenced by PKP\components\PKPStatsComponent\__construct(), and PKP\components\PKPStatsComponent\getConfig().
◆ $dateEnd
| string PKPStatsComponent::$dateEnd = '' |
Retrieve stats before this date
Definition at line 41 of file PKPStatsComponent.inc.php.
Referenced by PKP\components\PKPStatsComponent\getConfig().
◆ $dateRangeOptions
| array PKPStatsComponent::$dateRangeOptions = [] |
Quick options to provide for configuring the date range
Definition at line 47 of file PKPStatsComponent.inc.php.
Referenced by PKP\components\PKPStatsComponent\getConfig().
◆ $dateStart
| string PKPStatsComponent::$dateStart = '' |
Retrieve stats after this date
Definition at line 35 of file PKPStatsComponent.inc.php.
Referenced by PKP\components\PKPStatsComponent\getConfig().
◆ $filters
| array null PKPStatsComponent::$filters = null |
Configuration assoc array for available filters
Definition at line 53 of file PKPStatsComponent.inc.php.
Referenced by PKP\components\PKPStatsComponent\getConfig().
◆ $tableColumns
| array PKPStatsComponent::$tableColumns = [] |
Configuration for the columns to display in the table
Definition at line 29 of file PKPStatsComponent.inc.php.
Referenced by PKP\components\PKPStatsComponent\getConfig().
The documentation for this class was generated from the following file:
