NativeImportExportPlugin Class Reference
[Plugins_importexport_native]

Native import/export plugin. More...

Inheritance diagram for NativeImportExportPlugin:

List of all members.

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

---

Detailed Description

Native import/export plugin.

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

---

Member Function Documentation

NativeImportExportPlugin.display

(

&$

args

)

Display the import/export plugin UI.

Parameters:

$args

Array The array of arguments the user supplied.

Reimplemented from ImportExportPlugin.

Definition at line 55 of file NativeImportExportPlugin.inc.php.

References ArticleSearch.formatResults(), DAORegistry.getDAO(), TemporaryFileManager.getFile(), Request.getJournal(), TemplateManager.getManager(), Handler.getRangeInfo(), Request.getUser(), Request.getUserVar(), Request.redirect(), ImportExportPlugin.setBreadcrumbs(), and Locale.translate().

NativeImportExportPlugin.executeCLI	(	$	scriptName,
		&$	args
	)

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

Parameters:

$args

Parameters to the plugin

Reimplemented from ImportExportPlugin.

Definition at line 321 of file NativeImportExportPlugin.inc.php.

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

NativeImportExportPlugin.getDescription

(

)

Get a description of the plugin.

Reimplemented from ImportExportPlugin.

Definition at line 51 of file NativeImportExportPlugin.inc.php.

References Locale.translate().

NativeImportExportPlugin.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 47 of file NativeImportExportPlugin.inc.php.

References Locale.translate().

NativeImportExportPlugin.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 43 of file NativeImportExportPlugin.inc.php.

Referenced by usage().

NativeImportExportPlugin.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 32 of file NativeImportExportPlugin.inc.php.

References Plugin.addLocaleData().

NativeImportExportPlugin.usage

(

$

scriptName

)

Display the command-line usage information

Reimplemented from ImportExportPlugin.

Definition at line 491 of file NativeImportExportPlugin.inc.php.

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

Referenced by executeCLI().

---

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

• plugins/importexport/native/NativeImportExportPlugin.inc.php