Public Member Functions | |
| __construct ($reviewAssignment, $reviewRound, $submission, $template) | |
| execute (... $functionArgs) | |
| getReviewAssignment () | |
| getReviewRound () | |
| getSubmission () | |
| initData () | |
| readInputData () | |
| setReviewAssignment ($reviewAssignment) | |
| setReviewRound ($reviewRound) | |
| setSubmission ($submission) | |
 Public Member Functions inherited from Form | |
| _decomposeArray ($name, $value, $stack) | |
| addCheck ($formValidator) | |
| addError ($field, $message) | |
| addErrorField ($field) | |
| addSupportedFormLocale ($supportedLocale) | |
| display ($request=null, $template=null) | |
| fetch ($request, $template=null, $display=false) | |
| getData ($key) | |
| getDefaultFormLocale () | |
| getErrorsArray () | |
| getLocaleFieldNames () | |
| getRequiredLocale () | |
| getTemplate () | |
| isValid () | |
| readUserVars ($vars) | |
| setData ($key, $value=null) | |
| setDefaultFormLocale ($defaultLocale) | |
| setTemplate ($template) | |
| validate ($callHooks=true) | |
Data Fields | |
| $_reviewAssignment | |
| $_reviewRound | |
| $_submission | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Protected Member Functions | |
| getEmailKey () | |
Detailed Description
Perform an action on a review including a reviewer notification email.
Definition at line 17 of file ReviewerNotifyActionForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| ReviewerNotifyActionForm::__construct | ( | $reviewAssignment, | |
| $reviewRound, | |||
| $submission, | |||
| $template | |||
| ) |
Constructor
- Parameters
-
$reviewAssignment ReviewAssignment $reviewRound ReviewRound $submission Submission $template string
Reimplemented from Form.
Definition at line 34 of file ReviewerNotifyActionForm.inc.php.
References setReviewAssignment(), setReviewRound(), and setSubmission().
Member Function Documentation
◆ execute()
| ReviewerNotifyActionForm::execute | ( | $functionArgs | ) |
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.
- bool whether or not the review assignment was modified successfully
Reimplemented from Form.
Reimplemented in ReinstateReviewerForm, and UnassignReviewerForm.
Definition at line 87 of file ReviewerNotifyActionForm.inc.php.
References PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), getEmailKey(), getReviewAssignment(), and getSubmission().
◆ getEmailKey()
|
abstractprotected |
Reimplemented in ReinstateReviewerForm, and UnassignReviewerForm.
Referenced by execute(), and initData().
◆ getReviewAssignment()
| ReviewerNotifyActionForm::getReviewAssignment | ( | ) |
Get the ReviewAssignment
- Returns
- ReviewAssignment
Definition at line 143 of file ReviewerNotifyActionForm.inc.php.
References $_reviewAssignment.
Referenced by ReinstateReviewerForm\execute(), UnassignReviewerForm\execute(), execute(), and initData().
◆ getReviewRound()
| ReviewerNotifyActionForm::getReviewRound | ( | ) |
Get the ReviewRound
- Returns
- ReviewRound
Definition at line 159 of file ReviewerNotifyActionForm.inc.php.
References $_reviewRound.
Referenced by initData().
◆ getSubmission()
| ReviewerNotifyActionForm::getSubmission | ( | ) |
Get the submission
- Returns
- Submission
Definition at line 175 of file ReviewerNotifyActionForm.inc.php.
References $_submission.
Referenced by ReinstateReviewerForm\execute(), UnassignReviewerForm\execute(), execute(), and initData().
◆ initData()
| ReviewerNotifyActionForm::initData | ( | ) |
Initialize form data for a new form.
Reimplemented from Form.
Definition at line 49 of file ReviewerNotifyActionForm.inc.php.
References PKPApplication\get(), DAORegistry\getDAO(), getEmailKey(), getReviewAssignment(), getReviewRound(), getSubmission(), and Form\setData().
◆ readInputData()
| ReviewerNotifyActionForm::readInputData | ( | ) |
Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented from Form.
Definition at line 116 of file ReviewerNotifyActionForm.inc.php.
References Form\readUserVars().
◆ setReviewAssignment()
| ReviewerNotifyActionForm::setReviewAssignment | ( | $reviewAssignment | ) |
Set the ReviewAssignment
- Parameters
-
mixed $reviewAssignment ReviewAssignment
Definition at line 135 of file ReviewerNotifyActionForm.inc.php.
Referenced by __construct().
◆ setReviewRound()
| ReviewerNotifyActionForm::setReviewRound | ( | $reviewRound | ) |
Set the ReviewRound
- Parameters
-
mixed $reviewRound ReviewRound
Definition at line 151 of file ReviewerNotifyActionForm.inc.php.
Referenced by __construct().
◆ setSubmission()
| ReviewerNotifyActionForm::setSubmission | ( | $submission | ) |
Set the submission
- Parameters
-
$submission Submission
Definition at line 167 of file ReviewerNotifyActionForm.inc.php.
Referenced by __construct().
Field Documentation
◆ $_reviewAssignment
| ReviewerNotifyActionForm::$_reviewAssignment |
The review assignment to alter
Definition at line 19 of file ReviewerNotifyActionForm.inc.php.
Referenced by getReviewAssignment().
◆ $_reviewRound
| ReviewerNotifyActionForm::$_reviewRound |
The review round associated with the review assignment
Definition at line 25 of file ReviewerNotifyActionForm.inc.php.
Referenced by getReviewRound().
◆ $_submission
| ReviewerNotifyActionForm::$_submission |
The submission associated with the review assignment
Definition at line 22 of file ReviewerNotifyActionForm.inc.php.
Referenced by getSubmission().
The documentation for this class was generated from the following file:
