Inheritance diagram for OPSUsageStatsReportPlugin:

Public Member Functions
	getColumns ($metricType)

	getDefaultReportTemplates ($metricTypes=null)

	getMetricDisplayType ($metricType)

	getMetricFullName ($metricType)

	getMetrics ($metricType=null, $columns=null, $filters=null, $orderBy=null, $range=null)

	getMetricTypes ()

	getObjectTypes ($metricType)

Public Member Functions inherited from PKPUsageStatsReportPlugin
	display ($args, $request)

	getDescription ()

	getDisplayName ()

	getName ()

	getOptionalColumns ($metricType)

	register ($category, $path, $mainContextId=null)

Public Member Functions inherited from ReportPlugin
	getActions ($request, $actionArgs)

Public Member Functions inherited from Plugin
	__construct ()

	_overridePluginTemplates ($hookName, $args)

	addLocaleData ($locale=null)

	getCanDisable ()

	getCanEnable ()

	getCategory ()

	getContextSpecificPluginSettingsFile ()

	getCurrentVersion ()

	getDirName ()

	getEnabled ()

	getHideManagement ()

	getInstallControlledVocabFiles ()

	getInstallDataFile ()

	getInstallEmailTemplateDataFile ()

	getInstallEmailTemplatesFile ()

	getInstallFilterConfigFiles ()

	getInstallMigration ()

	getInstallSchemaFile ()

	getInstallSitePluginSettingsFile ()

	getLocaleFilename ($locale)

	getPluginPath ()

&	getRequest ()

	getSeq ()

	getSetting ($contextId, $name)

	getTemplatePath ($inCore=false)

	getTemplateResource ($template=null, $inCore=false)

	import ($class)

	installContextSpecificSettings ($hookName, $args)

	installControlledVocabs ($hookName, $args)

	installData ($hookName, $args)

	installEmailTemplateData ($hookName, $args)

	installEmailTemplates ($hookName, $args)

	installFilters ($hookName, $args)

	installLocale ($hookName, $args)

	installSiteSettings ($hookName, $args)

	isSitePlugin ()

	manage ($args, $request)

	smartyPluginUrl ($params, $smarty)

	updateSchema ($hookName, $args)

	updateSetting ($contextId, $name, $value, $type=null)

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Protected Member Functions inherited from PKPUsageStatsReportPlugin
	getAggregationColumns ()

	isMetricTypeValid ($metricType)

Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

OPS default statistics report plugin (and metrics provider)

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

Member Function Documentation

◆ getColumns()

OPSUsageStatsReportPlugin::getColumns ( $metricType )

Get the columns used in reports by the passed metric type.

Parameters

$metricType string One of the values returned from getMetricTypes()

Returns: null|array Return an array with STATISTICS_DIMENSION_... constants.

Reimplemented from ReportPlugin.

Definition at line 61 of file OPSUsageStatsReportPlugin.inc.php.

◆ getDefaultReportTemplates()

OPSUsageStatsReportPlugin::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.

Parameters

$metricTypes string|array|null Define one or more metric types if you don't want to use all the implemented report metric types.

Returns: array

Reimplemented from PKPUsageStatsReportPlugin.

Definition at line 94 of file OPSUsageStatsReportPlugin.inc.php.

References PKPUsageStatsReportPlugin\getAggregationColumns().

◆ getMetricDisplayType()

OPSUsageStatsReportPlugin::getMetricDisplayType ( $metricType )

Public metric type that will be displayed to end users.

Parameters

$metricType string One of the values returned from getMetricTypes()

Returns: null|string The metric type or null if the plug-in does not support standard metric retrieval or the metric type was not found.

Reimplemented from PKPUsageStatsReportPlugin.

Definition at line 45 of file OPSUsageStatsReportPlugin.inc.php.

◆ getMetricFullName()

OPSUsageStatsReportPlugin::getMetricFullName ( $metricType )

Full name of the metric type.

Parameters

$metricType string One of the values returned from getMetricTypes()

Returns: null|string The full name of the metric type or null if the plug-in does not support standard metric retrieval or the metric type was not found.

Reimplemented from PKPUsageStatsReportPlugin.

Definition at line 53 of file OPSUsageStatsReportPlugin.inc.php.

◆ getMetrics()

OPSUsageStatsReportPlugin::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.

See also: https://pkp.sfu.ca/wiki/index.php/OJSdeStatisticsConcept#Input_and_Output_Formats_.28Aggregation.2C_Filters.2C_Metrics_Data.29 for a full specification of the input and output format of this method.

Parameters

$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

Returns: null|array The selected data as a simple tabular result set or null if metrics are not supported by this plug-in, the specified report is invalid or cannot be produced or another error occurred.

Reimplemented from PKPUsageStatsReportPlugin.

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