Onix30ExportPlugin Class Reference

Inheritance diagram for Onix30ExportPlugin:

Public Member Functions
	__construct ()
	display ($args, $request)
	executeCLI ($scriptName, &$args)
	exportSubmissions ($submissionIds, $context, $user)
	getDescription ()
	getDisplayName ()
	getName ()
	getPluginSettingsPrefix ()
	register ($category, $path, $mainContextId=null)
	usage ($scriptName)
Public Member Functions inherited from ImportExportPlugin
	displayXMLValidationErrors ($errors, $xml)
	getActions ($request, $actionArgs)
	getExportFileName ($basePath, $objectsFileNamePart, $context, $extension='.xml')
	getExportPath ()
	isAllowedMethod ($url)
	isRelativePath ($url)
	pluginUrl ($params, $smarty)
Public Member Functions inherited from Plugin
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getCanDisable ()
	getCanEnable ()
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDirName ()
	getEnabled ()
	getHideManagement ()
	getInstallControlledVocabFiles ()
	getInstallDataFile ()
	getInstallEmailTemplateDataFile ()
	getInstallEmailTemplatesFile ()
	getInstallFilterConfigFiles ()
	getInstallMigration ()
	getInstallSchemaFile ()
	getInstallSitePluginSettingsFile ()
	getLocaleFilename ($locale)
	getPluginPath ()
&	getRequest ()
	getSeq ()
	getSetting ($contextId, $name)
	getTemplatePath ($inCore=false)
	getTemplateResource ($template=null, $inCore=false)
	import ($class)
	installContextSpecificSettings ($hookName, $args)
	installControlledVocabs ($hookName, $args)
	installData ($hookName, $args)
	installEmailTemplateData ($hookName, $args)
	installEmailTemplates ($hookName, $args)
	installFilters ($hookName, $args)
	installLocale ($hookName, $args)
	installSiteSettings ($hookName, $args)
	isSitePlugin ()
	manage ($args, $request)
	smartyPluginUrl ($params, $smarty)
	updateSchema ($hookName, $args)
	updateSetting ($contextId, $name, $value, $type=null)

Additional Inherited Members
Data Fields inherited from ImportExportPlugin
	$_request
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

ONIX 3.0 XML import/export plugin.

Definition at line 18 of file Onix30ExportPlugin.inc.php.

Constructor & Destructor Documentation

__construct()

Onix30ExportPlugin::__construct

(

)

Constructor

Reimplemented from Plugin.

Definition at line 22 of file Onix30ExportPlugin.inc.php.

Member Function Documentation

display()

Onix30ExportPlugin::display	(		$args,
			$request
	)

Display the plugin.

Parameters

$args	array
$request	PKPRequest

Reimplemented from ImportExportPlugin.

Definition at line 76 of file Onix30ExportPlugin.inc.php.

References Plugin\$request, exportSubmissions(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), PKPTemplateManager\getManager(), and Plugin\getTemplateResource().

executeCLI()

Onix30ExportPlugin::executeCLI	(		$scriptName,
		&	$args
	)

Reimplemented from ImportExportPlugin.

Definition at line 159 of file Onix30ExportPlugin.inc.php.

References fatalError().

exportSubmissions()

Onix30ExportPlugin::exportSubmissions	(		$submissionIds,
			$context,
			$user
	)

Get the XML for a set of submissions.

Parameters

$submissionIds	array Array of submission IDs
$context	Context
$user	User

Returns

string XML contents representing the supplied submission IDs.

Definition at line 137 of file Onix30ExportPlugin.inc.php.

References fatalError(), and DAORegistry\getDAO().

Referenced by display().

getDescription()

Onix30ExportPlugin::getDescription

(

)

Get the display description.

Returns

string

Reimplemented from Plugin.

Definition at line 60 of file Onix30ExportPlugin.inc.php.

getDisplayName()

Onix30ExportPlugin::getDisplayName

(

)

Get the display name.

Returns

string

Reimplemented from Plugin.

Definition at line 52 of file Onix30ExportPlugin.inc.php.

getName()

Onix30ExportPlugin::getName

(

)

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

Returns

String name of plugin

Reimplemented from Plugin.

Definition at line 44 of file Onix30ExportPlugin.inc.php.

getPluginSettingsPrefix()

Onix30ExportPlugin::getPluginSettingsPrefix

(

)

Get the plugin ID used as plugin settings prefix.

Returns

string

Reimplemented from ImportExportPlugin.

Definition at line 67 of file Onix30ExportPlugin.inc.php.

register()

Onix30ExportPlugin::register	(		$category,
			$path,
			$mainContextId = null
	)

Load and initialize the plug-in and register plugin hooks.

For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.

Parameters

$category	String Name of category plugin was registered to
$path	String The path the plugin was found in
$mainContextId	integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID.

Returns

boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from Plugin.

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

References Plugin\addLocaleData(), Plugin\getEnabled(), and Config\getVar().

usage()

Onix30ExportPlugin::usage

(

$scriptName

)

Display the command-line usage information

Parameters

$scriptName

string

Reimplemented from ImportExportPlugin.

Definition at line 166 of file Onix30ExportPlugin.inc.php.

References fatalError().

---

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

• Onix30ExportPlugin.inc.php