Open Journal Systems
3.3.0
|
Public Member Functions | |
__construct () | |
canonicalizeMetricTypes ($metricType, $context, $defaultSiteMetricType, $siteMetricTypes) | |
getAllMetricTypeStrings () | |
getColumnNames ($column=null) | |
& | getContext ($filter) |
getFileTypesArray () | |
getFileTypeString ($fileType=null) | |
& | getGeoLocationTool () |
getObjectTypeString ($assocType=null) | |
& | getReportPluginByMetricType ($metricType) |
getReportUrl ($request, $metricType, $columns, $filter, $orderBy=array()) | |
Protected Member Functions | |
getAppColumnTitle ($column) | |
getReportColumnsArray () | |
getReportObjectTypesArray () | |
Statistics helper class.
Definition at line 61 of file PKPStatisticsHelper.inc.php.
PKPStatisticsHelper::__construct | ( | ) |
Definition at line 63 of file PKPStatisticsHelper.inc.php.
PKPStatisticsHelper::canonicalizeMetricTypes | ( | $metricType, | |
$context, | |||
$defaultSiteMetricType, | |||
$siteMetricTypes | |||
) |
Identify and canonicalize the filtered metric type.
$metricType | string|array A wildcard can be used to identify all metric types. |
$context | null|Context |
$defaultSiteMetricType | string |
$siteMetricTypes | array |
Definition at line 103 of file PKPStatisticsHelper.inc.php.
PKPStatisticsHelper::getAllMetricTypeStrings | ( | ) |
Get metric type display strings implemented by all available report plugins.
Definition at line 179 of file PKPStatisticsHelper.inc.php.
References PluginRegistry\loadCategory().
|
abstractprotected |
Get an application specific column name.
$column | string One of the statistics column constant. |
Reimplemented in StatisticsHelper.
Referenced by getReportColumnsArray().
PKPStatisticsHelper::getColumnNames | ( | $column = null | ) |
Get report column name.
$column | string (optional) |
Definition at line 200 of file PKPStatisticsHelper.inc.php.
References getReportColumnsArray().
& PKPStatisticsHelper::getContext | ( | $filter | ) |
Check whether the filter filters on a context and if so: retrieve it.
NB: We do not check filters below the context level as this would be unnecessarily complex. We'd have to check whether the given publication objects are actually from the same context. This again would require us to retrieve all context objects for the filtered objects, etc.
$filter | array |
Definition at line 79 of file PKPStatisticsHelper.inc.php.
References Application\getContextDAO().
PKPStatisticsHelper::getFileTypesArray | ( | ) |
Get all file types that have statistics, with their respective names as array values.
Definition at line 334 of file PKPStatisticsHelper.inc.php.
Referenced by getFileTypeString().
PKPStatisticsHelper::getFileTypeString | ( | $fileType = null | ) |
Get file type string.
$fileType | mixed int or null (optional) |
Definition at line 238 of file PKPStatisticsHelper.inc.php.
References getFileTypesArray().
& PKPStatisticsHelper::getGeoLocationTool | ( | ) |
Get the geo location tool.
Definition at line 282 of file PKPStatisticsHelper.inc.php.
References PluginRegistry\getPlugin().
PKPStatisticsHelper::getObjectTypeString | ( | $assocType = null | ) |
Get object type string.
$assocType | mixed int or null (optional) |
Definition at line 219 of file PKPStatisticsHelper.inc.php.
References getReportObjectTypesArray().
|
protected |
Get all statistics report columns, with their respective names as array values.
Reimplemented in StatisticsHelper.
Definition at line 300 of file PKPStatisticsHelper.inc.php.
References getAppColumnTitle().
Referenced by getColumnNames().
|
protected |
Get all statistics report public objects, with their respective names as array values.
Reimplemented in StatisticsHelper.
Definition at line 323 of file PKPStatisticsHelper.inc.php.
Referenced by getObjectTypeString().
& PKPStatisticsHelper::getReportPluginByMetricType | ( | $metricType | ) |
Get the report plugin that implements the passed metric type.
$metricType | string |
Definition at line 147 of file PKPStatisticsHelper.inc.php.
References PluginRegistry\loadCategory().
PKPStatisticsHelper::getReportUrl | ( | $request, | |
$metricType, | |||
$columns, | |||
$filter, | |||
$orderBy = array() |
|||
) |
Get an url that requests a statiscs report, using the passed parameters as request arguments.
$request | PKPRequest |
$metricType | string Report metric type. |
$columns | array Report columns |
$filter | array Report filters. |
$orderBy | array (optional) Report order by values. |
Definition at line 262 of file PKPStatisticsHelper.inc.php.