Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
EditorDecisionWithEmailForm Class Reference
Inheritance diagram for EditorDecisionWithEmailForm:
EditorDecisionForm Form PromoteForm SendReviewsForm

Public Member Functions

 _sendReviewMailToAuthor ($submission, $emailKey, $request)
 
 _updateReviewRoundStatus ($submission, $status, $reviewRound=null)
 
 EditorDecisionWithEmailForm ($submission, $decision, $stageId, $template, $reviewRound=null)
 
 fetch ($request)
 
 getSaveFormOperation ()
 
 initData ($args, $request, $actionLabels)
 
 readInputData ()
 
 setSaveFormOperation ($saveFormOperation)
 
- Public Member Functions inherited from EditorDecisionForm
 _initiateReviewRound ($submission, $stageId, $request, $status=null)
 
 EditorDecisionForm ($submission, $decision, $stageId, $template, $reviewRound=null)
 
 fetch ($request)
 
 getDecision ()
 
 getReviewRound ()
 
 getStageId ()
 
 getSubmission ()
 
 readInputData ()
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Additional Inherited Members

- Public Attributes inherited from EditorDecisionForm
 $_decision
 
 $_reviewRound
 
 $_stageId
 
 $_submission
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $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

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 190 of file EditorDecisionWithEmailForm.inc.php.

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

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

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

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

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

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

EditorDecisionWithEmailForm::EditorDecisionWithEmailForm (   $submission,
  $decision,
  $stageId,
  $template,
  $reviewRound = null 
)

Constructor.

Parameters
$submissionSubmission
$decisioninteger
$stageIdinteger
$templatestring The template to display
$reviewRoundReviewRound

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

EditorDecisionWithEmailForm::fetch (   $request)

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

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

EditorDecisionWithEmailForm::getSaveFormOperation ( )

Get the operation to save this form.

Returns
string

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

EditorDecisionWithEmailForm::initData (   $args,
  $request,
  $actionLabels 
)

Initialize form data for a new form.

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

EditorDecisionWithEmailForm::readInputData ( )

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

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

EditorDecisionWithEmailForm::setSaveFormOperation (   $saveFormOperation)

Set the operation to save this form.

Parameters
$saveFormOperationstring

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

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


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