Open Journal Systems
3.3.0
|
Protected Member Functions | |
getAggregationColumns () | |
isMetricTypeValid ($metricType) | |
Protected Member Functions inherited from Plugin | |
_registerTemplateResource ($inCore=false) | |
Additional Inherited Members | |
Data Fields inherited from Plugin | |
$pluginCategory | |
$pluginPath | |
$request | |
OJS default statistics report plugin (and metrics provider)
Definition at line 19 of file PKPUsageStatsReportPlugin.inc.php.
PKPUsageStatsReportPlugin::display | ( | $args, | |
$request | |||
) |
Definition at line 54 of file PKPUsageStatsReportPlugin.inc.php.
References Plugin\$request, and ReportPlugin\getMetricTypes().
|
protected |
Get aggregation columns, the ones that can be part of any report template not changing it's main purpose.
Definition at line 149 of file PKPUsageStatsReportPlugin.inc.php.
Referenced by OPSUsageStatsReportPlugin\getDefaultReportTemplates(), OMPUsageStatsReportPlugin\getDefaultReportTemplates(), OJSUsageStatsReportPlugin\getDefaultReportTemplates(), and getDefaultReportTemplates().
PKPUsageStatsReportPlugin::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 from ReportPlugin.
Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 104 of file PKPUsageStatsReportPlugin.inc.php.
References getAggregationColumns(), Application\getContextAssocType(), ReportPlugin\getMetricTypes(), and isMetricTypeValid().
PKPUsageStatsReportPlugin::getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 47 of file PKPUsageStatsReportPlugin.inc.php.
PKPUsageStatsReportPlugin::getDisplayName | ( | ) |
Get the display name for this plugin.
Reimplemented from Plugin.
Definition at line 40 of file PKPUsageStatsReportPlugin.inc.php.
PKPUsageStatsReportPlugin::getMetricDisplayType | ( | $metricType | ) |
Public metric type that will be displayed to end users.
$metricType | string One of the values returned from getMetricTypes() |
Reimplemented from ReportPlugin.
Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 90 of file PKPUsageStatsReportPlugin.inc.php.
PKPUsageStatsReportPlugin::getMetricFullName | ( | $metricType | ) |
Full name of the metric type.
$metricType | string One of the values returned from getMetricTypes() |
Reimplemented from ReportPlugin.
Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 97 of file PKPUsageStatsReportPlugin.inc.php.
PKPUsageStatsReportPlugin::getMetrics | ( | $metricType = null , |
|
$columns = null , |
|||
$filters = null , |
|||
$orderBy = null , |
|||
$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 from ReportPlugin.
Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.
Definition at line 80 of file PKPUsageStatsReportPlugin.inc.php.
References DAORegistry\getDAO().
PKPUsageStatsReportPlugin::getName | ( | ) |
Protected methods (may be overridden by custom plugins) Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).
Reimplemented from Plugin.
Definition at line 33 of file PKPUsageStatsReportPlugin.inc.php.
PKPUsageStatsReportPlugin::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 from ReportPlugin.
Definition at line 131 of file PKPUsageStatsReportPlugin.inc.php.
References isMetricTypeValid().
|
protected |
Check the passed metric type against the metric types this plugin implements.
$metricType | array|string |
Definition at line 163 of file PKPUsageStatsReportPlugin.inc.php.
References ReportPlugin\getMetricTypes().
Referenced by getDefaultReportTemplates(), and getOptionalColumns().
PKPUsageStatsReportPlugin::register | ( | $category, | |
$path, | |||
$mainContextId = null |
|||
) |
Load and initialize the plug-in and register plugin hooks.
For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.
$category | String Name of category plugin was registered to |
$path | String The path the plugin was found in |
$mainContextId | integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID. |
Reimplemented from Plugin.
Definition at line 24 of file PKPUsageStatsReportPlugin.inc.php.
References Plugin\addLocaleData().