NLMExportPlugin Class Reference

NLM XML metadata export plugin. More...

Inheritance diagram for NLMExportPlugin:

List of all members.

Public Member Functions
	display (&$args)
	executeCLI ($scriptName, &$args)
	exportPapers (&$results, $outputFile=null)
	getDescription ()
	getDisplayName ()
	getName ()
	register ($category, $path)
	usage ($scriptName)

---

Detailed Description

NLM XML metadata export plugin.

See also:

NLMExportDom

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

---

Member Function Documentation

NLMExportPlugin.display

(

&$

args

)

Display the import/export plugin UI.

Parameters:

$args

Array The array of arguments the user supplied.

Reimplemented from ImportExportPlugin.

Definition at line 50 of file NLMExportPlugin.inc.php.

References exportPapers(), PaperSearch.formatResults(), Request.getConference(), Plugin.getTemplatePath(), and ImportExportPlugin.setBreadcrumbs().

NLMExportPlugin.executeCLI	(	$	scriptName,
		&$	args
	)

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

Parameters:

$args

Parameters to the plugin

Reimplemented from ImportExportPlugin.

Definition at line 122 of file NLMExportPlugin.inc.php.

References exportPapers(), PaperSearch.formatResults(), and usage().

NLMExportPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from ImportExportPlugin.

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

NLMExportPlugin.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 from ImportExportPlugin.

Definition at line 42 of file NLMExportPlugin.inc.php.

NLMExportPlugin.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 38 of file NLMExportPlugin.inc.php.

Referenced by usage().

NLMExportPlugin.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 NLMExportPlugin.inc.php.

NLMExportPlugin.usage

(

$

scriptName

)

Display the command-line usage information

Reimplemented from ImportExportPlugin.

Definition at line 158 of file NLMExportPlugin.inc.php.

References getName().

Referenced by executeCLI().

---

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

• plugins/importexport/nlm/NLMExportPlugin.inc.php

---