Inheritance diagram for CrossRefExportPlugin:

Public Member Functions
	depositOnPublish ($hookName, $args)

	depositXML ($objects, $context, $filename)

	executeCLICommand ($scriptName, $command, $context, $outputFile, $objects, $filter, $objectsFileNamePart)

	executeExportAction ($request, $objects, $filter, $tab, $objectsFileNamePart, $noValidation=null)

	getDepositBatchIdSettingName ()

	getDepositSuccessNotificationMessageKey ()

	getDescription ()

	getDisplayName ()

	getExportActionNames ()

	getExportDeploymentClassName ()

	getFailedMsgSettingName ()

	getName ()

	getPluginSettingsPrefix ()

	getSettingsFormClassName ()

	getStatusActions ($pubObject)

	getStatusMessage ($request)

	getStatusNames ()

	getSubmissionFilter ()

	markRegistered ($context, $objects)

	updateDepositStatus ($context, $object, $status, $batchId, $failedMsg=null)

Public Member Functions inherited from DOIPubIdExportPlugin
	display ($args, $request)

	getArticleGalleys ($galleyIds)

	getPubIdDisplayType ()

	getPubIdType ()

	getPublishedSubmissions ($submissionIds, $context)

	getUnregisteredArticles ($context)

	getUnregisteredGalleys ($context)

	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)

	exportXML ($objects, $filter, $context, $noValidation=null)

	getAdditionalFieldNames ($hookName, $args)

	getCache ()

	getDepositStatusSettingName ()

	getExportActions ($context)

	getRepresentationFilter ()

	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)

Protected Member Functions
	_getObjectAdditionalSettings ()

Protected Member Functions inherited from PubObjectsExportPlugin
	_getDAOs ()

	updateObject ($object)

Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Additional Inherited Members
Data Fields inherited from PubObjectsExportPlugin
	$_cache

Data Fields inherited from ImportExportPlugin
	$_request

Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Detailed Description

CrossRef/MEDLINE XML metadata export plugin.

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

Member Function Documentation

◆ _getObjectAdditionalSettings()

CrossRefExportPlugin::_getObjectAdditionalSettings ( )

protected

Get a list of additional setting names that should be stored with the objects.

Returns: array

Reimplemented from DOIPubIdExportPlugin.

Definition at line 161 of file CrossRefExportPlugin.inc.php.

References getDepositBatchIdSettingName(), and getFailedMsgSettingName().

◆ depositOnPublish()

CrossRefExportPlugin::depositOnPublish	(	$hookName,
		$args
	)

Deposit DOIs on publish

Parameters

$hookName	string
$args	array [ @option Publication The new version of the publication @option Publication The old version of the publication ]

Definition at line 276 of file CrossRefExportPlugin.inc.php.

References Plugin\$request, PubObjectsExportPlugin\_sendNotification(), depositXML(), PubObjectsExportPlugin\exportXML(), PKPServices\get(), PKPApplication\get(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), and getSubmissionFilter().

◆ depositXML()

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

See also: PubObjectsExportPlugin::depositXML()

Parameters

$objects	Submission
$context	Context
$filename	Export XML filename

Reimplemented from PubObjectsExportPlugin.

Definition at line 342 of file CrossRefExportPlugin.inc.php.

References HookRegistry\call(), PKPCurlHelper\getCurlObject(), Plugin\getSetting(), PubObjectsExportPlugin\isTestMode(), updateDepositStatus(), and PubObjectsExportPlugin\updateObject().

Referenced by depositOnPublish(), executeCLICommand(), and executeExportAction().

◆ executeCLICommand()

CrossRefExportPlugin::executeCLICommand	(	$scriptName,
		$command,
		$context,
		$outputFile,
		$objects,
		$filter,
		$objectsFileNamePart
	)

Reimplemented from PubObjectsExportPlugin.

Definition at line 482 of file CrossRefExportPlugin.inc.php.

References depositXML(), PubObjectsExportPlugin\exportXML(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), PluginRegistry\loadCategory(), and PubObjectsExportPlugin\usage().

◆ executeExportAction()

CrossRefExportPlugin::executeExportAction	(	$request,
		$objects,
		$filter,
		$tab,
		$objectsFileNamePart,
		$noValidation = `null`
	)

Execute export action.

Parameters

$request	Request
$objects	array Array of objects to be exported
$filter	string Filter to use
$tab	string Tab to return to
$objectsFileNamePart	string Export file name part for this kind of objects
$noValidation	boolean If set to true no XML validation will be done

Reimplemented from PubObjectsExportPlugin.

Definition at line 192 of file CrossRefExportPlugin.inc.php.

References Plugin\$request, PubObjectsExportPlugin\_sendNotification(), depositXML(), PubObjectsExportPlugin\exportXML(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), and getName().

◆ getDepositBatchIdSettingName()

CrossRefExportPlugin::getDepositBatchIdSettingName ( )

Get deposit batch ID setting name.

Returns: string

Definition at line 468 of file CrossRefExportPlugin.inc.php.

References getPluginSettingsPrefix().

Referenced by _getObjectAdditionalSettings(), and updateDepositStatus().

◆ getDepositSuccessNotificationMessageKey()

CrossRefExportPlugin::getDepositSuccessNotificationMessageKey ( )

Get the locale key used in the notification for the successful deposit.

Reimplemented from PubObjectsExportPlugin.

Definition at line 475 of file CrossRefExportPlugin.inc.php.

◆ getDescription()

CrossRefExportPlugin::getDescription ( )

Get a description of this plugin.

Returns: string

Reimplemented from Plugin.

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

◆ getDisplayName()

CrossRefExportPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns: string

Reimplemented from Plugin.

Definition at line 48 of file CrossRefExportPlugin.inc.php.

◆ getExportActionNames()

CrossRefExportPlugin::getExportActionNames ( )

Get action names.

Returns: array (string action => string text)

Reimplemented from PubObjectsExportPlugin.

Definition at line 149 of file CrossRefExportPlugin.inc.php.

◆ getExportDeploymentClassName()

CrossRefExportPlugin::getExportDeploymentClassName ( )

Return the name of the plugin's deployment class.

Returns: string

Reimplemented from PubObjectsExportPlugin.

Definition at line 185 of file CrossRefExportPlugin.inc.php.

◆ getFailedMsgSettingName()

CrossRefExportPlugin::getFailedMsgSettingName ( )

Get request failed message setting name.

Returns: string

Definition at line 460 of file CrossRefExportPlugin.inc.php.

References getPluginSettingsPrefix().

Referenced by _getObjectAdditionalSettings(), getStatusMessage(), markRegistered(), and updateDepositStatus().

◆ getName()

CrossRefExportPlugin::getName ( )

Protected methods (may be overridden by custom plugins) Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).