ReportPlugin Class Reference
[Plugins]

Abstract class for report plugins. More...

Inheritance diagram for ReportPlugin:

List of all members.

Public Member Functions
	display (&$args)
	getDescription ()
	getDisplayName ()
	getManagementVerbs ()
	getName ()
	manage ($verb, $args)
	setBreadcrumbs ($crumbs=array(), $isSubclass=false)
	smartyPluginUrl ($params, &$smarty)

---

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:

$args

Array The array of arguments the user supplied.

Reimplemented in ArticleReportPlugin.

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

References TemplateManager.getManager().

ReportPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from Plugin.

Reimplemented in ArticleReportPlugin.

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

ReportPlugin.getDisplayName

(

)

Get the display name of this plugin. This name is displayed on the Conference Manager's Reports page, for example.

Returns:

String

Reimplemented from Plugin.

Reimplemented in ArticleReportPlugin.

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

Referenced by setBreadcrumbs().

ReportPlugin.getManagementVerbs

(

)

Display verbs for the management interface.

Reimplemented from Plugin.

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

References Locale.translate().

ReportPlugin.getName

(

)

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

Returns:

String name of plugin

Reimplemented from Plugin.

Reimplemented in ArticleReportPlugin.

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

Referenced by manage(), setBreadcrumbs(), and smartyPluginUrl().

ReportPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

Reimplemented from Plugin.

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

References getName(), and Request.redirect().

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

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

Parameters:

	$crumbs	Array ($url, $name, $isTranslated)
	$subclass	boolean

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

References getDisplayName(), TemplateManager.getManager(), getName(), and Request.url().

ReportPlugin.smartyPluginUrl	(	$	params,
		&$	smarty
	)

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

Reimplemented from Plugin.

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

References getName().

---

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

• classes/plugins/ReportPlugin.inc.php