Inheritance diagram for DOIPubIdPlugin:

Public Member Functions
	_doiURLEncode ($pubId)

	addPublicationFormFields ($hookName, $form)

	addPublishFormNotice ($hookName, $form)

	constructPubId ($pubIdPrefix, $pubIdSuffix, $contextId)

	getAssignFormFieldName ()

	getDAOFieldNames ()

	getDescription ()

	getDisplayName ()

	getFormFieldNames ()

	getLinkActions ($pubObject)

	getNotUniqueErrorMsg ()

	getPrefixFieldName ()

	getPubIdAssignFile ()

	getPubIdDisplayType ()

	getPubIdFullName ()

	getPubIdMetadataFile ()

	getPubIdType ()

	getResolvingURL ($contextId, $pubId)

	getSuffixFieldName ()

	getSuffixPatternsFieldNames ()

	instantiateSettingsForm ($contextId)

	isObjectTypeEnabled ($pubObjectType, $contextId)

	modifyObjectProperties ($hookName, $args)

	modifyObjectPropertyValues ($hookName, $args)

	register ($category, $path, $mainContextId=null)

	validatePubId ($pubId)

	validatePublicationDoi ($hookName, $args)

Public Member Functions inherited from PubIdPlugin
	__construct ()

	checkDuplicate ($pubId, $pubObjectType, $excludeId, $contextId)

	getDAOs ()

	getPubId ($pubObject)

	getPubObjectTypes ()

Public Member Functions inherited from PKPPubIdPlugin
	addJavaScript ($request, $templateMgr)

	addToSchema ($hookName, $params)

	canBeAssigned ($pubObject)

	getActions ($request, $actionArgs)

	getAdditionalFieldNames ($hookName, $params)

	getContext ($contextId)

	getFileDAODelegates ()

	getPubObjectType ($pubObject)

	manage ($args, $request)

	setStoredPubId (&$pubObject, $pubId)

	verifyData ($fieldName, $fieldValue, $pubObject, $contextId, &$errorMsg)

Public Member Functions inherited from LazyLoadPlugin
	getCanDisable ()

	getCanEnable ()

	getCurrentContextId ()

	getEnabled ($contextId=null)

	getName ()

	setEnabled ($enabled)

Public Member Functions inherited from Plugin
	_overridePluginTemplates ($hookName, $args)

	addLocaleData ($locale=null)

	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)

Additional Inherited Members
Data Fields inherited from Plugin
	$pluginCategory

	$pluginPath

	$request

Protected Member Functions inherited from Plugin
	_registerTemplateResource ($inCore=false)

Detailed Description

DOI plugin class.

Definition at line 19 of file DOIPubIdPlugin.inc.php.

Member Function Documentation

◆ _doiURLEncode()

DOIPubIdPlugin::_doiURLEncode ( $pubId )

Encode DOI according to ANSI/NISO Z39.84-2005, Appendix E.

Parameters

$pubId string

Returns: string

Definition at line 219 of file DOIPubIdPlugin.inc.php.

◆ addPublicationFormFields()

DOIPubIdPlugin::addPublicationFormFields	(	$hookName,
		$form
	)

Add DOI fields to the publication identifiers form

Parameters

$hookName	string Form::config::before
$form	FormComponent The form object

Definition at line 312 of file DOIPubIdPlugin.inc.php.

References PKPServices\get(), and Plugin\getSetting().

◆ addPublishFormNotice()

DOIPubIdPlugin::addPublishFormNotice	(	$hookName,
		$form
	)

Show DOI during final publish step

Parameters

$hookName	string Form::config::before
$form	FormComponent The form object

Definition at line 377 of file DOIPubIdPlugin.inc.php.

References PKPServices\get(), and Plugin\getSetting().

◆ constructPubId()

DOIPubIdPlugin::constructPubId	(	$pubIdPrefix,
		$pubIdSuffix,
		$contextId
	)

Construct the public identifier from its prefix and suffix.

Parameters

