Open Journal Systems  3.3.0
PubIdPlugin Class Reference
Inheritance diagram for PubIdPlugin:
PKPPubIdPlugin LazyLoadPlugin Plugin DOIPubIdPlugin URNPubIdPlugin

Public Member Functions

 checkDuplicate ($pubId, $pubObjectType, $excludeId, $contextId)
 
 clearIssueObjectsPubIds ($issue)
 
 getDAOs ()
 
 getPubId ($pubObject)
 
 getPubObjectTypes ()
 
 manage ($args, $request)
 
- Public Member Functions inherited from PKPPubIdPlugin
 addJavaScript ($request, $templateMgr)
 
 addToSchema ($hookName, $params)
 
 canBeAssigned ($pubObject)
 
 constructPubId ($pubIdPrefix, $pubIdSuffix, $contextId)
 
 getActions ($request, $actionArgs)
 
 getAdditionalFieldNames ($hookName, $params)
 
 getAssignFormFieldName ()
 
 getContext ($contextId)
 
 getDAOFieldNames ()
 
 getFileDAODelegates ()
 
 getFormFieldNames ()
 
 getLinkActions ($pubObject)
 
 getNotUniqueErrorMsg ()
 
 getPrefixFieldName ()
 
 getPubIdAssignFile ()
 
 getPubIdDisplayType ()
 
 getPubIdFullName ()
 
 getPubIdMetadataFile ()
 
 getPubIdType ()
 
 getPubObjectType ($pubObject)
 
 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

◆ checkDuplicate()

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

Check for duplicate public identifiers.

Checks to see if a pubId has already been assigned to any object in the context.

Parameters
$pubIdstring
$pubObjectTypestring Class name of the pub object being checked
$excludeIdinteger This object id will not be checked for duplicates
$contextIdinteger
Returns
boolean

Reimplemented from PKPPubIdPlugin.

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

References DAORegistry\getDAO(), and getPubObjectTypes().

Referenced by DOIPubIdPlugin\validatePublicationDoi(), and URNPubIdPlugin\validatePublicationUrn().

◆ clearIssueObjectsPubIds()

PubIdPlugin::clearIssueObjectsPubIds (   $issue)

Clear pubIds of all issue objects.

Parameters
$issueIssue

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

References PKPServices\get(), DAORegistry\getDAO(), PKPPubIdPlugin\getPubIdType(), Application\getRepresentationDAO(), and PKPPubIdPlugin\isObjectTypeEnabled().

◆ getDAOs()

PubIdPlugin::getDAOs ( )

Return an array of publication object types and the corresponding DAOs.

Returns
array

Reimplemented from PKPPubIdPlugin.

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

References DAORegistry\getDAO().

◆ getPubId()

◆ getPubObjectTypes()

PubIdPlugin::getPubObjectTypes ( )

Get the possible publication object types.

Returns
array

Reimplemented from PKPPubIdPlugin.

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

Referenced by checkDuplicate().

◆ manage()

PubIdPlugin::manage (   $args,
  $request 
)

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