Open Monograph Press  3.3.0
PKPPubIdPluginHelper Class Reference

Public Member Functions

 addJavaScripts ($contextId, $request, $templateMgr)
 
 assignPubId ($contextId, $form, $pubObject, $save=false)
 
 clearPubId ($contextId, $pubIdPlugInClassName, $pubObject)
 
 execute ($contextId, $form, $pubObject)
 
 init ($contextId, $form, $pubObject)
 
 readAssignInputData ($form)
 
 readInputData ($contextId, $form)
 
 setLinkActions ($contextId, $form, $pubObject)
 
 validate ($contextId, $form, $pubObject)
 

Detailed Description

Helper class for public identifiers plugins.

Definition at line 17 of file PKPPubIdPluginHelper.inc.php.

Member Function Documentation

◆ addJavaScripts()

PKPPubIdPluginHelper::addJavaScripts (   $contextId,
  $request,
  $templateMgr 
)

Add pub id plugins JavaScripts.

Parameters
$contextIdinteger
$requestPKPRequest
$templateMgrPKPTemplateManager

Definition at line 68 of file PKPPubIdPluginHelper.inc.php.

References PluginRegistry\loadCategory().

◆ assignPubId()

PKPPubIdPluginHelper::assignPubId (   $contextId,
  $form,
  $pubObject,
  $save = false 
)

Assign public identifier.

Parameters
$contextIdinteger
$formobject
$pubObjectobject
$saveboolean Whether the pub id shall be saved here Submission, Representation, SubmissionFile + OJS Issue

Definition at line 167 of file PKPPubIdPluginHelper.inc.php.

References PluginRegistry\loadCategory().

◆ clearPubId()

PKPPubIdPluginHelper::clearPubId (   $contextId,
  $pubIdPlugInClassName,
  $pubObject 
)

Clear a pubId from a pubObject.

Parameters
$contextIdinteger
$pubIdPlugInClassNamestring
$pubObjectobject Submission, Representation, SubmissionFile + OJS Issue

Definition at line 190 of file PKPPubIdPluginHelper.inc.php.

References PluginRegistry\loadCategory().

◆ execute()

PKPPubIdPluginHelper::execute (   $contextId,
  $form,
  $pubObject 
)

Set the additional data from public identifier plugins.

Parameters
$contextIdinteger
$formobject PKPPublicIdentifiersForm
$pubObjectobject Submission, Representation, SubmissionFile + OJS Issue

Definition at line 137 of file PKPPubIdPluginHelper.inc.php.

References PluginRegistry\loadCategory().

◆ init()

PKPPubIdPluginHelper::init (   $contextId,
  $form,
  $pubObject 
)

Init the additional form fields from public identifier plugins.

Parameters
$contextIdinteger
$formobject PKPPublicIdentifiersForm|CatalogEntryFormatMetadataForm
$pubObjectobject Submission, Representation, SubmissionFile + OJS Issue

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

References PluginRegistry\loadCategory().

◆ readAssignInputData()

PKPPubIdPluginHelper::readAssignInputData (   $form)

Read the the public identifiers' assign form field data.

Parameters
$formobject Form containing the assign check box PKPAssignPublicIdentifiersForm OJS IssueEntryPublicationMetadataForm

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

References PKPApplication\get(), and PluginRegistry\loadCategory().

◆ readInputData()

PKPPubIdPluginHelper::readInputData (   $contextId,
  $form 
)

Read the additional input data from public identifier plugins.

Parameters
$contextIdinteger
$formobject PKPPublicIdentifiersForm

Definition at line 103 of file PKPPubIdPluginHelper.inc.php.

References PluginRegistry\loadCategory().

◆ setLinkActions()

PKPPubIdPluginHelper::setLinkActions (   $contextId,
  $form,
  $pubObject 
)

Set form link actions.

Parameters
$contextIdinteger
$formobject PKPPublicIdentifiersForm
$pubObjectobject Submission, Representation, SubmissionFile + OJS Issue

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

References PluginRegistry\loadCategory().

◆ validate()

PKPPubIdPluginHelper::validate (   $contextId,
  $form,
  $pubObject 
)

Validate the additional form fields from public identifier plugins.

Parameters
$contextIdinteger
$formobject PKPPublicIdentifiersForm
$pubObjectobject Submission, Representation, SubmissionFile + OJS Issue

Definition at line 26 of file PKPPubIdPluginHelper.inc.php.

References PluginRegistry\loadCategory().


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