ImportExportPlugin Class Reference
[Plugins]

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

Inheritance diagram for ImportExportPlugin:

List of all members.

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

---

Detailed Description

Abstract class for import/export plugins.

Definition at line 18 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 CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, and UserImportExportPlugin.

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

References TemplateManager.getManager().

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 CrossRefExportPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, and UserImportExportPlugin.

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

References usage().

ImportExportPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from Plugin.

Reimplemented in CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, and UserImportExportPlugin.

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

ImportExportPlugin.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 Plugin.

Reimplemented in CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, and UserImportExportPlugin.

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

Referenced by setBreadcrumbs().

ImportExportPlugin.getManagementVerbs

(

)

Display verbs for the management interface.

Reimplemented from Plugin.

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

References Locale.translate().

ImportExportPlugin.getName

(

)

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

Returns:

String name of plugin

Reimplemented from Plugin.

Reimplemented in CrossRefExportPlugin, DOAJPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, and UserImportExportPlugin.

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

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

ImportExportPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

Reimplemented from Plugin.

Definition at line 119 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 53 of file ImportExportPlugin.inc.php.

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

Referenced by UserImportExportPlugin.display(), PubMedExportPlugin.display(), NativeImportExportPlugin.display(), EruditExportPlugin.display(), DOAJPlugin.display(), and CrossRefExportPlugin.display().

ImportExportPlugin.smartyPluginUrl	(	$	params,
		&$	smarty
	)

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

Reimplemented from Plugin.

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

References getName().

ImportExportPlugin.usage

(

$

scriptName

)

Display the command-line usage information

Reimplemented in CrossRefExportPlugin, EruditExportPlugin, NativeImportExportPlugin, PubMedExportPlugin, SampleImportExportPlugin, and UserImportExportPlugin.

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

Referenced by executeCLI().

---

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

• classes/plugins/ImportExportPlugin.inc.php