ImportExportPlugin Class Reference
[Plugins]

Abstract class for import/export plugins. More...

Inheritance diagram for ImportExportPlugin:

Plugin METSExportPlugin NativeImportExportPlugin NLMExportPlugin UserImportExportPlugin List of all members.

Public Member Functions

 display (&$args)
 executeCLI ($scriptName, &$args)
 getDescription ()
 getDisplayName ()
 getName ()
 ImportExportPlugin ()
 manage ($verb, $args)
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 smartyPluginUrl ($params, &$smarty)
 usage ($scriptName)

Detailed Description

Abstract class for import/export plugins.

Definition at line 17 of file ImportExportPlugin.inc.php.


Member Function Documentation

ImportExportPlugin.display ( &$  args  ) 

Display the import/export plugin UI.

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

Reimplemented in METSExportPlugin, NativeImportExportPlugin, NLMExportPlugin, and UserImportExportPlugin.

Definition at line 85 of file ImportExportPlugin.inc.php.

References smartyPluginUrl().

ImportExportPlugin.executeCLI ( scriptName,
&$  args 
)

Execute import/export tasks using the command-line interface.

Parameters:
$scriptName The name of the command-line script (displayed as usage info)
$args Parameters to the plugin

Reimplemented in NativeImportExportPlugin, NLMExportPlugin, and UserImportExportPlugin.

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

References usage().

ImportExportPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented in METSExportPlugin, NativeImportExportPlugin, NLMExportPlugin, and UserImportExportPlugin.

Definition at line 46 of file ImportExportPlugin.inc.php.

ImportExportPlugin.getDisplayName (  ) 

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

Returns:
String

Reimplemented in METSExportPlugin, NativeImportExportPlugin, NLMExportPlugin, and UserImportExportPlugin.

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

Referenced by setBreadcrumbs().

ImportExportPlugin.getName (  ) 

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

Returns:
String name of plugin

Reimplemented in METSExportPlugin, NativeImportExportPlugin, NLMExportPlugin, and UserImportExportPlugin.

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

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

ImportExportPlugin.manage ( verb,
args 
)

Perform management functions

Definition at line 110 of file ImportExportPlugin.inc.php.

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

ImportExportPlugin.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 56 of file ImportExportPlugin.inc.php.

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

Referenced by UserImportExportPlugin.display(), NLMExportPlugin.display(), and METSExportPlugin.display().

ImportExportPlugin.smartyPluginUrl ( params,
&$  smarty 
)

Extend the {url ...} smarty to support import/export plugins.

Definition at line 120 of file ImportExportPlugin.inc.php.

References getName().

Referenced by display().

ImportExportPlugin.usage ( scriptName  ) 

Display the command-line usage information

Reimplemented in NativeImportExportPlugin, NLMExportPlugin, and UserImportExportPlugin.

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

Referenced by executeCLI().


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