Open Monograph Press: ImportExportPlugin Class Reference

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 ()
	getManagementVerbLinkAction (&$request, $verb, $defaultUrl)
	getManagementVerbs ()
	getName ()
	manage ($verb, $args)
	smartyPluginUrl ($params, &$smarty)
	usage ($scriptName)

Detailed Description

Abstract class for import/export plugins.

Definition at line 19 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 Onix30ExportPlugin.

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

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

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

References usage().

ImportExportPlugin.getDescription ( )

Get a description of the plugin.

Reimplemented in Onix30ExportPlugin, and UserImportExportPlugin.

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

ImportExportPlugin.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 in Onix30ExportPlugin, and UserImportExportPlugin.

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

ImportExportPlugin.getManagementVerbLinkAction	(	&$	request,
		$	verb,
		$	defaultUrl
	)

See also:: Plugin.getManagementVerbLinkAction()

Reimplemented from Plugin.

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

References getName().

ImportExportPlugin.getManagementVerbs ( )

Display verbs for the management interface.

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

ImportExportPlugin.getName ( )

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

Returns:: String name of plugin

Reimplemented in Onix30ExportPlugin, and UserImportExportPlugin.

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

Referenced by getManagementVerbLinkAction(), and smartyPluginUrl().

ImportExportPlugin.manage	(	$	verb,
		$	args
	)

Perform management functions

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

ImportExportPlugin.smartyPluginUrl	(	$	params,
		&$	smarty
	)

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

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

References getName().

ImportExportPlugin.usage ( $ scriptName )

Display the command-line usage information

Reimplemented in Onix30ExportPlugin, and UserImportExportPlugin.

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

Referenced by executeCLI().

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

classes/plugins/ImportExportPlugin.inc.php