Open Journal Systems  3.3.0
PromoteForm Class Reference
Inheritance diagram for PromoteForm:
EditorDecisionWithEmailForm EditorDecisionForm Form

Public Member Functions

 __construct ($submission, $decision, $stageId, $reviewRound=null)
 
 _getDecisions ()
 
 execute (... $functionParams)
 
 initData ($actionLabels=array())
 
 readInputData ()
 
- Public Member Functions inherited from EditorDecisionWithEmailForm
 _getAllowedVariables ($request)
 
 _getAllowedVariablesType ()
 
 _sendReviewMailToAuthor ($submission, $emailKey, $request)
 
 _updateReviewRoundStatus ($submission, $status, $reviewRound=null)
 
 fetch ($request, $template=null, $display=false)
 
 getSaveFormOperation ()
 
 setSaveFormOperation ($saveFormOperation)
 
- Public Member Functions inherited from EditorDecisionForm
 __construct ($submission, $decision, $stageId, $template, $reviewRound=null)
 
 _initiateReviewRound ($submission, $stageId, $request, $status=null)
 
 getDecision ()
 
 getReviewRound ()
 
 getStageId ()
 
 getSubmission ()
 
- 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)
 

Additional Inherited Members

- Data Fields inherited from EditorDecisionWithEmailForm
 $_saveFormOperation
 
- Data Fields inherited from EditorDecisionForm
 $_decision
 
 $_reviewRound
 
 $_stageId
 
 $_submission
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for promoting a submission (to external review or editing)

Definition at line 21 of file PromoteForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

PromoteForm::__construct (   $submission,
  $decision,
  $stageId,
  $reviewRound = null 
)

Constructor.

Parameters
$submissionSubmission
$decisionint
$stageIdint
$reviewRoundReviewRound

Reimplemented from Form.

Definition at line 30 of file PromoteForm.inc.php.

References _getDecisions(), fatalError(), AppLocale\requireComponents(), and EditorDecisionWithEmailForm\setSaveFormOperation().

Member Function Documentation

◆ _getDecisions()

PromoteForm::_getDecisions ( )

Get this form decisions.

Returns
array

Definition at line 206 of file PromoteForm.inc.php.

Referenced by __construct(), execute(), and initData().

◆ execute()

PromoteForm::execute (   $functionParams)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters
mixed$functionArgs,...Arguments from the caller to be passed to the hook consumer
Returns
mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Definition at line 77 of file PromoteForm.inc.php.

References _getDecisions(), EditorDecisionForm\_initiateReviewRound(), EditorDecisionWithEmailForm\_sendReviewMailToAuthor(), EditorDecisionWithEmailForm\_updateReviewRoundStatus(), fatalError(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), EditorDecisionForm\getDecision(), Application\getPaymentManager(), EditorDecisionForm\getReviewRound(), EditorDecisionForm\getStageId(), and EditorDecisionForm\getSubmission().

◆ initData()

PromoteForm::initData (   $actionLabels = array())

Initialize form data for a new form.

Reimplemented from EditorDecisionWithEmailForm.

Definition at line 53 of file PromoteForm.inc.php.

References _getDecisions(), PKPApplication\get(), EditorDecisionForm\getStageId(), EditorDecisionForm\getSubmission(), and Form\setData().

◆ readInputData()

PromoteForm::readInputData ( )

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from EditorDecisionWithEmailForm.

Definition at line 69 of file PromoteForm.inc.php.

References Form\readUserVars().


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