Inheritance diagram for DataciteExportPlugin:

Public Member Functions
	_checkForTar ()

	_getObjectUrl ($request, $context, $object)

	_tarFiles ($targetPath, $targetFile, $sourceFiles)

	depositXML ($object, $context, $filename)

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

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

	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)

	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

DataCite export/registration plugin.

Definition at line 30 of file DataciteExportPlugin.inc.php.

Member Function Documentation

◆ _checkForTar()

DataciteExportPlugin::_checkForTar ( )

Test whether the tar binary is available.

Returns: boolean|array Boolean true if available otherwise an array with an error message.

Definition at line 351 of file DataciteExportPlugin.inc.php.

References Config\getVar().

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

◆ _getObjectUrl()

DataciteExportPlugin::_getObjectUrl	(	$request,
		$context,
		$object
	)

Get the canonical URL of an object.

Parameters

$request	Request
$context	Context
$object	Issue\|Submission\|ArticleGalley

Definition at line 394 of file DataciteExportPlugin.inc.php.

References Plugin\$request, PKPServices\get(), PubObjectsExportPlugin\getCache(), PubObjectsExportPlugin\isTestMode(), and PKPString\regexp_replace().

Referenced by depositXML().

◆ _tarFiles()

DataciteExportPlugin::_tarFiles	(	$targetPath,
		$targetFile,
		$sourceFiles
	)

Create a tar archive.

Parameters

$targetPath	string
$targetFile	string
$sourceFiles	array

Definition at line 369 of file DataciteExportPlugin.inc.php.

References _checkForTar(), and Config\getVar().

Referenced by executeCLICommand(), and executeExportAction().

◆ depositXML()

DataciteExportPlugin::depositXML	(	$object,
		$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 199 of file DataciteExportPlugin.inc.php.

References Plugin\$request, _getObjectUrl(), PKPApplication\get(), PKPCurlHelper\getCurlObject(), PubObjectsExportPlugin\getDepositStatusSettingName(), Plugin\getSetting(), PubObjectsExportPlugin\isTestMode(), PKPString\regexp_replace(), and DOIPubIdExportPlugin\saveRegisteredDoi().

Referenced by executeCLICommand(), and executeExportAction().

◆ executeCLICommand()

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

Reimplemented from PubObjectsExportPlugin.

Definition at line 265 of file DataciteExportPlugin.inc.php.

References _checkForTar(), _tarFiles(), depositXML(), PubObjectsExportPlugin\exportXML(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), and PubObjectsExportPlugin\usage().

◆ executeExportAction()

DataciteExportPlugin::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