Public Member Functions

Onix30ExportPlugin Class Reference
[Plugins_importexport_onix30]

ONIX 3.0 XML export plugin for monographs. More...

Inheritance diagram for Onix30ExportPlugin:
ImportExportPlugin Plugin

List of all members.

Public Member Functions

 display (&$args)
 executeCLI ($scriptName, &$args)
 getDescription ()
 getDisplayName ()
 getName ()
 register ($category, $path)
 usage ($scriptName)

Detailed Description

ONIX 3.0 XML export plugin for monographs.

Definition at line 18 of file Onix30ExportPlugin.inc.php.

Member Function Documentation

Onix30ExportPlugin.display ( &$  args  ) 

Display the import/export plugin UI.

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

Reimplemented from ImportExportPlugin.

Definition at line 48 of file Onix30ExportPlugin.inc.php.

References Request.getPress().

Onix30ExportPlugin.executeCLI ( $  scriptName,
&$  args 
)

Execute export tasks using the command-line interface.

Parameters:
$args Parameters to the plugin

Reimplemented from ImportExportPlugin.

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

References usage().

Onix30ExportPlugin.getDescription (  ) 

Get a description of the plugin.

Reimplemented from ImportExportPlugin.

Definition at line 44 of file Onix30ExportPlugin.inc.php.

Onix30ExportPlugin.getDisplayName (  ) 

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

Returns:
String

Reimplemented from ImportExportPlugin.

Definition at line 40 of file Onix30ExportPlugin.inc.php.

Onix30ExportPlugin.getName (  ) 

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

Returns:
String name of plugin

Reimplemented from ImportExportPlugin.

Definition at line 36 of file Onix30ExportPlugin.inc.php.

Referenced by usage().

Onix30ExportPlugin.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 iff plugin initialized successfully; if false, the plugin will not be registered.

Definition at line 25 of file Onix30ExportPlugin.inc.php.

Onix30ExportPlugin.usage ( $  scriptName  ) 

Display the command-line usage information

Reimplemented from ImportExportPlugin.

Definition at line 151 of file Onix30ExportPlugin.inc.php.

References getName().

Referenced by executeCLI().

The documentation for this class was generated from the following file:
Generated on Mon Sep 17 2012 13:58:58 for Open Monograph Press by  doxygen 1.7.1