Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
PubIdPlugin Class Reference
Inheritance diagram for PubIdPlugin:
Plugin PKPPlugin DOIPubIdPlugin URNPubIdPlugin

Public Member Functions

 _getDAOs ()
 
 _setBreadcrumbs ()
 
 checkDuplicate ($pubId, &$pubObject, $journalId)
 
 getAdditionalFieldNames ($hookName, $params)
 
getDAO ($pubObjectType)
 
 getDAOFieldNames ()
 
 getEnabled ($journalId=null)
 
 getFormFieldNames ()
 
getJournal ($journalId)
 
 getManagementVerbs ()
 
 getPubId ($pubObject, $preview=false)
 
 getPubIdDisplayType ()
 
 getPubIdFullName ()
 
 getPubIdMetadataFile ()
 
 getPubIdType ()
 
 getPubObjectType ($pubObject)
 
 getResolvingURL ($journalId, $pubId)
 
 getSettingsFormName ()
 
 manage ($verb, $args)
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
 setStoredPubId (&$pubObject, $pubObjectType, $pubId)
 
 validatePubId ($pubId)
 
 verifyData ($fieldName, $fieldValue, &$pubObject, $journalId, &$errorMsg)
 
- Public Member Functions inherited from Plugin
 getContextSpecificPluginSettingsFile ()
 
 getNewJournalPluginSettingsFile ()
 
 getSetting ($journalId, $name)
 
 Plugin ()
 
 updateSetting ($journalId, $name, $value, $type=null)
 
- Public Member Functions inherited from PKPPlugin
 _getContextSpecificInstallationHook ()
 
 addHelpData ($locale=null)
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHelpMappingFilename ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
 getSeq ()
 
 getSettingMainContext ()
 
 getTemplatePath ()
 
 import ($class)
 
 installContextSpecificSettings ($hookName, $args)
 
 installData ($hookName, $args)
 
 installEmailTemplateData ($hookName, $args)
 
 installEmailTemplates ($hookName, $args)
 
 installFilters ($hookName, $args)
 
 installLocale ($hookName, $args)
 
 installSiteSettings ($hookName, $args)
 
 isSitePlugin ()
 
 manage ($verb, $args, &$message, &$messageParams, $request=null)
 
 PKPPlugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 

Detailed Description

Abstract class for public identifiers plugins.

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

Member Function Documentation

PubIdPlugin::_getDAOs ( )

Return an array of the corresponding DAOs.

Returns
array

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

Referenced by register().

PubIdPlugin::_setBreadcrumbs ( )

Set the breadcrumbs, given the plugin's tree of items to append.

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

References Request\url().

Referenced by manage().

PubIdPlugin::checkDuplicate (   $pubId,
$pubObject,
  $journalId 
)

Check for duplicate public identifiers.

Parameters
$pubIdstring
$pubObjectobject
$journalIdinteger
Returns
boolean

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

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

Referenced by URNPubIdPlugin\verifyData(), and DOIPubIdPlugin\verifyData().

PubIdPlugin::getAdditionalFieldNames (   $hookName,
  $params 
)

Add the suffix element and the public identifier to the object (issue, article, galley, supplementary file).

Parameters
$hookNamestring
$paramsarray ()

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

References getDAOFieldNames(), and getFormFieldNames().

& PubIdPlugin::getDAO (   $pubObjectType)

Return the name of the corresponding DAO.

Parameters
$pubObjectobject
Returns
DAO

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

References DAORegistry\getDAO().

Referenced by setStoredPubId().

PubIdPlugin::getDAOFieldNames ( )

Get additional field names to be considered for storage.

Returns
array

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

Referenced by getAdditionalFieldNames().

PubIdPlugin::getEnabled (   $journalId = null)

Determine whether or not this plugin is enabled.

Returns
boolean

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

References PKPApplication\getRequest(), and Plugin\getSetting().

Referenced by getManagementVerbs(), and manage().

PubIdPlugin::getFormFieldNames ( )

Get the additional form field names.

Returns
array

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

Referenced by getAdditionalFieldNames().

& PubIdPlugin::getJournal (   $journalId)

Get the journal object.

Parameters
$journalIdinteger
Returns
Journal

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

References DAORegistry\getDAO(), and PKPApplication\getRequest().

Referenced by DOIPubIdPlugin\getPubId(), and URNPubIdPlugin\getPubId().

PubIdPlugin::getManagementVerbs ( )
See Also
PKPPlugin::getManagementVerbs()

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

References getEnabled().

PubIdPlugin::getPubId (   $pubObject,
  $preview = false 
)

Get the public identifier.

Parameters
$pubObjectobject (Issue, Article, PublishedArticle, ArticleGalley, SuppFile)
$previewboolean when true, the public identifier will not be stored
Returns
string

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

Referenced by checkDuplicate().

PubIdPlugin::getPubIdDisplayType ( )

Public identifier type that will be displayed to the reader.

Returns
string

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

PubIdPlugin::getPubIdFullName ( )

Full name of the public identifier.

Returns
string

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

PubIdPlugin::getPubIdMetadataFile ( )

Get the file (path + filename) to be included into the object's metadata pages.

Returns
string

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

PubIdPlugin::getPubIdType ( )

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

Returns
string

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

Referenced by manage(), and setStoredPubId().

PubIdPlugin::getPubObjectType (   $pubObject)

Return the object type.

Parameters
$pubObjectobject (Issue, Article, PublishedArticle, ArticleGalley, SuppFile)
Returns
array

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

Referenced by DOIPubIdPlugin\getPubId(), and URNPubIdPlugin\getPubId().

PubIdPlugin::getResolvingURL (   $journalId,
  $pubId 
)

Get the whole resolving URL.

Parameters
$journalIdint
$pubIdstring
Returns
string resolving URL

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

PubIdPlugin::getSettingsFormName ( )

Get the class name of the settings form.

Returns
string

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

Referenced by manage().

PubIdPlugin::register (   $category,
  $path 
)
See Also
PKPPlugin::register()

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

References _getDAOs(), and HookRegistry\register().

PubIdPlugin::setEnabled (   $enabled)

Set the enabled/disabled state of this plugin.

Parameters
$enabledboolean

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

References Request\getJournal(), and Plugin\updateSetting().

Referenced by manage().

PubIdPlugin::setStoredPubId ( $pubObject,
  $pubObjectType,
  $pubId 
)

Set and store a public identifier.

Parameters
$pubObjectIssue|Article|ArticleGalley|SuppFile
$pubObjectTypestring As returned from self::getPubObjectType()
$pubIdstring
Returns
string

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

References getDAO(), and getPubIdType().

Referenced by DOIPubIdPlugin\getPubId(), and URNPubIdPlugin\getPubId().

PubIdPlugin::validatePubId (   $pubId)

Check whether the given pubId is valid.

Parameters
$pubIdstring
Returns
boolean

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

PubIdPlugin::verifyData (   $fieldName,
  $fieldValue,
$pubObject,
  $journalId,
$errorMsg 
)

Verify form data.

Parameters
$fieldNamestring The form field to be checked.
$fieldValuestring The value of the form field.
$pubObjectobject
$journalIdinteger
$errorMsgstring Return validation error messages here.
Returns
boolean

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


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