CounterReportPlugin Class Reference

Inheritance diagram for CounterReportPlugin:

Public Member Functions
	_getYears ($useLegacyStats=false)
	display ($args, $request)
	getClassPath ()
	getCurrentRelease ()
	getDescription ()
	getDisplayName ()
	getLocaleFilename ($locale)
	getName ()
	getReporter ($report, $release)
	getReportPath ()
	getValidReports ()
	register ($category, $path, $mainContextId=null)
Public Member Functions inherited from ReportPlugin
	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 ()
	getDirName ()
	getEnabled ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	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 Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

Counter report plugin.

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

Member Function Documentation

_getYears()

CounterReportPlugin::_getYears

(

$useLegacyStats = false

)

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

Parameters

$useLegacyStats

boolean Use the old counter plugin data.

Returns

array

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

References DAORegistry\getDAO().

Referenced by display().

display()

CounterReportPlugin::display	(		$args,
			$request
	)

See also

ReportPlugin::display()

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

References Plugin\$request, _getYears(), getCurrentRelease(), PKPTemplateManager\getManager(), getName(), getReporter(), Plugin\getTemplateResource(), getValidReports(), Validation\isSiteAdmin(), and Validation\redirectLogin().

getClassPath()

CounterReportPlugin::getClassPath

(

)

Get classes path for this plugin.

Returns

string Path to plugin's classes

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

References Plugin\getPluginPath().

Referenced by getReportPath().

getCurrentRelease()

CounterReportPlugin::getCurrentRelease

(

)

Get the latest counter release

Returns

string

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

Referenced by display().

getDescription()

CounterReportPlugin::getDescription

(

)

See also

PKPPlugin::getDescription()

Reimplemented from Plugin.

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

getDisplayName()

CounterReportPlugin::getDisplayName

(

)

See also

PKPPlugin::getDisplayName()

Reimplemented from Plugin.

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

getLocaleFilename()

CounterReportPlugin::getLocaleFilename

(

$locale

)

See also

PKPPlugin::getLocaleFilename($locale)

Reimplemented from Plugin.

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

References Plugin\getPluginPath().

getName()

CounterReportPlugin::getName

(

)

See also

PKPPlugin::getName()

Reimplemented from Plugin.

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

Referenced by display().

getReporter()

CounterReportPlugin::getReporter	(		$report,
			$release
	)

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

Parameters

$report	string Report name
$release	string release identifier

Returns

object

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

Referenced by display().

getReportPath()

CounterReportPlugin::getReportPath

(

)

Return the report path

Returns

string

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

References getClassPath().

Referenced by getValidReports().

getValidReports()

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 84 of file CounterReportPlugin.inc.php.

References getReportPath().

Referenced by display().

register()

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

Parameters

$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.

Returns

boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from Plugin.

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

References Plugin\addLocaleData().

---

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

• CounterReportPlugin.inc.php