PHP Class ImportExportPlugin, pkp-lib

Inheritance: extends Plugin

Public Properties

Property	Type	Description
$_request		Request made available for plugin URL generation

Method	Description
__construct ( )	Constructor
display ( $args, $request )	Display the import/export plugin.
displayXMLValidationErrors ( $errors, $xml )	Display XML validation errors.
executeCLI ( $scriptName, &$args )	Execute import/export tasks using the command-line interface.
getActions ( $request, $actionArgs )
getExportFileName ( $basePath, $objectsFileNamePart, $context, $extension = '.xml' ) : string	Return the whole export file name.
getExportPath ( ) : string	Return the plugin export directory.
getPluginSettingsPrefix ( ) : string	Get the plugin ID used as plugin settings prefix.
isAllowedMethod ( $url ) : boolean	Determine whether the specified URL describes an allowed protocol.
isRelativePath ( $url )	Check if this is a relative path to the xml document that describes public identifiers to be imported.
pluginUrl ( $params, &$smarty ) : string	Generate a URL into the plugin.
usage ( $scriptName )	Display the command-line usage information

Constructor

public __construct ( )

Display the import/export plugin.

Display XML validation errors.

public displayXMLValidationErrors ( $errors, $xml )
$errors		array
$xml		string

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

abstract public executeCLI ( $scriptName, &$args )
$scriptName		The name of the command-line script (displayed as usage info)
$args		Parameters to the plugin

public getActions ( $request, $actionArgs )

Return the whole export file name.

public getExportFileName ( $basePath, $objectsFileNamePart, $context, $extension = '.xml' ) : string
$basePath		string Base path for temporary file storage
$objectsFileNamePart		string Part different for each object type.
$context		Context
$extension		string
return	string

Return the plugin export directory.

public getExportPath ( ) : string
return	string	The export directory path.

Get the plugin ID used as plugin settings prefix.

public getPluginSettingsPrefix ( ) : string
return	string

Determine whether the specified URL describes an allowed protocol.

public isAllowedMethod ( $url ) : boolean
$url		string
return	boolean

Check if this is a relative path to the xml document that describes public identifiers to be imported.

public isRelativePath ( $url )
$url		string path to the xml file

Generate a URL into the plugin.

See also: calling conventions at http://www.smarty.net/docsv2/en/api.register.function.tpl

public pluginUrl ( $params, &$smarty ) : string
$params		array
$smarty		Smarty
return	string

Display the command-line usage information

abstract public usage ( $scriptName )
$scriptName		string

Request made available for plugin URL generation

public $_request