Public Member Functions | |
| __construct ($submission, $stageId, $reviewRound) | |
| execute (... $functionParams) | |
| fetch ($request, $template=null, $display=false) | |
| getReviewRound () | |
| getStageId () | |
| getSubmission () | |
| initData () | |
| readInputData () | |
 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) | |
| getData ($key) | |
| getDefaultFormLocale () | |
| getErrorsArray () | |
| getLocaleFieldNames () | |
| getRequiredLocale () | |
| getTemplate () | |
| isValid () | |
| readUserVars ($vars) | |
| setData ($key, $value=null) | |
| setDefaultFormLocale ($defaultLocale) | |
| setTemplate ($template) | |
| validate ($callHooks=true) | |
Data Fields | |
| $_reviewRound | |
| $_stageId | |
| $_submission | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Editor recommendation form.
Definition at line 21 of file RecommendationForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| RecommendationForm::__construct | ( | $submission, | |
| $stageId, | |||
| $reviewRound | |||
| ) |
Constructor.
- Parameters
-
$submission Submission $stageId integer $reviewRound ReviewRound
Definition at line 46 of file RecommendationForm.inc.php.
References Form\addCheck().
Member Function Documentation
◆ execute()
| RecommendationForm::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 166 of file RecommendationForm.inc.php.
References PKPApplication\get(), Core\getCurrentDate(), DAORegistry\getDAO(), Form\getData(), getReviewRound(), getStageId(), and getSubmission().
◆ fetch()
| RecommendationForm::fetch | ( | $request, | |
$template = null, |
|||
$display = false |
|||
| ) |
Returns a string of the rendered form
- Parameters
-
$request PKPRequest $template string the template to be rendered, mandatory if no template has been specified on class instantiation. $display boolean
- Returns
- string the rendered form
Reimplemented from Form.
Definition at line 145 of file RecommendationForm.inc.php.
References PKPTemplateManager\getManager().
◆ getReviewRound()
| RecommendationForm::getReviewRound | ( | ) |
Get the review round object.
- Returns
- ReviewRound
Definition at line 80 of file RecommendationForm.inc.php.
References $_reviewRound.
Referenced by execute().
◆ getStageId()
| RecommendationForm::getStageId | ( | ) |
Get the stage Id
- Returns
- int
Definition at line 72 of file RecommendationForm.inc.php.
References $_stageId.
Referenced by execute(), and initData().
◆ getSubmission()
| RecommendationForm::getSubmission | ( | ) |
Get the submission
- Returns
- Submission
Definition at line 64 of file RecommendationForm.inc.php.
References $_submission.
Referenced by execute(), and initData().
◆ initData()
| RecommendationForm::initData | ( | ) |
Initialize form data for a new form.
Reimplemented from Form.
Definition at line 90 of file RecommendationForm.inc.php.
References PKPApplication\get(), DAORegistry\getDAO(), getStageId(), getSubmission(), and Form\setData().
◆ readInputData()
| RecommendationForm::readInputData | ( | ) |
Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented from Form.
Definition at line 158 of file RecommendationForm.inc.php.
References Form\readUserVars().
Field Documentation
◆ $_reviewRound
| ReviewRound RecommendationForm::$_reviewRound |
Definition at line 38 of file RecommendationForm.inc.php.
Referenced by getReviewRound().
◆ $_stageId
| integer RecommendationForm::$_stageId |
The stage ID where the recommendation is being made
Definition at line 32 of file RecommendationForm.inc.php.
Referenced by getStageId().
◆ $_submission
| Submission RecommendationForm::$_submission |
The submission associated with the editor recommendation
Definition at line 26 of file RecommendationForm.inc.php.
Referenced by getSubmission().
The documentation for this class was generated from the following file:
