Open Journal Systems
3.3.0
|
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 | |
CrossRef/MEDLINE XML metadata export plugin.
Definition at line 36 of file CrossRefExportPlugin.inc.php.
|
protected |
Get a list of additional setting names that should be stored with the objects.
Reimplemented from DOIPubIdExportPlugin.
Definition at line 161 of file CrossRefExportPlugin.inc.php.
References getDepositBatchIdSettingName(), and getFailedMsgSettingName().
CrossRefExportPlugin::depositXML | ( | $objects, | |
$context, | |||
$filename | |||
) |
$objects | Submission |
$context | Context |
$filename | string Export XML filename |
Reimplemented from PubObjectsExportPlugin.
Definition at line 274 of file CrossRefExportPlugin.inc.php.
References HookRegistry\call(), PKPCurlHelper\getCurlObject(), Plugin\getSetting(), PubObjectsExportPlugin\isTestMode(), updateDepositStatus(), and PubObjectsExportPlugin\updateObject().
Referenced by executeCLICommand(), and executeExportAction().
CrossRefExportPlugin::executeCLICommand | ( | $scriptName, | |
$command, | |||
$context, | |||
$outputFile, | |||
$objects, | |||
$filter, | |||
$objectsFileNamePart | |||
) |
Reimplemented from PubObjectsExportPlugin.
Definition at line 414 of file CrossRefExportPlugin.inc.php.
References depositXML(), PubObjectsExportPlugin\exportXML(), ImportExportPlugin\getExportFileName(), ImportExportPlugin\getExportPath(), PluginRegistry\loadCategory(), and PubObjectsExportPlugin\usage().
CrossRefExportPlugin::executeExportAction | ( | $request, | |
$objects, | |||
$filter, | |||
$tab, | |||
$objectsFileNamePart, | |||
$noValidation = null |
|||
) |
Execute export action.
$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 |
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().
CrossRefExportPlugin::getDepositBatchIdSettingName | ( | ) |
Get deposit batch ID setting name.
Definition at line 400 of file CrossRefExportPlugin.inc.php.
References getPluginSettingsPrefix().
Referenced by _getObjectAdditionalSettings(), and updateDepositStatus().
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.
CrossRefExportPlugin::getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 55 of file CrossRefExportPlugin.inc.php.
CrossRefExportPlugin::getDisplayName | ( | ) |
Get the display name for this plugin.
Reimplemented from Plugin.
Definition at line 48 of file CrossRefExportPlugin.inc.php.
CrossRefExportPlugin::getExportActionNames | ( | ) |
Get action names.
Reimplemented from PubObjectsExportPlugin.
Definition at line 149 of file CrossRefExportPlugin.inc.php.
CrossRefExportPlugin::getExportDeploymentClassName | ( | ) |
Return the name of the plugin's deployment class.
Reimplemented from PubObjectsExportPlugin.
Definition at line 185 of file CrossRefExportPlugin.inc.php.
CrossRefExportPlugin::getFailedMsgSettingName | ( | ) |
Get request failed message setting name.
Definition at line 392 of file CrossRefExportPlugin.inc.php.
References getPluginSettingsPrefix().
Referenced by _getObjectAdditionalSettings(), getStatusMessage(), markRegistered(), and updateDepositStatus().
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).
Reimplemented from Plugin.
Definition at line 41 of file CrossRefExportPlugin.inc.php.
Referenced by executeExportAction().
CrossRefExportPlugin::getPluginSettingsPrefix | ( | ) |
Get the plugin ID used as plugin settings prefix.
Reimplemented from ImportExportPlugin.
Definition at line 171 of file CrossRefExportPlugin.inc.php.
Referenced by getDepositBatchIdSettingName(), and getFailedMsgSettingName().
CrossRefExportPlugin::getSettingsFormClassName | ( | ) |
Definition at line 178 of file CrossRefExportPlugin.inc.php.
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.
$pubObject |
Reimplemented from PubObjectsExportPlugin.
Definition at line 80 of file CrossRefExportPlugin.inc.php.
References Plugin\$request, and PKPApplication\get().
CrossRefExportPlugin::getStatusMessage | ( | $request | ) |
Get detailed message of the object status i.e. failure messages. Parameters needed have to be in the request object.
$request | PKPRequest |
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().
CrossRefExportPlugin::getStatusNames | ( | ) |
Get status names for the filter search option.
Reimplemented from PubObjectsExportPlugin.
Definition at line 69 of file CrossRefExportPlugin.inc.php.
CrossRefExportPlugin::getSubmissionFilter | ( | ) |
Get the submission filter.
Reimplemented from PubObjectsExportPlugin.
Definition at line 62 of file CrossRefExportPlugin.inc.php.
CrossRefExportPlugin::markRegistered | ( | $context, | |
$objects | |||
) |
Mark selected submissions or issues as registered.
$context | Context |
$objects | array 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().
CrossRefExportPlugin::updateDepositStatus | ( | $context, | |
$object, | |||
$status, | |||
$batchId, | |||
$failedMsg = null |
|||
) |
Check the CrossRef APIs, if deposits and registration have been successful
$context | Context |
$object | The object getting deposited |
$status | CROSSREF_STATUS_... |
$batchId | string |
$failedMsg | string (opitonal) |
Definition at line 361 of file CrossRefExportPlugin.inc.php.
References getDepositBatchIdSettingName(), PubObjectsExportPlugin\getDepositStatusSettingName(), getFailedMsgSettingName(), and DOIPubIdExportPlugin\saveRegisteredDoi().
Referenced by depositXML().