Open Journal Systems  3.3.0
StageParticipantNotifyForm Class Reference
Inheritance diagram for StageParticipantNotifyForm:
PKPStageParticipantNotifyForm Form AddParticipantForm

Public Member Functions

 __construct ($itemId, $itemType, $stageId, $template=null)
 
- Public Member Functions inherited from PKPStageParticipantNotifyForm
 _logEventAndCreateNotification ($request, $submission)
 
 execute (... $functionParams)
 
 fetch ($request, $template=null, $display=false)
 
 getEmailVariableNames ($emailKey)
 
 getStageId ()
 
 isMessageRequired ()
 
 readInputData ()
 
 sendMessage ($userId, $submission, $request)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 addSupportedFormLocale ($supportedLocale)
 
 display ($request=null, $template=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Protected Member Functions

 _getMailTemplate ($submission, $templateKey, $includeSignature=true)
 
 _getStageTemplates ()
 

Additional Inherited Members

- Data Fields inherited from PKPStageParticipantNotifyForm
 $_itemId
 
 $_itemType
 
 $_stageId
 
 $_submissionId
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form to notify a user regarding a file.

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

Constructor & Destructor Documentation

◆ __construct()

StageParticipantNotifyForm::__construct (   $itemId,
  $itemType,
  $stageId,
  $template = null 
)

Constructor.

Reimplemented from PKPStageParticipantNotifyForm.

Definition at line 24 of file StageParticipantNotifyForm.inc.php.

Member Function Documentation

◆ _getMailTemplate()

StageParticipantNotifyForm::_getMailTemplate (   $submission,
  $templateKey,
  $includeSignature = true 
)
protected

return app-specific mail template.

Parameters
$submissionSubmission
$templateKeystring
$includeSignatureboolean optional
Returns
ArticleMailTemplate

Reimplemented from PKPStageParticipantNotifyForm.

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

◆ _getStageTemplates()

StageParticipantNotifyForm::_getStageTemplates ( )
protected

Return app-specific stage templates.

Returns
array

Reimplemented from PKPStageParticipantNotifyForm.

Definition at line 32 of file StageParticipantNotifyForm.inc.php.


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