EruditExportPlugin Class Reference
[Plugins_importexport_erudit]

Erudit english DTD article export plugin. More...

Inheritance diagram for EruditExportPlugin:

List of all members.

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

---

Detailed Description

Erudit english DTD article export plugin.

Definition at line 22 of file EruditExportPlugin.inc.php.

---

Member Function Documentation

EruditExportPlugin.display

(

&$

args

)

Display the import/export plugin UI.

Parameters:

$args

Array The array of arguments the user supplied.

Reimplemented from ImportExportPlugin.

Definition at line 52 of file EruditExportPlugin.inc.php.

References ArticleSearch.formatResults(), DAORegistry.getDAO(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), and ImportExportPlugin.setBreadcrumbs().

EruditExportPlugin.executeCLI	(	$	scriptName,
		&$	args
	)

Execute export tasks using the command-line interface.

Parameters:

$args

Parameters to the plugin

Reimplemented from ImportExportPlugin.

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

References DAORegistry.getDAO(), Locale.translate(), and usage().

EruditExportPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from ImportExportPlugin.

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

References Locale.translate().

EruditExportPlugin.getDisplayName

(

)

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

Returns:

String

Reimplemented from ImportExportPlugin.

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

References Locale.translate().

EruditExportPlugin.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 40 of file EruditExportPlugin.inc.php.

Referenced by usage().

EruditExportPlugin.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.

Reimplemented from Plugin.

Definition at line 29 of file EruditExportPlugin.inc.php.

References Plugin.addLocaleData().

EruditExportPlugin.usage

(

$

scriptName

)

Display the command-line usage information

Reimplemented from ImportExportPlugin.

Definition at line 159 of file EruditExportPlugin.inc.php.

References getName(), and Locale.translate().

Referenced by executeCLI().

---

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

• plugins/importexport/erudit/EruditExportPlugin.inc.php