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

Public Member Functions

 depositXML ($objects, $context, $filename)
 
 executeCLICommand ($scriptName, $command, $context, $outputFile, $objects, $filter, $objectsFileNamePart)
 
 executeExportAction ($request, $objects, $filter, $tab, $objectsFileNamePart, $noValidation=null)
 
 getDepositBatchIdSettingName ()
 
 getDepositSuccessNotificationMessageKey ()
 
 getDescription ()
 
 getDisplayName ()
 
 getExportActionNames ()
 
 getExportDeploymentClassName ()
 
 getFailedMsgSettingName ()
 
 getName ()
 
 getPluginSettingsPrefix ()
 
 getSettingsFormClassName ()
 
 getStatusActions ($pubObject)
 
 getStatusMessage ($request)
 
 getStatusNames ()
 
 getSubmissionFilter ()
 
 markRegistered ($context, $objects)
 
 updateDepositStatus ($context, $object, $status, $batchId, $failedMsg=null)
 
- 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)
 
 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 ()
 
 getExportActions ($context)
 
 getIssueFilter ()
 
 getRepresentationFilter ()
 
 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)
 

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

CrossRef/MEDLINE XML metadata export plugin.

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

Member Function Documentation

◆ _getObjectAdditionalSettings()

CrossRefExportPlugin::_getObjectAdditionalSettings ( )
protected

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

Returns
array

Reimplemented from DOIPubIdExportPlugin.

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

References getDepositBatchIdSettingName(), and getFailedMsgSettingName().

◆ depositXML()

CrossRefExportPlugin::depositXML (   $objects,
  $context,
  $filename 
)

◆ executeCLICommand()

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

◆ executeExportAction()

CrossRefExportPlugin::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 192 of file CrossRefExportPlugin.inc.php.

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

◆ getDepositBatchIdSettingName()

CrossRefExportPlugin::getDepositBatchIdSettingName ( )

Get deposit batch ID setting name.

Returns
string

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

References getPluginSettingsPrefix().

Referenced by _getObjectAdditionalSettings(), and updateDepositStatus().

◆ getDepositSuccessNotificationMessageKey()

CrossRefExportPlugin::getDepositSuccessNotificationMessageKey ( )

Get the locale key used in the notification for the successful deposit.

Reimplemented from PubObjectsExportPlugin.

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

◆ getDescription()

CrossRefExportPlugin::getDescription ( )

Get a description of this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getDisplayName()

CrossRefExportPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns
string

Reimplemented from Plugin.

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

◆ getExportActionNames()

CrossRefExportPlugin::getExportActionNames ( )

Get action names.

Returns
array (string action => string text)

Reimplemented from PubObjectsExportPlugin.

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

◆ getExportDeploymentClassName()

CrossRefExportPlugin::getExportDeploymentClassName ( )

Return the name of the plugin's deployment class.

Returns
string

Reimplemented from PubObjectsExportPlugin.

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

◆ getFailedMsgSettingName()

CrossRefExportPlugin::getFailedMsgSettingName ( )

Get request failed message setting name.

Returns
string

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

References getPluginSettingsPrefix().

Referenced by _getObjectAdditionalSettings(), getStatusMessage(), markRegistered(), and updateDepositStatus().

◆ getName()

CrossRefExportPlugin::getName ( )

Protected methods (may be overridden by custom plugins) Get the name of this plugin. The name must be unique within its category, and should be suitable for part of a filename (ie short, no spaces, and no dependencies on cases being unique).

Returns
string name of plugin

Reimplemented from Plugin.

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

Referenced by executeExportAction().

◆ getPluginSettingsPrefix()

CrossRefExportPlugin::getPluginSettingsPrefix ( )

Get the plugin ID used as plugin settings prefix.

Returns
string

Reimplemented from ImportExportPlugin.

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

Referenced by getDepositBatchIdSettingName(), and getFailedMsgSettingName().

◆ getSettingsFormClassName()

CrossRefExportPlugin::getSettingsFormClassName ( )

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

◆ getStatusActions()

CrossRefExportPlugin::getStatusActions (   $pubObject)

Get status actions for the display to the user, i.e. links to a web site with more information about the status.

Parameters
$pubObject
Returns
array (string status => link)

Reimplemented from PubObjectsExportPlugin.

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

References Plugin\$request, and PKPApplication\get().

◆ getStatusMessage()

CrossRefExportPlugin::getStatusMessage (   $request)

Get detailed message of the object status i.e. failure messages. Parameters needed have to be in the request object.

Parameters
$requestPKPRequest
Returns
string Preformatted text that will be displayed in a div element in the modal

Reimplemented from PubObjectsExportPlugin.

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

References Plugin\$request, PKPCurlHelper\getCurlObject(), DAORegistry\getDAO(), getFailedMsgSettingName(), Plugin\getSetting(), and PubObjectsExportPlugin\isTestMode().

◆ getStatusNames()

CrossRefExportPlugin::getStatusNames ( )

Get status names for the filter search option.

Returns
array (string status => string text)

Reimplemented from PubObjectsExportPlugin.

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

◆ getSubmissionFilter()

CrossRefExportPlugin::getSubmissionFilter ( )

Get the submission filter.

Returns
string|null

Reimplemented from PubObjectsExportPlugin.

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

◆ markRegistered()

CrossRefExportPlugin::markRegistered (   $context,
  $objects 
)

Mark selected submissions or issues as registered.

Parameters
$contextContext
$objectsarray Array of published submissions, issues or galleys

Reimplemented from DOIPubIdExportPlugin.

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

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

◆ updateDepositStatus()

CrossRefExportPlugin::updateDepositStatus (   $context,
  $object,
  $status,
  $batchId,
  $failedMsg = null 
)

Check the CrossRef APIs, if deposits and registration have been successful

Parameters
$contextContext
$objectThe object getting deposited
$statusCROSSREF_STATUS_...
$batchIdstring
$failedMsgstring (opitonal)

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

References getDepositBatchIdSettingName(), PubObjectsExportPlugin\getDepositStatusSettingName(), getFailedMsgSettingName(), and DOIPubIdExportPlugin\saveRegisteredDoi().

Referenced by depositXML().


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