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) | |
URN plugin class.
Definition at line 19 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::_calculateCheckNo | ( | $urn | ) |
Get the last, check number. Algorithm (s. http://www.persistent-identifier.de/?link=316): every URN character is replaced with a number according to the conversion table, every number is multiplied by it's position/index (beginning with 1), the numbers' sum is calculated, the sum is divided by the last number, the last number of the quotient before the decimal point is the check number.
Definition at line 537 of file URNPubIdPlugin.inc.php.
References strtolower_codesafe().
Referenced by constructPubId().
URNPubIdPlugin::addJavaScript | ( | $request, | |
$templateMgr | |||
) |
Add JavaScript files to be loaded in the metadata file.
$request | PKPRequest |
$templateMgr | PKPTemplateManager |
Reimplemented from PKPPubIdPlugin.
Definition at line 119 of file URNPubIdPlugin.inc.php.
References Plugin\$request.
Referenced by addPublicationFormFields().
URNPubIdPlugin::addPublicationFormFields | ( | $hookName, | |
$form | |||
) |
Add URN fields to the publication identifiers form
$hookName | string Form::config::before |
$form | FormComponent The form object |
Definition at line 345 of file URNPubIdPlugin.inc.php.
References addJavaScript(), PKPServices\get(), PKPApplication\get(), PKPTemplateManager\getManager(), Plugin\getRequest(), and Plugin\getSetting().
URNPubIdPlugin::addPublishFormNotice | ( | $hookName, | |
$form | |||
) |
Show URN during final publish step
$hookName | string Form::config::before |
$form | FormComponent The form object |
Definition at line 419 of file URNPubIdPlugin.inc.php.
References PKPServices\get(), and Plugin\getSetting().
URNPubIdPlugin::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 69 of file URNPubIdPlugin.inc.php.
References _calculateCheckNo(), Plugin\getSetting(), and getSuffixFieldName().
URNPubIdPlugin::getAssignFormFieldName | ( | ) |
Get the assign option form field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 155 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getDAOFieldNames | ( | ) |
Get additional field names to be considered for storage.
Reimplemented from PKPPubIdPlugin.
Definition at line 231 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getDescription | ( | ) |
Get a description of this plugin.
Reimplemented from Plugin.
Definition at line 58 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getDisplayName | ( | ) |
Get the display name for this plugin.
Reimplemented from Plugin.
Definition at line 51 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getFormFieldNames | ( | ) |
Get the additional form field names, for metadata, e.g. suffix field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 148 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getLinkActions | ( | $pubObject | ) |
Get the link actions used in the pub id forms, e.g. clear pub id.
Reimplemented from PKPPubIdPlugin.
Definition at line 176 of file URNPubIdPlugin.inc.php.
References Plugin\$request, and PKPApplication\get().
URNPubIdPlugin::getNotUniqueErrorMsg | ( | ) |
Is this object type enabled in plugin settings
$pubObjectType | object |
$contextId | integer |
Reimplemented from PKPPubIdPlugin.
Definition at line 245 of file URNPubIdPlugin.inc.php.
Referenced by validatePublicationUrn().
URNPubIdPlugin::getPrefixFieldName | ( | ) |
Get the the prefix form field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 162 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getPubIdAssignFile | ( | ) |
Get the file (path + filename) for the pub id assignment to be included into other pages.
Reimplemented from PKPPubIdPlugin.
Definition at line 133 of file URNPubIdPlugin.inc.php.
References Plugin\getTemplateResource().
URNPubIdPlugin::getPubIdDisplayType | ( | ) |
Public identifier type that will be displayed to the reader.
Reimplemented from PKPPubIdPlugin.
Definition at line 90 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getPubIdFullName | ( | ) |
Full name of the public identifier.
Reimplemented from PKPPubIdPlugin.
Definition at line 97 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::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 112 of file URNPubIdPlugin.inc.php.
References Plugin\getTemplateResource().
URNPubIdPlugin::getPubIdType | ( | ) |
Public identifier type, see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html
Reimplemented from PKPPubIdPlugin.
Definition at line 83 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::getResolvingURL | ( | $contextId, | |
$pubId | |||
) |
Get the whole resolving URL.
$contextId | integer |
$pubId | string |
Reimplemented from PKPPubIdPlugin.
Definition at line 104 of file URNPubIdPlugin.inc.php.
References Plugin\getSetting().
URNPubIdPlugin::getSuffixFieldName | ( | ) |
Get the the suffix form field name.
Reimplemented from PKPPubIdPlugin.
Definition at line 169 of file URNPubIdPlugin.inc.php.
Referenced by constructPubId().
URNPubIdPlugin::getSuffixPatternsFieldNames | ( | ) |
Reimplemented from PKPPubIdPlugin.
Definition at line 220 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::instantiateSettingsForm | ( | $contextId | ) |
Get the settings form.
$contextId | integer |
Reimplemented from PKPPubIdPlugin.
Definition at line 140 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::isObjectTypeEnabled | ( | $pubObjectType, | |
$contextId | |||
) |
Is this object type enabled in plugin settings
$pubObjectType | object |
$contextId | integer |
Reimplemented from PKPPubIdPlugin.
Definition at line 238 of file URNPubIdPlugin.inc.php.
References Plugin\getSetting().
URNPubIdPlugin::loadUrnFieldComponent | ( | $hookName, | |
$args | |||
) |
Load the FieldUrn Vue.js component into Vue.js
string | $hookName | |
array | $args |
Definition at line 488 of file URNPubIdPlugin.inc.php.
References PKPApplication\get(), Plugin\getPluginPath(), and Plugin\getRequest().
URNPubIdPlugin::modifyObjectProperties | ( | $hookName, | |
$args | |||
) |
Add URN 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 262 of file URNPubIdPlugin.inc.php.
URNPubIdPlugin::modifyObjectPropertyValues | ( | $hookName, | |
$args | |||
) |
Add URN 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 281 of file URNPubIdPlugin.inc.php.
References PubIdPlugin\getPubId().
URNPubIdPlugin::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 24 of file URNPubIdPlugin.inc.php.
References Plugin\getEnabled(), Config\getVar(), and HookRegistry\register().
URNPubIdPlugin::validatePublicationUrn | ( | $hookName, | |
$args | |||
) |
Validate a publication's URN against the plugin's settings
$hookName | string |
$args | array |
Definition at line 308 of file URNPubIdPlugin.inc.php.
References PubIdPlugin\checkDuplicate(), PKPServices\get(), getNotUniqueErrorMsg(), and Plugin\getSetting().