Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
ReportPlugin Class Reference
Inheritance diagram for ReportPlugin:
Plugin PKPPlugin ArticleReportPlugin CounterReportPlugin ReviewReportPlugin SubscriptionReportPlugin TimedViewReportPlugin UsageStatsReportPlugin ViewReportPlugin

Public Member Functions

 display (&$args)
 
 getColumns ($metricType)
 
 getDefaultReportTemplates ($metricType)
 
 getManagementVerbs ()
 
 getMetricDisplayType ($metricType)
 
 getMetricFullName ($metricType)
 
 getMetrics ($metricType=null, $columns=array(), $filters=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ()
 
 getObjectTypes ($metricType)
 
 manage ($verb, $args)
 
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 
 smartyPluginUrl ($params, &$smarty)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Abstract class for report plugins.

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

Member Function Documentation

ReportPlugin::display ( $args)

Display the import/export plugin UI.

Parameters
$argsArray The array of arguments the user supplied.

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

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.

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

ReportPlugin::getDefaultReportTemplates (   $metricType)

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
$metricTypestring
Returns
array

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

ReportPlugin::getManagementVerbs ( )

Display verbs for the management interface.

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

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.

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

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.

Definition at line 72 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.

See Also
http://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.

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

ReportPlugin::getMetricTypes ( )

Metric types available from this plug-in.

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

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

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.

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

ReportPlugin::manage (   $verb,
  $args 
)

Perform management functions

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

References PKPPlugin\getName(), and PKPRequest\redirect().

ReportPlugin::setBreadcrumbs (   $crumbs = array(),
  $isSubclass = false 
)

Set the page's breadcrumbs, given the plugin's tree of items to append.

Parameters
$crumbsArray ($url, $name, $isTranslated)
$subclassboolean

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

References PKPPlugin\getDisplayName(), PKPPlugin\getName(), and Request\url().

ReportPlugin::smartyPluginUrl (   $params,
$smarty 
)

Extend the {url ...} smarty to support reporting plugins.

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

References PKPPlugin\getName().


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