Open Journal Systems  3.3.0
DataciteExportPlugin Class Reference
Inheritance diagram for DataciteExportPlugin:
DOIPubIdExportPlugin PubObjectsExportPlugin ImportExportPlugin Plugin

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
$requestRequest
$contextContext
$objectIssue|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
$targetPathstring
$targetFilestring
$sourceFilesarray

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
$objectsmixed Array of or single published submission, issue or galley
$contextContext
$filenameExport 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 
)

◆ executeExportAction()

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

Execute export action.

Parameters
$requestRequest
$objectsarray Array of objects to be exported
$filterstring Filter to use
$tabstring Tab to return to
$objectsFileNamePartstring Export file name part for this kind of objects
$noValidationboolean If set to true no XML validation will be done

Reimplemented from PubObjectsExportPlugin.

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

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

◆ getDescription()

DataciteExportPlugin::getDescription ( )
See also
Plugin::getDescription()

Reimplemented from Plugin.

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

◆ getDisplayName()

DataciteExportPlugin::getDisplayName ( )
See also
Plugin::getDisplayName()

Reimplemented from Plugin.

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

◆ getExportDeploymentClassName()

DataciteExportPlugin::getExportDeploymentClassName ( )

Return the name of the plugin's deployment class.

Returns
string

Reimplemented from PubObjectsExportPlugin.

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

◆ getIssueFilter()

DataciteExportPlugin::getIssueFilter ( )

Get the issue filter.

Returns
string|null

Reimplemented from PubObjectsExportPlugin.

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

◆ getName()

DataciteExportPlugin::getName ( )
See also
Plugin::getName()

Reimplemented from Plugin.

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

Referenced by executeExportAction().

◆ getPluginSettingsPrefix()

DataciteExportPlugin::getPluginSettingsPrefix ( )

Get the plugin ID used as plugin settings prefix.

Returns
string

Reimplemented from ImportExportPlugin.

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

◆ getRepresentationFilter()

DataciteExportPlugin::getRepresentationFilter ( )

Get the representation filter.

Returns
string|null

Reimplemented from PubObjectsExportPlugin.

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

◆ getSettingsFormClassName()

DataciteExportPlugin::getSettingsFormClassName ( )

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

◆ getSubmissionFilter()

DataciteExportPlugin::getSubmissionFilter ( )

Get the submission filter.

Returns
string|null

Reimplemented from PubObjectsExportPlugin.

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


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