$pubIdPrefix	string
$pubIdSuffix	string
$contextId	integer

Returns: string

Reimplemented from PKPPubIdPlugin.

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

◆ getAssignFormFieldName()

DOIPubIdPlugin::getAssignFormFieldName ( )

Get the assign option form field name.

Returns: string

Reimplemented from PKPPubIdPlugin.

Definition at line 126 of file DOIPubIdPlugin.inc.php.

◆ getDAOFieldNames()

DOIPubIdPlugin::getDAOFieldNames ( )

Get additional field names to be considered for storage.

Returns: array

Reimplemented from PKPPubIdPlugin.

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

◆ getDescription()

DOIPubIdPlugin::getDescription ( )

Get a description of this plugin.

Returns: string

Reimplemented from Plugin.

Definition at line 51 of file DOIPubIdPlugin.inc.php.

◆ getDisplayName()

DOIPubIdPlugin::getDisplayName ( )

Get the display name for this plugin.

Returns: string

Reimplemented from Plugin.

Definition at line 44 of file DOIPubIdPlugin.inc.php.

◆ getFormFieldNames()

DOIPubIdPlugin::getFormFieldNames ( )

Get the additional form field names, for metadata, e.g. suffix field name.

Returns: array

Reimplemented from PKPPubIdPlugin.

Definition at line 119 of file DOIPubIdPlugin.inc.php.

◆ getLinkActions()

DOIPubIdPlugin::getLinkActions ( $pubObject )

Get the link actions used in the pub id forms, e.g. clear pub id.

Returns: array

Reimplemented from PKPPubIdPlugin.

Definition at line 147 of file DOIPubIdPlugin.inc.php.

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

◆ getNotUniqueErrorMsg()

DOIPubIdPlugin::getNotUniqueErrorMsg ( )

Is this object type enabled in plugin settings

Parameters

$pubObjectType	object
$contextId	integer

Returns: boolean

Reimplemented from PKPPubIdPlugin.

Definition at line 199 of file DOIPubIdPlugin.inc.php.

Referenced by validatePublicationDoi().

◆ getPrefixFieldName()

DOIPubIdPlugin::getPrefixFieldName ( )

Get the the prefix form field name.

Returns: string

Reimplemented from PKPPubIdPlugin.

Definition at line 133 of file DOIPubIdPlugin.inc.php.

◆ getPubIdAssignFile()

DOIPubIdPlugin::getPubIdAssignFile ( )

Get the file (path + filename) for the pub id assignment to be included into other pages.

Returns: string

Reimplemented from PKPPubIdPlugin.

Definition at line 104 of file DOIPubIdPlugin.inc.php.

References Plugin\getTemplateResource().

◆ getPubIdDisplayType()

DOIPubIdPlugin::getPubIdDisplayType ( )

Public identifier type that will be displayed to the reader.

Returns: string

Reimplemented from PKPPubIdPlugin.

Definition at line 76 of file DOIPubIdPlugin.inc.php.

◆ getPubIdFullName()

DOIPubIdPlugin::getPubIdFullName ( )

Full name of the public identifier.

Returns: string

Reimplemented from PKPPubIdPlugin.

Definition at line 83 of file DOIPubIdPlugin.inc.php.

◆ getPubIdMetadataFile()

DOIPubIdPlugin::getPubIdMetadataFile ( )

Get the file (path + filename) to be included into the object's identifiers tab, e.g. for suffix editing.

Returns: string

Reimplemented from PKPPubIdPlugin.

Definition at line 97 of file DOIPubIdPlugin.inc.php.

References Plugin\getTemplateResource().

◆ getPubIdType()

DOIPubIdPlugin::getPubIdType ( )

Public identifier type, see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html

Returns: string

Reimplemented from PKPPubIdPlugin.

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

◆ getResolvingURL()

DOIPubIdPlugin::getResolvingURL	(	$contextId,
		$pubId
	)

Get the whole resolving URL.

Parameters

$contextId	integer
$pubId	string

Returns: string resolving URL

