PubIdPlugin Class Reference

Inheritance diagram for PubIdPlugin:

Public Member Functions
	getPubId ($pubObject)
	manage ($args, $request)
	versionPubId ($pubObject)
Public Member Functions inherited from PKPPubIdPlugin
	addJavaScript ($request, $templateMgr)
	addToSchema ($hookName, $params)
	canBeAssigned ($pubObject)
	checkDuplicate ($pubId, $pubObjectType, $excludeId, $contextId)
	constructPubId ($pubIdPrefix, $pubIdSuffix, $contextId)
	getActions ($request, $actionArgs)
	getAdditionalFieldNames ($hookName, $params)
	getAssignFormFieldName ()
	getContext ($contextId)
	getDAOFieldNames ()
	getDAOs ()
	getFileDAODelegates ()
	getFormFieldNames ()
	getLinkActions ($pubObject)
	getNotUniqueErrorMsg ()
	getPrefixFieldName ()
	getPubIdAssignFile ()
	getPubIdDisplayType ()
	getPubIdFullName ()
	getPubIdMetadataFile ()
	getPubIdType ()
	getPubObjectType ($pubObject)
	getPubObjectTypes ()
	getResolvingURL ($contextId, $pubId)
	getSuffixFieldName ()
	getSuffixPatternsFieldNames ()
	instantiateSettingsForm ($contextId)
	isObjectTypeEnabled ($pubObjectType, $contextId)
	register ($category, $path, $mainContextId=null)
	setStoredPubId (&$pubObject, $pubId)
	validatePubId ($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
	__construct ()
	_overridePluginTemplates ($hookName, $args)
	addLocaleData ($locale=null)
	getCategory ()
	getContextSpecificPluginSettingsFile ()
	getCurrentVersion ()
	getDescription ()
	getDirName ()
	getDisplayName ()
	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

Public identifiers plugins common functions.

Definition at line 18 of file PubIdPlugin.inc.php.

Member Function Documentation

getPubId()

PubIdPlugin::getPubId

(

$pubObject

)

Get the public identifier.

Parameters

$pubObject

object Submission, Representation, SubmissionFile + OJS Issue

Returns

string

Reimplemented from PKPPubIdPlugin.

Definition at line 84 of file PubIdPlugin.inc.php.

References PKPPubIdPlugin\constructPubId(), PKPServices\get(), PKPPubIdPlugin\getContext(), PKPPubIdPlugin\getPrefixFieldName(), PKPPubIdPlugin\getPubIdType(), PKPPubIdPlugin\getPubObjectType(), Plugin\getSetting(), PKPPubIdPlugin\getSuffixFieldName(), PKPPubIdPlugin\getSuffixPatternsFieldNames(), PKPPubIdPlugin\isObjectTypeEnabled(), PKPString\regexp_replace(), and PKPString\strtolower().

Referenced by DOIPubIdPlugin\getCitationData(), manage(), and DOIPubIdPlugin\modifyObjectPropertyValues().

manage()

PubIdPlugin::manage	(		$args,
			$request
	)

Perform a management function.

Parameters

$args	array
$request	PKPRequest

Returns

JSONMessage A JSON-encoded response

Reimplemented from PKPPubIdPlugin.

Definition at line 23 of file PubIdPlugin.inc.php.

References Plugin\$request, PKPServices\get(), DAORegistry\getDAO(), getPubId(), PKPPubIdPlugin\getPubIdType(), Application\getRepresentationDAO(), Plugin\getSetting(), PKPPubIdPlugin\getSuffixFieldName(), and PKPPubIdPlugin\isObjectTypeEnabled().

versionPubId()

PubIdPlugin::versionPubId

(

$pubObject

)

Version a publication pubId

Definition at line 196 of file PubIdPlugin.inc.php.

References PKPPubIdPlugin\constructPubId(), PKPServices\get(), PKPPubIdPlugin\getContext(), PKPPubIdPlugin\getPrefixFieldName(), PKPPubIdPlugin\getPubObjectType(), Plugin\getSetting(), PKPPubIdPlugin\getSuffixPatternsFieldNames(), PKPPubIdPlugin\isObjectTypeEnabled(), PKPString\regexp_replace(), and PKPString\strtolower().

---

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

• PubIdPlugin.inc.php