ViewReportPlugin Class Reference

Inheritance diagram for ViewReportPlugin:

Public Member Functions
	display ($args, $request)
	getDescription ()
	getDisplayName ()
	getName ()
	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 ()
	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 Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

View report plugin.

Definition at line 19 of file ViewReportPlugin.inc.php.

Member Function Documentation

display()

ViewReportPlugin::display	(		$args,
			$request
	)

Definition at line 49 of file ViewReportPlugin.inc.php.

References Plugin\$request, PKPServices\get(), DAORegistry\getDAO(), and PKPString\regexp_replace().

getDescription()

ViewReportPlugin::getDescription

(

)

Get a description of this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 42 of file ViewReportPlugin.inc.php.

getDisplayName()

ViewReportPlugin::getDisplayName

(

)

Get the display name for this plugin.

Returns

string

Reimplemented from Plugin.

Definition at line 38 of file ViewReportPlugin.inc.php.

getName()

ViewReportPlugin::getName

(

)

Get the name of this plugin. The name must be unique within its category.

Returns

String name of plugin

Reimplemented from Plugin.

Definition at line 34 of file ViewReportPlugin.inc.php.

register()

ViewReportPlugin::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 23 of file ViewReportPlugin.inc.php.

References Plugin\addLocaleData().

---

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

• ViewReportPlugin.inc.php