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

Public Member Functions

 _getAllowedVariables ($request)
 
 _getAllowedVariablesType ()
 
 _sendReviewMailToAuthor ($submission, $emailKey, $request)
 
 _updateReviewRoundStatus ($submission, $status, $reviewRound=null)
 
 fetch ($request, $template=null, $display=false)
 
 getSaveFormOperation ()
 
 initData ($actionLabels=array())
 
 readInputData ()
 
 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
 __construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 addSupportedFormLocale ($supportedLocale)
 
 display ($request=null, $template=null)
 
 execute (... $functionArgs)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $_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

Base class for the editor decision forms.

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

Member Function Documentation

◆ _getAllowedVariables()

EditorDecisionWithEmailForm::_getAllowedVariables (   $request)

Get a list of allowed email template variables.

Parameters
$requestPKPRequest Request object
Returns
array

Definition at line 313 of file EditorDecisionWithEmailForm.inc.php.

References EditorDecisionForm\getSubmission().

Referenced by fetch().

◆ _getAllowedVariablesType()

EditorDecisionWithEmailForm::_getAllowedVariablesType ( )

Get a list of allowed email template variables type.

Parameters
$requestPKPRequest Request object
Returns
array

Definition at line 332 of file EditorDecisionWithEmailForm.inc.php.

Referenced by fetch().

◆ _sendReviewMailToAuthor()

EditorDecisionWithEmailForm::_sendReviewMailToAuthor (   $submission,
  $emailKey,
  $request 
)

Sends an email with a personal message and the selected review attachements to the author. Also marks review attachments selected by the editor as "viewable" for the author.

Parameters
$submissionSubmission
$emailKeystring An email template.
$requestPKPRequest

Definition at line 202 of file EditorDecisionWithEmailForm.inc.php.

References PKPString\enumerateAlphabetically(), DAORegistry\getDAO(), Form\getData(), and EditorDecisionForm\getReviewRound().

Referenced by PromoteForm\execute(), and SendReviewsForm\execute().

◆ _updateReviewRoundStatus()

EditorDecisionWithEmailForm::_updateReviewRoundStatus (   $submission,
  $status,
  $reviewRound = null 
)

Retrieve the last review round and update it with the new status.

The review round status is typically set according to the statuses of its ReviewAssignments. This method overrides that status and sets a new one based on an EditorDecision.

Parameters
$submissionSubmission
$statusinteger One of the REVIEW_ROUND_STATUS_* constants.

Definition at line 180 of file EditorDecisionWithEmailForm.inc.php.

References DAORegistry\getDAO().

Referenced by PromoteForm\execute(), and SendReviewsForm\execute().

◆ fetch()

EditorDecisionWithEmailForm::fetch (   $request,
  $template = null,
  $display = false 
)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from EditorDecisionForm.

Reimplemented in SendReviewsForm.

Definition at line 112 of file EditorDecisionWithEmailForm.inc.php.

References _getAllowedVariables(), _getAllowedVariablesType(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), EditorDecisionForm\getReviewRound(), getSaveFormOperation(), EditorDecisionForm\getStageId(), EditorDecisionForm\getSubmission(), and Form\setData().

◆ getSaveFormOperation()

EditorDecisionWithEmailForm::getSaveFormOperation ( )

Get the operation to save this form.

Returns
string

Definition at line 33 of file EditorDecisionWithEmailForm.inc.php.

References $_saveFormOperation.

Referenced by fetch().

◆ initData()

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

◆ readInputData()

EditorDecisionWithEmailForm::readInputData ( )

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

Reimplemented from EditorDecisionForm.

Reimplemented in PromoteForm, and SendReviewsForm.

Definition at line 104 of file EditorDecisionWithEmailForm.inc.php.

References Form\readUserVars().

◆ setSaveFormOperation()

EditorDecisionWithEmailForm::setSaveFormOperation (   $saveFormOperation)

Set the operation to save this form.

Parameters
$saveFormOperationstring

Definition at line 41 of file EditorDecisionWithEmailForm.inc.php.

Referenced by PromoteForm\__construct(), and SendReviewsForm\__construct().

Field Documentation

◆ $_saveFormOperation

String EditorDecisionWithEmailForm::$_saveFormOperation

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

Referenced by getSaveFormOperation().


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