PaperReportPlugin Class Reference
[Plugins_reports_paper]

Paper report plugin. More...

Inheritance diagram for PaperReportPlugin:

ReportPlugin Plugin List of all members.

Public Member Functions

 display (&$args)
 getDescription ()
 getDisplayName ()
 getMaxAuthorCount (&$authorsIterator)
 getName ()
 mergeAuthors ($authors)
 register ($category, $path)

Detailed Description

Paper report plugin.

See also:
PaperReportDAO

Definition at line 20 of file PaperReportPlugin.inc.php.


Member Function Documentation

PaperReportPlugin.display ( &$  args  ) 

Display the import/export plugin UI.

Parameters:
$args Array The array of arguments the user supplied.

Reimplemented from ReportPlugin.

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

References Request.getConference(), getMaxAuthorCount(), Request.getSchedConf(), and mergeAuthors().

PaperReportPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from ReportPlugin.

Definition at line 51 of file PaperReportPlugin.inc.php.

PaperReportPlugin.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 ReportPlugin.

Definition at line 47 of file PaperReportPlugin.inc.php.

PaperReportPlugin.getMaxAuthorCount ( &$  authorsIterator  ) 

Get the highest author count for any paper (to determine how many columns to set)

Parameters:
$authorsIterator DBRowIterator
Returns:
int

Definition at line 206 of file PaperReportPlugin.inc.php.

Referenced by display().

PaperReportPlugin.getName (  ) 

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

Returns:
String name of plugin

Reimplemented from ReportPlugin.

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

PaperReportPlugin.mergeAuthors ( authors  ) 

Flatten an array of author information into one array and append author sequence to each key

Parameters:
$authors array
Returns:
array

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

Referenced by display().

PaperReportPlugin.register ( category,
path 
)

Called as a plugin is registered to the registry

Parameters:
$category String Name of category plugin was registered to
Returns:
boolean True if plugin initialized successfully; if false, the plugin will not be registered.

Reimplemented from Plugin.

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


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