Open Journal Systems  3.3.0
ReportPlugin Class Reference
Inheritance diagram for ReportPlugin:
Plugin ArticleReportPlugin CounterReportPlugin PKPUsageStatsReportPlugin ReviewReportPlugin SubscriptionReportPlugin ViewReportPlugin OJSUsageStatsReportPlugin OMPUsageStatsReportPlugin OPSUsageStatsReportPlugin

Public Member Functions

 getActions ($request, $actionArgs)
 
 getColumns ($metricType)
 
 getDefaultReportTemplates ($metricTypes=null)
 
 getMetricDisplayType ($metricType)
 
 getMetricFullName ($metricType)
 
 getMetrics ($metricType=null, $columns=array(), $filters=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ()
 
 getObjectTypes ($metricType)
 
 getOptionalColumns ($metricType)
 
- Public Member Functions inherited from Plugin
 __construct ()
 
 _overridePluginTemplates ($hookName, $args)
 
 addLocaleData ($locale=null)
 
 getCanDisable ()
 
 getCanEnable ()
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDirName ()
 
 getDisplayName ()
 
 getEnabled ()
 
 getHideManagement ()
 
 getInstallControlledVocabFiles ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallMigration ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getName ()
 
 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)
 
 register ($category, $path, $mainContextId=null)
 
 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 Plugin
 _registerTemplateResource ($inCore=false)
 

Detailed Description

Abstract class for report plugins.

Definition at line 18 of file ReportPlugin.inc.php.

Member Function Documentation

◆ getActions()

ReportPlugin::getActions (   $request,
  $actionArgs 
)

Get a list of link actions for plugin management.

Parameters
requestPKPRequest
$actionArgsarray The list of action args to be included in request URLs.
Returns
array List of LinkActions

Reimplemented from Plugin.

Definition at line 128 of file ReportPlugin.inc.php.

References Plugin\$request, Plugin\getEnabled(), and Plugin\getName().

◆ getColumns()

ReportPlugin::getColumns (   $metricType)

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

Parameters
$metricTypestring One of the values returned from getMetricTypes()
Returns
null|array Return an array with STATISTICS_DIMENSION_... constants.

Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.

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

◆ getDefaultReportTemplates()

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.

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

Reimplemented in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.

Definition at line 117 of file ReportPlugin.inc.php.

◆ getMetricDisplayType()

ReportPlugin::getMetricDisplayType (   $metricType)

Public metric type that will be displayed to end users.

Parameters
$metricTypestring 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 in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.

Definition at line 60 of file ReportPlugin.inc.php.

◆ getMetricFullName()

ReportPlugin::getMetricFullName (   $metricType)

Full name of the metric type.

Parameters
$metricTypestring 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 in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.

Definition at line 71 of file ReportPlugin.inc.php.

◆ getMetrics()

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.

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
$metricTypenull|string|array metrics selection
$columnsstring|array column (aggregation level) selection
$filtersarray report-level filter selection
$orderByarray order criteria
$rangenull|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 in PKPUsageStatsReportPlugin, OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.

Definition at line 40 of file ReportPlugin.inc.php.

◆ getMetricTypes()

ReportPlugin::getMetricTypes ( )

Metric types available from this plug-in.

Returns
array An array of metric identifiers (strings) supported by this plugin.

Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.

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

Referenced by PKPUsageStatsReportPlugin\display(), PKPUsageStatsReportPlugin\getDefaultReportTemplates(), and PKPUsageStatsReportPlugin\isMetricTypeValid().

◆ getObjectTypes()

ReportPlugin::getObjectTypes (   $metricType)

Get the object types that the passed metric type counts statistics for.

Parameters
$metricTypestring One of the values returned from getMetricTypes()
Returns
null|array Return an array with ASSOC_TYPE_... constants.

Reimplemented in OJSUsageStatsReportPlugin, OMPUsageStatsReportPlugin, and OPSUsageStatsReportPlugin.

Definition at line 104 of file ReportPlugin.inc.php.

◆ getOptionalColumns()

ReportPlugin::getOptionalColumns (   $metricType)

Get optional columns that are not required for this report to implement the passed metric type.

Parameters
$metricTypestring One of the values returned from getMetricTypes()
Returns
array Return an array with STATISTICS_DIMENSION_... constants.

Reimplemented in PKPUsageStatsReportPlugin.

Definition at line 93 of file ReportPlugin.inc.php.


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