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

Public Member Functions

 _http_parse_headers ($raw_headers)
 
 callbackParseCronTab ($hookName, $args)
 
 canBeExported ($foundObject, &$errors)
 
 displayAllUnregisteredObjects (&$templateMgr, &$journal)
 
 displayArticleList (&$templateMgr, &$journal)
 
 displayIssueList (&$templateMgr, &$journal)
 
 generateExportFiles (&$request, $exportType, &$objects, $targetPath, &$journal, &$errors)
 
 getAllObjectTypes ()
 
 getDescription ()
 
 getDisplayName ()
 
 getName ()
 
 getPluginId ()
 
 getSettingsFormClassName ()
 
 processMarkRegistered (&$request, $exportType, &$objects, &$journal)
 
 register ($category, $path)
 
 registerDoi (&$request, &$journal, &$objects, $filename)
 
 updateDepositStatus (&$request, &$journal, $article)
 
- Public Member Functions inherited from DOIExportPlugin
 _checkForTar ()
 
 _displayGalleyList (&$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)
 
 _process (&$request, &$journal)
 
 _sendNotification (&$request, $message, $notificationType, $param=null)
 
 _usage ($scriptName, $errors=null)
 
 callbackParseCronTab ($hookName, $args)
 
 canBeExported ($foundObject, &$errors)
 
 cleanTmpfiles ($tempdir, $tempfiles)
 
 display (&$args, &$request)
 
 displayAllUnregisteredObjects (&$templateMgr, &$journal)
 
 displayArticleList (&$templateMgr, &$journal)
 
 displayIssueList (&$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= '10.1234')
 
prepareArticleFileData (&$articleFile, &$journal)
 
 processMarkRegistered (&$request, $exportType, &$objects, &$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 ()
 
 ImportExportPlugin ()
 
 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

CrossRef export/registration plugin.

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

Member Function Documentation

CrossRefExportPlugin::_http_parse_headers (   $raw_headers)

Parse HTTP headers into an associative array Taken from: http://www.php.net/manual/en/function.http-parse-headers.php#112917

Parameters
$raw_headers
Returns
array

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

Referenced by registerDoi().

CrossRefExportPlugin::callbackParseCronTab (   $hookName,
  $args 
)
See Also
AcronPlugin::parseCronTab()

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

CrossRefExportPlugin::canBeExported (   $foundObject,
$errors 
)

The selected issue can be exported if it contains an article that has a DOI, and the articles containing a DOI also have a date published. The selected article can be exported if it has a DOI and a date published.

Parameters
$foundObjectIssue|PublishedArticle
$errorsarray
Returns
array|boolean

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

References DAORegistry\getDAO().

Referenced by displayIssueList().

CrossRefExportPlugin::displayAllUnregisteredObjects ( $templateMgr,
$journal 
)
CrossRefExportPlugin::displayArticleList ( $templateMgr,
$journal 
)

Display a list of articles for export.

Parameters
$templateMgrTemplateManager
$journalJournal

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

CrossRefExportPlugin::displayIssueList ( $templateMgr,
$journal 
)
CrossRefExportPlugin::generateExportFiles ( $request,
  $exportType,
$objects,
  $targetPath,
$journal,
$errors 
)
CrossRefExportPlugin::getAllObjectTypes ( )
CrossRefExportPlugin::getDescription ( )
CrossRefExportPlugin::getDisplayName ( )
CrossRefExportPlugin::getName ( )
See Also
ImportExportPlugin::getName()

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

CrossRefExportPlugin::getPluginId ( )
See Also
DOIExportPlugin::getPluginId()

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

Referenced by displayIssueList().

CrossRefExportPlugin::getSettingsFormClassName ( )
CrossRefExportPlugin::processMarkRegistered ( $request,
  $exportType,
$objects,
$journal 
)
CrossRefExportPlugin::register (   $category,
  $path 
)
See Also
LazyLoadPlugin::register()

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

References Config\getVar(), and HookRegistry\register().

CrossRefExportPlugin::registerDoi ( $request,
$journal,
$objects,
  $filename 
)
CrossRefExportPlugin::updateDepositStatus ( $request,
$journal,
  $article 
)

This method checks the CrossRef APIs and checks if deposits have been successful

Parameters
$requestRequest
$journalJournal The journal associated with the deposit
$articleArticle The article getting deposited

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

References DAORegistry\getDAO(), Plugin\getSetting(), Config\getVar(), and DOIExportPlugin\markRegistered().

Referenced by registerDoi().


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