Open Journal Systems
3.3.0
|
Additional Inherited Members | |
Data Fields inherited from Plugin | |
$pluginCategory | |
$pluginPath | |
$request | |
Protected Member Functions inherited from Plugin | |
_registerTemplateResource ($inCore=false) | |
Abstract class for report plugins.
Definition at line 18 of file ReportPlugin.inc.php.
ReportPlugin::getActions | ( | $request, | |
$actionArgs | |||
) |
Get a list of link actions for plugin management.
request | PKPRequest |
$actionArgs | array The list of action args to be included in request URLs. |
Reimplemented from Plugin.
Definition at line 128 of file ReportPlugin.inc.php.
References Plugin\$request, Plugin\getEnabled(), and Plugin\getName().
ReportPlugin::getColumns | ( | $metricType | ) |
Get the columns used in reports by the passed metric type.
$metricType | string One of the values returned from getMetricTypes() |
Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 82 of file ReportPlugin.inc.php.
ReportPlugin::getDefaultReportTemplates | ( | $metricTypes = null | ) |
Get the default report templates that each report plugin can implement, with an string to represent it. Subclasses can override this method to add/remove default formats.
$metricTypes | string|array|null Define one or more metric types if you don't want to use all the implemented report metric types. |
Reimplemented in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 117 of file ReportPlugin.inc.php.
ReportPlugin::getMetricDisplayType | ( | $metricType | ) |
Public metric type that will be displayed to end users.
$metricType | string One of the values returned from getMetricTypes() |
Reimplemented in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 60 of file ReportPlugin.inc.php.
ReportPlugin::getMetricFullName | ( | $metricType | ) |
Full name of the metric type.
$metricType | string One of the values returned from getMetricTypes() |
Reimplemented in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 71 of file ReportPlugin.inc.php.
ReportPlugin::getMetrics | ( | $metricType = null , |
|
$columns = array() , |
|||
$filters = array() , |
|||
$orderBy = array() , |
|||
$range = null |
|||
) |
Retrieve a range of aggregate, filtered, ordered metric values, i.e. a statistics report.
$metricType | null|string|array metrics selection |
$columns | string|array column (aggregation level) selection |
$filters | array report-level filter selection |
$orderBy | array order criteria |
$range | null|DBResultRange paging specification |
Reimplemented in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 40 of file ReportPlugin.inc.php.
ReportPlugin::getMetricTypes | ( | ) |
Metric types available from this plug-in.
Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 50 of file ReportPlugin.inc.php.
Referenced by PKPUsageStatsReportPlugin\display(), PKPUsageStatsReportPlugin\getDefaultReportTemplates(), and PKPUsageStatsReportPlugin\isMetricTypeValid().
ReportPlugin::getObjectTypes | ( | $metricType | ) |
Get the object types that the passed metric type counts statistics for.
$metricType | string One of the values returned from getMetricTypes() |
Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 104 of file ReportPlugin.inc.php.
ReportPlugin::getOptionalColumns | ( | $metricType | ) |
Get optional columns that are not required for this report to implement the passed metric type.
$metricType | string One of the values returned from getMetricTypes() |
Reimplemented in PKPUsageStatsReportPlugin.
Definition at line 93 of file ReportPlugin.inc.php.