Open Journal Systems
3.3.0
|
Additional Inherited Members | |
Data Fields inherited from Plugin | |
$pluginCategory | |
$pluginPath | |
$request | |
Protected Member Functions inherited from Plugin | |
_registerTemplateResource ($inCore=false) | |
DOI plugin class.
Definition at line 18 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::_doiURLEncode | ( | $pubId | ) |
Encode DOI according to ANSI/NISO Z39.84-2005, Appendix E.
$pubId | string |
Definition at line 272 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::addPublicationFormFields | ( | $hookName, | |
$form | |||
) |
Add DOI fields to the publication identifiers form
$hookName | string Form::config::before |
$form | FormComponent The form object |
Definition at line 375 of file DOIPubIdPlugin.inc.php.
References PKPServices\get(), Plugin\getSetting(), PKPString\regexp_replace(), and PKPString\strtolower().
DOIPubIdPlugin::addPublishFormNotice | ( | $hookName, | |
$form | |||
) |
Show DOI during final publish step
$hookName | string Form::config::before |
$form | FormComponent The form object |
Definition at line 443 of file DOIPubIdPlugin.inc.php.
References PKPServices\get(), and Plugin\getSetting().
DOIPubIdPlugin::constructPubId | ( | $pubIdPrefix, | |
$pubIdSuffix, | |||
$contextId | |||
) |
Construct the public identifier from its prefix and suffix.
$pubIdPrefix | string |
$pubIdSuffix | string |
$contextId | integer |
Reimplemented from PKPPubIdPlugin.
Definition at line 68 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getAssignFormFieldName | ( | ) |
Get the assign option form field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 132 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getCitationData | ( | $hookname, | |
$args | |||
) |
Add DOI to citation data used by the CitationStyleLanguage plugin
$hookname | string |
$args | array |
Definition at line 244 of file DOIPubIdPlugin.inc.php.
References PubIdPlugin\getPubId(), and getPubIdType().
DOIPubIdPlugin::getDAOFieldNames | ( | ) |
Get additional field names to be considered for storage.
Reimplemented from PKPPubIdPlugin.
Definition at line 208 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 57 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getDisplayName | ( | ) |
Get the display name for this plugin.
Reimplemented from Plugin.
Definition at line 50 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getFormFieldNames | ( | ) |
Get the additional form field names, for metadata, e.g. suffix field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 125 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getLinkActions | ( | $pubObject | ) |
Get the link actions used in the pub id forms, e.g. clear pub id.
Reimplemented from PKPPubIdPlugin.
Definition at line 153 of file DOIPubIdPlugin.inc.php.
References Plugin\$request, and PKPApplication\get().
DOIPubIdPlugin::getNotUniqueErrorMsg | ( | ) |
Is this object type enabled in plugin settings
$pubObjectType | object |
$contextId | integer |
Reimplemented from PKPPubIdPlugin.
Definition at line 222 of file DOIPubIdPlugin.inc.php.
Referenced by validatePublicationDoi().
DOIPubIdPlugin::getPrefixFieldName | ( | ) |
Get the the prefix form field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 139 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getPubIdAssignFile | ( | ) |
Get the file (path + filename) for the pub id assignment to be included into other pages.
Reimplemented from PKPPubIdPlugin.
Definition at line 110 of file DOIPubIdPlugin.inc.php.
References Plugin\getTemplateResource().
DOIPubIdPlugin::getPubIdDisplayType | ( | ) |
Public identifier type that will be displayed to the reader.
Reimplemented from PKPPubIdPlugin.
Definition at line 82 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getPubIdFullName | ( | ) |
Full name of the public identifier.
Reimplemented from PKPPubIdPlugin.
Definition at line 89 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getPubIdMetadataFile | ( | ) |
Get the file (path + filename) to be included into the object's identifiers tab, e.g. for suffix editing.
Reimplemented from PKPPubIdPlugin.
Definition at line 103 of file DOIPubIdPlugin.inc.php.
References Plugin\getTemplateResource().
DOIPubIdPlugin::getPubIdType | ( | ) |
Public identifier type, see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html
Reimplemented from PKPPubIdPlugin.
Definition at line 75 of file DOIPubIdPlugin.inc.php.
Referenced by getCitationData().
DOIPubIdPlugin::getResolvingURL | ( | $contextId, | |
$pubId | |||
) |
Get the whole resolving URL.
$contextId | integer |
$pubId | string |
Reimplemented from PKPPubIdPlugin.
Definition at line 96 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getSuffixFieldName | ( | ) |
Get the the suffix form field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 146 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::getSuffixPatternsFieldNames | ( | ) |
Get the suffix patterns form field names for all objects.
Reimplemented from PKPPubIdPlugin.
Definition at line 197 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::instantiateSettingsForm | ( | $contextId | ) |
Get the settings form.
$contextId | integer |
Reimplemented from PKPPubIdPlugin.
Definition at line 117 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::isObjectTypeEnabled | ( | $pubObjectType, | |
$contextId | |||
) |
Is this object type enabled in plugin settings
$pubObjectType | object |
$contextId | integer |
Reimplemented from PKPPubIdPlugin.
Definition at line 215 of file DOIPubIdPlugin.inc.php.
References Plugin\getSetting().
DOIPubIdPlugin::modifyObjectProperties | ( | $hookName, | |
$args | |||
) |
Add DOI to submission, issue or galley properties
$hookName | string <Object>::getProperties::summaryProperties or <Object>::getProperties::fullProperties |
$args | array [ @option $props array Existing properties @option $object Submission|Issue|Galley @option $args array Request args ] |
Definition at line 329 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::modifyObjectPropertyValues | ( | $hookName, | |
$args | |||
) |
Add DOI submission, issue or galley values
$hookName | string <Object>::getProperties::values |
$args | array [ @option $values array Key/value store of property values @option $object Submission|Issue|Galley @option $props array Requested properties @option $args array Request args ] |
Definition at line 348 of file DOIPubIdPlugin.inc.php.
References PubIdPlugin\getPubId().
DOIPubIdPlugin::register | ( | $category, | |
$path, | |||
$mainContextId = null |
|||
) |
Load and initialize the plug-in and register plugin hooks.
For backwards compatibility this method will be called whenever the plug-in's category is being loaded. If, however, registerOn() returns an array then this method will only be called when the plug-in is enabled and an entry in the result set of registerOn() matches the current request operation. An empty array matches all request operations.
$category | String Name of category plugin was registered to |
$path | String The path the plugin was found in |
$mainContextId | integer To identify if the plugin is enabled we need a context. This context is usually taken from the request but sometimes there is no context in the request (e.g. when executing CLI commands). Then the main context can be given as an explicit ID. |
Reimplemented from PKPPubIdPlugin.
Definition at line 23 of file DOIPubIdPlugin.inc.php.
References Plugin\getEnabled(), Config\getVar(), and HookRegistry\register().
DOIPubIdPlugin::validatePubId | ( | $pubId | ) |
Check whether the given pubId is valid.
$pubId | string |
Reimplemented from PKPPubIdPlugin.
Definition at line 229 of file DOIPubIdPlugin.inc.php.
DOIPubIdPlugin::validatePublicationDoi | ( | $hookName, | |
$args | |||
) |
Validate a publication's DOI against the plugin's settings
$hookName | string |
$args | array |
Definition at line 285 of file DOIPubIdPlugin.inc.php.
References PubIdPlugin\checkDuplicate(), PKPServices\get(), getNotUniqueErrorMsg(), and Plugin\getSetting().