MedraExportPlugin Class Reference

Inheritance diagram for MedraExportPlugin:

Public Member Functions
	depositXML ($objects, $context, $filename)
	getDescription ()
	getDisplayName ()
	getExportDeploymentClassName ()
	getIssueFilter ()
	getName ()
	getPluginSettingsPrefix ()
	getRepresentationFilter ()
	getSettingsFormClassName ()
	getSubmissionFilter ()
Public Member Functions inherited from DOIPubIdExportPlugin
	display ($args, $request)
	getArticleGalleys ($galleyIds)
	getPubIdDisplayType ()
	getPubIdType ()
	getPublishedIssues ($issueIds, $context)
	getPublishedSubmissions ($submissionIds, $context)
	getUnregisteredArticles ($context)
	getUnregisteredGalleys ($context)
	getUnregisteredIssues ($context)
	markRegistered ($context, $objects)
	saveRegisteredDoi ($context, $object, $testPrefix='10.1234')
Public Member Functions inherited from PubObjectsExportPlugin
	_instantiateExportDeployment ($context)
	_instantiateSettingsForm ($context)
	_sendNotification ($user, $message, $notificationType, $param=null)
	addToSchema ($hookName, $params)
	callbackParseCronTab ($hookName, $args)
	executeCLI ($scriptName, &$args)
	executeCLICommand ($scriptName, $command, $context, $outputFile, $objects, $filter, $objectsFileNamePart)
	executeExportAction ($request, $objects, $filter, $tab, $objectsFileNamePart, $noValidation=null)
	exportXML ($objects, $filter, $context, $noValidation=null)
	getAdditionalFieldNames ($hookName, $args)
	getCache ()
	getDepositStatusSettingName ()
	getDepositSuccessNotificationMessageKey ()
	getExportActionNames ()
	getExportActions ($context)
	getStatusActions ($pubObject)
	getStatusMessage ($request)
	getStatusNames ()
	isTestMode ($context)
	manage ($args, $request)
	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
	__construct ()
	_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 ()
	smartyPluginUrl ($params, $smarty)
	updateSchema ($hookName, $args)
	updateSetting ($contextId, $name, $value, $type=null)

Additional Inherited Members
Data Fields inherited from PubObjectsExportPlugin
	$_cache
Data Fields inherited from ImportExportPlugin
	$_request
Data Fields inherited from Plugin
	$pluginCategory
	$pluginPath
	$request
Protected Member Functions inherited from DOIPubIdExportPlugin
	_getObjectAdditionalSettings ()
Protected Member Functions inherited from PubObjectsExportPlugin
	_getDAOs ()
	updateObject ($object)
Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

mEDRA Onix for DOI (O4DOI) export/registration plugin.

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

Member Function Documentation

depositXML()

MedraExportPlugin::depositXML	(		$objects,
			$context,
			$filename
	)

Deposit XML document. This must be implemented in the subclasses, if the action is supported.

Parameters

$objects	mixed Array of or single published submission, issue or galley
$context	Context
$filename	Export XML filename

Returns

boolean Whether the XML document has been registered

Reimplemented from PubObjectsExportPlugin.

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

References PubObjectsExportPlugin\getDepositStatusSettingName(), Plugin\getSetting(), PubObjectsExportPlugin\isTestMode(), and DOIPubIdExportPlugin\saveRegisteredDoi().

getDescription()

MedraExportPlugin::getDescription

(

)

See also

Plugin::getDescription()

Reimplemented from Plugin.

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

getDisplayName()

MedraExportPlugin::getDisplayName

(

)

See also

Plugin::getDisplayName()

Reimplemented from Plugin.

Definition at line 36 of file MedraExportPlugin.inc.php.

getExportDeploymentClassName()

MedraExportPlugin::getExportDeploymentClassName

(

)

Return the name of the plugin's deployment class.

Returns

string

Reimplemented from PubObjectsExportPlugin.

Definition at line 85 of file MedraExportPlugin.inc.php.

getIssueFilter()

MedraExportPlugin::getIssueFilter

(

)

Get the issue filter.

Returns

string|null

Reimplemented from PubObjectsExportPlugin.

Definition at line 57 of file MedraExportPlugin.inc.php.

getName()

MedraExportPlugin::getName

(

)

See also

Plugin::getName()

Reimplemented from Plugin.

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

getPluginSettingsPrefix()

MedraExportPlugin::getPluginSettingsPrefix

(

)

Get the plugin ID used as plugin settings prefix.

Returns

string

Reimplemented from ImportExportPlugin.

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

getRepresentationFilter()

MedraExportPlugin::getRepresentationFilter

(

)

Get the representation filter.

Returns

string|null

Reimplemented from PubObjectsExportPlugin.

Definition at line 64 of file MedraExportPlugin.inc.php.

getSettingsFormClassName()

MedraExportPlugin::getSettingsFormClassName

(

)

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

getSubmissionFilter()

MedraExportPlugin::getSubmissionFilter

(

)

Get the submission filter.

Returns

string|null

Reimplemented from PubObjectsExportPlugin.

Definition at line 50 of file MedraExportPlugin.inc.php.

---

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

• MedraExportPlugin.inc.php