ReportPlugin Class Reference
[Plugins]

Abstract class for report plugins. More...

Inheritance diagram for ReportPlugin:

Plugin PaperReportPlugin RegistrantReportPlugin ReviewReportPlugin List of all members.

Public Member Functions

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

Detailed Description

Abstract class for report plugins.

Definition at line 17 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 PaperReportPlugin, RegistrantReportPlugin, and ReviewReportPlugin.

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

References smartyPluginUrl().

ReportPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented in PaperReportPlugin, RegistrantReportPlugin, and ReviewReportPlugin.

Definition at line 46 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 in PaperReportPlugin, RegistrantReportPlugin, and ReviewReportPlugin.

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

Referenced by setBreadcrumbs().

ReportPlugin.getManagementVerbs (  ) 

Display verbs for the management interface.

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

References Request.getSchedConf().

ReportPlugin.getName (  ) 

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

Returns:
String name of plugin

Reimplemented in PaperReportPlugin, RegistrantReportPlugin, and ReviewReportPlugin.

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

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

ReportPlugin.manage ( verb,
args 
)

Perform management functions

Definition at line 109 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 58 of file ReportPlugin.inc.php.

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

ReportPlugin.smartyPluginUrl ( params,
&$  smarty 
)

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

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

References getName().

Referenced by display().


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7