Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
DataciteExportPlugin Class Reference
Inheritance diagram for DataciteExportPlugin:
DOIExportPlugin ImportExportPlugin Plugin PKPPlugin

Public Member Functions

 _getObjectUrl (&$request, &$journal, &$object)
 
_getUnregisteredSuppFiles (&$journal)
 
_prepareSuppFileData (&$suppFile, &$journal)
 
 displayAllUnregisteredObjects (&$templateMgr, &$journal)
 
 displaySuppFileList (&$templateMgr, &$journal)
 
 generateExportFiles (&$request, $exportType, &$objects, $targetPath, &$journal, &$errors)
 
 getAllObjectTypes ()
 
 getDaoName ($exportType)
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getObjectName ($exportType)
 
 getObjectNotFoundErrorKey ($exportType)
 
 getPluginId ()
 
 getSettingsFormClassName ()
 
 registerDoi (&$request, &$journal, &$objects, $file)
 
- Public Member Functions inherited from DOIExportPlugin
 _checkForTar ()
 
 _displayArticleList (&$templateMgr, &$journal)
 
 _displayGalleyList (&$templateMgr, &$journal)
 
 _displayIssueList (&$templateMgr, &$journal)
 
 _displayPluginHomePage (&$templateMgr, &$journal)
 
 _generateExportFilesForObjects (&$request, &$journal, $exportSpec, $exportPath, &$errors)
 
 _getArticleIssue ($article, $journal)
 
 _getExportPath ()
 
_getObjectsFromIds ($exportType, $objectIds, $journalId, &$errors)
 
_getUnregisteredArticles (&$journal)
 
_getUnregisteredGalleys (&$journal)
 
_getUnregisteredIssues (&$journal)
 
_instantiateSettingsForm (&$journal)
 
_prepareArticleData (&$article, &$journal)
 
_prepareArticleDataByArticleId ($articleId, &$journal)
 
_prepareGalleyData (&$galley, &$journal)
 
 _sendNotification (&$request, $message, $notificationType, $param=null)
 
 _usage ($scriptName, $errors=null)
 
 cleanTmpfiles ($tempdir, $tempfiles)
 
 display (&$args, &$request)
 
 displayAllUnregisteredObjects (&$templateMgr, &$journal)
 
 displaySuppFileList (&$templateMgr, &$journal)
 
 executeCLI ($scriptName, &$args)
 
 exportObjects (&$request, $exportSpec, &$journal, $outputFile=null)
 
 generateExportFiles (&$request, $exportType, &$objects, $targetPath, &$journal, &$errors)
 
 getAdditionalFieldNames ($hookName, $args)
 
 getAllObjectTypes ()
 
 getAllPublishedArticles (&$journal)
 
 getContextSpecificPluginSettingsFile ()
 
 getDaoName ($exportType)
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getObjectName ($exportType)
 
 getObjectNotFoundErrorKey ($exportType)
 
 getPluginId ()
 
 getSettingsFormClassName ()
 
 getTargetFileName ($exportPath, $exportType, $objectId=null)
 
 getTemplatePath ()
 
 isTestMode (&$request)
 
 manage ($verb, $args, &$message, &$messageParams, &$request)
 
 markRegistered (&$request, &$object, $testPrefix)
 
prepareArticleFileData (&$articleFile, &$journal)
 
 register ($category, $path)
 
 registerDaoHook ($daoName)
 
 registerDoi (&$request, &$journal, &$objects, $file)
 
 registerObjects (&$request, $exportSpec, &$journal)
 
 resetRegistration ($objectType, $objectId, &$journal)
 
 saveRegisteredDoi (&$object, $registeredDoi)
 
 tarFiles ($targetPath, $targetFile, $sourceFiles)
 
- Public Member Functions inherited from ImportExportPlugin
 display (&$args, $request)
 
 executeCLI ($scriptName, &$args)
 
 getDescription ()
 
 getDisplayName ()
 
 getManagementVerbs ()
 
 getName ()
 
 manage ($verb, $args, $message, $messageParams=null, $request=null)
 
 setBreadcrumbs ($crumbs=array(), $isSubclass=false)
 
 smartyPluginUrl ($params, &$smarty)
 
 usage ($scriptName)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

DataCite export/registration plugin.

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

Member Function Documentation

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

Get the canonical URL of an object.

Parameters
$requestRequest
$journalJournal
$objectIssue|PublishedArticle|ArticleGalley|SuppFile

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

References DAORegistry\getDAO(), DOIExportPlugin\isTestMode(), and String\regexp_replace().

Referenced by registerDoi().

& DataciteExportPlugin::_getUnregisteredSuppFiles ( $journal)

Retrieve all unregistered supplementary files and their corresponding issues and articles.

Parameters
$journalJournal
Returns
array

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

References _prepareSuppFileData(), DAORegistry\getDAO(), and getPluginId().

Referenced by displayAllUnregisteredObjects().

& DataciteExportPlugin::_prepareSuppFileData ( $suppFile,
$journal 
)

Identify published article and issue of the given supp file.

Parameters
$suppFileSuppFile
$journalJournal
Returns
array|null An array with article and issue of the given suppl file. Null will be returned if one of these objects cannot be identified (e.g. when the supp file belongs to an unpublished article).

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

References DOIExportPlugin\prepareArticleFileData().

Referenced by _getUnregisteredSuppFiles(), and displaySuppFileList().

DataciteExportPlugin::displayAllUnregisteredObjects ( $templateMgr,
$journal 
)
DataciteExportPlugin::generateExportFiles ( $request,
  $exportType,
$objects,
  $targetPath,
$journal,
$errors 
)
DataciteExportPlugin::getAllObjectTypes ( )
DataciteExportPlugin::getDaoName (   $exportType)
See Also
DOIExportPlugin::getDaoName()

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

DataciteExportPlugin::getDescription ( )
DataciteExportPlugin::getDisplayName ( )
DataciteExportPlugin::getName ( )
See Also
ImportExportPlugin::getName()

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

DataciteExportPlugin::getObjectName (   $exportType)
DataciteExportPlugin::getObjectNotFoundErrorKey (   $exportType)
DataciteExportPlugin::getPluginId ( )
DataciteExportPlugin::getSettingsFormClassName ( )
DataciteExportPlugin::registerDoi ( $request,
$journal,
$objects,
  $file 
)

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