Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
PubIdPlugin Class Reference
Inheritance diagram for PubIdPlugin:
Plugin DOIPubIdPlugin

Public Member Functions

 _getDAOs ()
 
 checkDuplicate ($pubId, &$pubObject, $pressId)
 
 getAdditionalFieldNames ($hookName, $params)
 
getDAO ($pubObjectType)
 
 getDAOFieldNames ()
 
 getEnabled ($pressId=null)
 
 getFormFieldNames ()
 
 getManagementVerbs ()
 
 getPubId ($pubObject, $preview=false)
 
 getPubIdDisplayType ()
 
 getPubIdFullName ()
 
 getPubIdMetadataFile ()
 
 getPubIdType ()
 
 getPubObjectType ($pubObject)
 
 getResolvingURL ($pressId, $pubId)
 
 getSettingsFormName ()
 
 manage ($verb, $args, &$message, &$messageParams, &$pluginModalContent=null)
 
 register ($category, $path)
 
 setEnabled ($enabled)
 
 setStoredPubId (&$pubObject, $pubObjectType, $pubId)
 
 validatePubId ($pubId)
 
 verifyData ($fieldName, $fieldValue, &$pubObject, $monographId, &$errorMsg)
 
- Public Member Functions inherited from Plugin
 _getContextSpecificInstallationHook ()
 
 addLocaleData ($locale=null)
 
 getCategory ()
 
 getContextSpecificPluginSettingsFile ()
 
 getContextSpecificSetting ($context, $name)
 
 getCurrentVersion ()
 
 getDescription ()
 
 getDisplayName ()
 
 getHideManagement ()
 
 getInstallDataFile ()
 
 getInstallEmailTemplateDataFile ()
 
 getInstallEmailTemplatesFile ()
 
 getInstallFilterConfigFiles ()
 
 getInstallSchemaFile ()
 
 getInstallSitePluginSettingsFile ()
 
 getLocaleFilename ($locale)
 
 getManagementVerbLinkAction ($request, $verb)
 
 getManagementVerbs ()
 
 getName ()
 
 getPluginPath ()
 
getRequest ()
 
 getSeq ()
 
 getSetting ($contextId, $name)
 
 getSettingMainContext ()
 
 getTemplatePath ($inCore=false)
 
 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, &$pluginModalContent=null)
 
 Plugin ()
 
 register ($category, $path)
 
 smartyPluginUrl ($params, &$smarty)
 
 updateContextSpecificSetting ($context, $name, $value, $type=null)
 
 updateSchema ($hookName, $args)
 
 updateSetting ($contextId, $name, $value, $type=null)
 

Additional Inherited Members

- Public Attributes inherited from Plugin
 $pluginCategory
 
 $pluginPath
 
 $request
 

Detailed Description

Abstract class for public identifiers plugins.

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

Member Function Documentation

PubIdPlugin::_getDAOs ( )

Return an array of the corresponding DAOs.

Returns
array

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

Referenced by register().

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

Check for duplicate public identifiers.

Parameters
$pubIdstring
$pubObjectobject
$pressIdinteger
Returns
boolean

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

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

Referenced by 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 304 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 360 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 232 of file PubIdPlugin.inc.php.

Referenced by getAdditionalFieldNames().

PubIdPlugin::getEnabled (   $pressId = null)

Determine whether or not this plugin is enabled.

Returns
boolean

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

References Plugin\$request, Plugin\getRequest(), and Plugin\getSetting().

Referenced by getManagementVerbs(), and manage().

PubIdPlugin::getFormFieldNames ( )

Get the additional form field names.

Returns
array

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

Referenced by getAdditionalFieldNames().

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

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

References getEnabled().

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

Get the public identifier.

Parameters
$pubObjectobject (PublicationFormat)
$previewboolean when true, the public identifier will not be stored
Returns
string

Definition at line 141 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 158 of file PubIdPlugin.inc.php.

PubIdPlugin::getPubIdFullName ( )

Full name of the public identifier.

Returns
string

Definition at line 166 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 186 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 150 of file PubIdPlugin.inc.php.

Referenced by manage(), and setStoredPubId().

PubIdPlugin::getPubObjectType (   $pubObject)

Return the object type.

Parameters
$pubObjectobject (PublicationFormat)
Returns
array

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

Referenced by DOIPubIdPlugin\getPubId().

PubIdPlugin::getResolvingURL (   $pressId,
  $pubId 
)

Get the whole resolving URL.

Parameters
$pressIdint
$pubIdstring
Returns
string resolving URL

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

PubIdPlugin::getSettingsFormName ( )

Get the class name of the settings form.

Returns
string

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

Referenced by manage().

PubIdPlugin::manage (   $verb,
  $args,
$message,
$messageParams,
$pluginModalContent = null 
)
PubIdPlugin::register (   $category,
  $path 
)
See Also
PKPPlugin::register()

Definition at line 34 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 389 of file PubIdPlugin.inc.php.

References Plugin\$request, Plugin\getRequest(), and Plugin\updateSetting().

Referenced by manage().

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

Set and store a public identifier.

Parameters
$pubObjectPublicationFormat
$pubObjectTypestring As returned from self::getPubObjectType()
$pubIdstring
Returns
string

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

References getDAO(), and getPubIdType().

Referenced by DOIPubIdPlugin\getPubId().

PubIdPlugin::validatePubId (   $pubId)

Check whether the given pubId is valid.

Parameters
$pubIdstring
Returns
boolean

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

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

Verify form data.

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

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


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