Open Monograph Press  3.3.0
PKP\components\PKPStatsPublicationPage Class Reference
Inheritance diagram for PKP\components\PKPStatsPublicationPage:
PKP\components\PKPStatsComponent

Public Member Functions

 getConfig ()
 
- Public Member Functions inherited from PKP\components\PKPStatsComponent
 __construct ($apiUrl, $args=array())
 
 init ($args=array())
 

Data Fields

 $count = 30
 
 $items = []
 
 $itemsMax = 0
 
 $orderBy = ''
 
 $orderDirection = 'DESC'
 
 $searchPhrase = ''
 
 $timeline = []
 
 $timelineInterval = STATISTICS_DIMENSION_MONTH
 
 $timelineType = ''
 
- Data Fields inherited from PKP\components\PKPStatsComponent
 $apiUrl = ''
 
 $dateEnd = ''
 
 $dateRangeOptions = []
 
 $dateStart = ''
 
 $filters = null
 
 $tableColumns = []
 

Detailed Description

Definition at line 21 of file PKPStatsPublicationPage.inc.php.

Member Function Documentation

◆ getConfig()

PKP\components\PKPStatsPublicationPage::getConfig ( )

Retrieve the configuration data to be used when initializing this handler on the frontend

Returns
array Configuration data

Reimplemented from PKP\components\PKPStatsComponent.

Definition at line 82 of file PKPStatsPublicationPage.inc.php.

Field Documentation

◆ $count

integer PKPStatsPublicationPage::$count = 30

How many items to show per page

Definition at line 56 of file PKPStatsPublicationPage.inc.php.

◆ $items

array PKPStatsPublicationPage::$items = []

List of items to display stats for

Definition at line 44 of file PKPStatsPublicationPage.inc.php.

◆ $itemsMax

integer PKPStatsPublicationPage::$itemsMax = 0

The maximum number of items that stats can be shown for

Definition at line 50 of file PKPStatsPublicationPage.inc.php.

◆ $orderBy

string PKPStatsPublicationPage::$orderBy = ''

Order items by this property

Definition at line 62 of file PKPStatsPublicationPage.inc.php.

◆ $orderDirection

string PKPStatsPublicationPage::$orderDirection = 'DESC'

Order items in this direction: ASC or DESC

Definition at line 68 of file PKPStatsPublicationPage.inc.php.

◆ $searchPhrase

string PKPStatsPublicationPage::$searchPhrase = ''

A search phrase to filter the list of items

Definition at line 74 of file PKPStatsPublicationPage.inc.php.

◆ $timeline

array PKPStatsPublicationPage::$timeline = []

A timeline of stats (eg - monthly) for a graph

Definition at line 26 of file PKPStatsPublicationPage.inc.php.

◆ $timelineInterval

string PKPStatsPublicationPage::$timelineInterval = STATISTICS_DIMENSION_MONTH

Which time segment (eg - month) is displayed in the graph

Definition at line 32 of file PKPStatsPublicationPage.inc.php.

◆ $timelineType

string PKPStatsPublicationPage::$timelineType = ''

Which views to show in the graph. Supports abstract or galley.

Definition at line 38 of file PKPStatsPublicationPage.inc.php.


The documentation for this class was generated from the following file: