Open Journal Systems  2.4.8
 All Classes Namespaces Functions Variables Groups Pages
CounterReportPlugin Class Reference
Inheritance diagram for CounterReportPlugin:
ReportPlugin Plugin PKPPlugin

Public Member Functions

 _getYears ($useLegacyStats=false)
 
 display (&$args, &$request)
 
 getClassPath ()
 
 getCurrentRelease ()
 
 getDescription ()
 
 getDisplayName ()
 
 getLocaleFilename ($locale)
 
 getName ()
 
 getReporter ($report, $release)
 
 getReportPath ()
 
 getTemplatePath ()
 
 getValidReports ()
 
 register ($category, $path)
 
 setBreadcrumbs ()
 
- Public Member Functions inherited from ReportPlugin
 display ($args, $request)
 
 getColumns ($metricType)
 
 getDefaultReportTemplates ($metricType)
 
 getManagementVerbs ()
 
 getMetricDisplayType ($metricType)
 
 getMetricFullName ($metricType)
 
 getMetrics ($metricType=null, $columns=array(), $filters=array(), $orderBy=array(), $range=null)
 
 getMetricTypes ()
 
 getObjectTypes ($metricType)
 
 getOptionalColumns ($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

Counter report plugin.

Definition at line 23 of file CounterReportPlugin.inc.php.

Member Function Documentation

CounterReportPlugin::_getYears (   $useLegacyStats = false)

Get the years for which log entries exist in the DB.

Parameters
$useLegacyStatsboolean Use the old counter plugin data.
Returns
array

Definition at line 252 of file CounterReportPlugin.inc.php.

References DAORegistry\getDAO().

Referenced by display().

CounterReportPlugin::getClassPath ( )

Get classes path for this plugin.

Returns
string Path to plugin's classes

Definition at line 129 of file CounterReportPlugin.inc.php.

References PKPPlugin\getPluginPath().

Referenced by getReportPath().

CounterReportPlugin::getCurrentRelease ( )

Get the latest counter release

Returns
string

Definition at line 85 of file CounterReportPlugin.inc.php.

Referenced by display().

CounterReportPlugin::getDescription ( )
See Also
PKPPlugin::getDescription()

Definition at line 70 of file CounterReportPlugin.inc.php.

CounterReportPlugin::getDisplayName ( )
See Also
PKPPlugin::getDisplayName()

Definition at line 63 of file CounterReportPlugin.inc.php.

CounterReportPlugin::getLocaleFilename (   $locale)
See Also
PKPPlugin::getLocaleFilename($locale)

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

References PKPPlugin\getPluginPath().

CounterReportPlugin::getName ( )
See Also
PKPPlugin::getName()

Definition at line 56 of file CounterReportPlugin.inc.php.

Referenced by getReporter().

CounterReportPlugin::getReporter (   $report,
  $release 
)

Get a COUNTER Reporter Object Must exist in the report path as {Report}_r{release}.inc.php

Parameters
$reportstring Report name
$releasestring release identifier
Returns
object

Definition at line 113 of file CounterReportPlugin.inc.php.

References getName().

Referenced by display().

CounterReportPlugin::getReportPath ( )

Return the report path

Returns
string

Definition at line 138 of file CounterReportPlugin.inc.php.

References getClassPath().

Referenced by getValidReports().

CounterReportPlugin::getTemplatePath ( )
See Also
PKPPlugin::getTemplatePath()

Definition at line 77 of file CounterReportPlugin.inc.php.

Referenced by display().

CounterReportPlugin::getValidReports ( )

List the valid reports Must exist in the report path as {Report}_r{release}.inc.php

Returns
array multidimentional array release => array( report => reportClassName )

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

References getReportPath().

Referenced by display().

CounterReportPlugin::register (   $category,
  $path 
)
See Also
PKPPlugin::register($category, $path)

Definition at line 28 of file CounterReportPlugin.inc.php.

References PKPPlugin\addLocaleData().

CounterReportPlugin::setBreadcrumbs ( )
See Also
ReportPlugin::setBreadcrumbs()

Definition at line 145 of file CounterReportPlugin.inc.php.

References Request\url().

Referenced by display().


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