Inheritance diagram for DOIPubIdExportPlugin:

Public Member Functions
	display ($args, $request)

	getArticleGalleys ($galleyIds)

	getPubIdDisplayType ()

	getPubIdType ()

	getPublishedSubmissions ($submissionIds, $context)

	getUnregisteredArticles ($context)

	getUnregisteredGalleys ($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)

	depositXML ($objects, $context, $filename)

	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)

	getExportDeploymentClassName ()

	getRepresentationFilter ()

	getStatusActions ($pubObject)

	getStatusMessage ($request)

	getStatusNames ()

	getSubmissionFilter ()

	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 ()

	getPluginSettingsPrefix ()

	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 ()

	getDescription ()

	getDirName ()

	getDisplayName ()

	getEnabled ()

	getHideManagement ()

	getInstallControlledVocabFiles ()

	getInstallDataFile ()

	getInstallEmailTemplateDataFile ()

	getInstallEmailTemplatesFile ()

	getInstallFilterConfigFiles ()

	getInstallMigration ()

	getInstallSchemaFile ()

	getInstallSitePluginSettingsFile ()

	getLocaleFilename ($locale)

	getName ()

	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

Basis class for DOI XML metadata export plugins.

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

Member Function Documentation

◆ _getObjectAdditionalSettings()

DOIPubIdExportPlugin::_getObjectAdditionalSettings ( )

protected

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

Returns: array

Reimplemented from PubObjectsExportPlugin.

Reimplemented in CrossRefExportPlugin.

Definition at line 109 of file DOIPubIdExportPlugin.inc.php.

References ImportExportPlugin\getPluginSettingsPrefix().

◆ display()

DOIPubIdExportPlugin::display	(	$args,
		$request
	)

Display the import/export plugin.

Parameters

$args	array
$request	PKPRequest

Reimplemented from PubObjectsExportPlugin.

Definition at line 28 of file DOIPubIdExportPlugin.inc.php.

References Plugin\$request, PKPTemplateManager\getManager(), Plugin\getTemplateResource(), and PluginRegistry\loadCategory().

◆ getArticleGalleys()

DOIPubIdExportPlugin::getArticleGalleys ( $galleyIds )

Get article galleys with a DOI assigned from gallley IDs.

Parameters

$galleyIds array

Returns: array

Reimplemented from PubObjectsExportPlugin.

Definition at line 177 of file DOIPubIdExportPlugin.inc.php.

References DAORegistry\getDAO().

◆ getPubIdDisplayType()

DOIPubIdExportPlugin::getPubIdDisplayType ( )

Get pub ID display type

Returns: string

Definition at line 68 of file DOIPubIdExportPlugin.inc.php.

◆ getPubIdType()

DOIPubIdExportPlugin::getPubIdType ( )

Get pub ID type

Returns: string

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

◆ getPublishedSubmissions()

DOIPubIdExportPlugin::getPublishedSubmissions	(	$submissionIds,
		$context
	)

Get published submissions with a DOI assigned from submission IDs.

Parameters

$submissionIds	array
$context	Context

Returns: array

Reimplemented from PubObjectsExportPlugin.

Definition at line 163 of file DOIPubIdExportPlugin.inc.php.

References PKPServices\get().

◆ getUnregisteredArticles()

DOIPubIdExportPlugin::getUnregisteredArticles ( $context )

Retrieve all unregistered articles.

Parameters

$context Context

Returns: array

Reimplemented from PubObjectsExportPlugin.

Definition at line 120 of file DOIPubIdExportPlugin.inc.php.

References DAORegistry\getDAO().

◆ getUnregisteredGalleys()

DOIPubIdExportPlugin::getUnregisteredGalleys ( $context )

Retrieve all unregistered galleys.

Parameters

$context Context

Returns: array

Definition at line 141 of file DOIPubIdExportPlugin.inc.php.

References DAORegistry\getDAO().

◆ markRegistered()

DOIPubIdExportPlugin::markRegistered	(	$context,
		$objects
	)

Mark selected submissions as registered.

Parameters

$context	Context
$objects	array Array of published submissions or galleys

Reimplemented from PubObjectsExportPlugin.

Reimplemented in CrossRefExportPlugin.

Definition at line 77 of file DOIPubIdExportPlugin.inc.php.

References PubObjectsExportPlugin\getDepositStatusSettingName(), and saveRegisteredDoi().

◆ saveRegisteredDoi()

DOIPubIdExportPlugin::saveRegisteredDoi	(	$context,
		$object,
		$testPrefix = `'10.1234'`
	)

Saving object's DOI to the object's "registeredDoi" setting. We prefix the setting with the plugin's id so that we do not get name clashes when several DOI registration plug-ins are active at the same time.

Parameters