Reimplemented from PKPPubIdPlugin.

Definition at line 90 of file DOIPubIdPlugin.inc.php.

◆ getSuffixFieldName()

DOIPubIdPlugin::getSuffixFieldName ( )

Get the the suffix form field name.

Returns: string

Reimplemented from PKPPubIdPlugin.

Definition at line 140 of file DOIPubIdPlugin.inc.php.

◆ getSuffixPatternsFieldNames()

DOIPubIdPlugin::getSuffixPatternsFieldNames ( )

Get the suffix patterns form field names for all objects.

Returns: array (pub object type => suffix pattern field name)

Reimplemented from PKPPubIdPlugin.

Definition at line 173 of file DOIPubIdPlugin.inc.php.

◆ instantiateSettingsForm()

DOIPubIdPlugin::instantiateSettingsForm ( $contextId )

Get the settings form.

Parameters

$contextId integer

Returns: object Settings form

Reimplemented from PKPPubIdPlugin.

Definition at line 111 of file DOIPubIdPlugin.inc.php.

◆ isObjectTypeEnabled()

DOIPubIdPlugin::isObjectTypeEnabled	(	$pubObjectType,
		$contextId
	)

Is this object type enabled in plugin settings

Parameters

$pubObjectType	object
$contextId	integer

Returns: boolean

Reimplemented from PKPPubIdPlugin.

Definition at line 192 of file DOIPubIdPlugin.inc.php.

References Plugin\getSetting().

◆ modifyObjectProperties()

DOIPubIdPlugin::modifyObjectProperties	(	$hookName,
		$args
	)

Add DOI to submission, issue or galley properties

Parameters

$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 ]

Returns: array

Definition at line 276 of file DOIPubIdPlugin.inc.php.

◆ modifyObjectPropertyValues()

DOIPubIdPlugin::modifyObjectPropertyValues	(	$hookName,
		$args
	)

Add DOI submission, issue or galley values

Parameters

$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 ]

Returns: array

Definition at line 295 of file DOIPubIdPlugin.inc.php.

References PubIdPlugin\getPubId().

◆ register()

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.

Parameters

$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.

Returns: boolean True iff plugin registered successfully; if false, the plugin will not be executed.

Reimplemented from PKPPubIdPlugin.

Definition at line 24 of file DOIPubIdPlugin.inc.php.

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

◆ validatePubId()

DOIPubIdPlugin::validatePubId ( $pubId )

Check whether the given pubId is valid.

Parameters

$pubId string

Returns: boolean

Reimplemented from PKPPubIdPlugin.

Definition at line 206 of file DOIPubIdPlugin.inc.php.

◆ validatePublicationDoi()

DOIPubIdPlugin::validatePublicationDoi	(	$hookName,
		$args
	)

Validate a publication's DOI against the plugin's settings

Parameters

$hookName	string
$args	array

Definition at line 232 of file DOIPubIdPlugin.inc.php.

References PubIdPlugin\checkDuplicate(), PKPServices\get(), getNotUniqueErrorMsg(), and Plugin\getSetting().

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

DOIPubIdPlugin.inc.php

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _doiURLEncode()

◆ addPublicationFormFields()

◆ addPublishFormNotice()

◆ constructPubId()

◆ getAssignFormFieldName()

◆ getDAOFieldNames()

◆ getDescription()

◆ getDisplayName()

◆ getFormFieldNames()

◆ getLinkActions()

◆ getNotUniqueErrorMsg()

◆ getPrefixFieldName()

◆ getPubIdAssignFile()

◆ getPubIdDisplayType()

◆ getPubIdFullName()

◆ getPubIdMetadataFile()

◆ getPubIdType()

◆ getResolvingURL()

◆ getSuffixFieldName()

◆ getSuffixPatternsFieldNames()

◆ instantiateSettingsForm()

◆ isObjectTypeEnabled()

◆ modifyObjectProperties()

◆ modifyObjectPropertyValues()

◆ register()

◆ validatePubId()

◆ validatePublicationDoi()