Open Journal Systems  3.3.0
ThankReviewerForm Class Reference
Inheritance diagram for ThankReviewerForm:
Form

Public Member Functions

 __construct ($reviewAssignment)
 
 execute (... $functionArgs)
 
 getReviewAssignment ()
 
 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)
 
 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
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for sending a thank you to a reviewer.

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

Constructor & Destructor Documentation

◆ __construct()

ThankReviewerForm::__construct (   $reviewAssignment)

Constructor.

Definition at line 25 of file ThankReviewerForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ execute()

ThankReviewerForm::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.

Reimplemented from Form.

Definition at line 95 of file ThankReviewerForm.inc.php.

References HookRegistry\call(), PKPApplication\get(), Core\getCurrentDate(), DAORegistry\getDAO(), Form\getData(), and getReviewAssignment().

◆ getReviewAssignment()

ThankReviewerForm::getReviewAssignment ( )

Get the review assignment

Returns
ReviewAssignment

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

References $_reviewAssignment.

Referenced by execute(), and initData().

◆ initData()

ThankReviewerForm::initData ( )

Initialize form data for a new form.

Reimplemented from Form.

Definition at line 51 of file ThankReviewerForm.inc.php.

References Validation\generatePasswordResetHash(), PKPApplication\get(), DAORegistry\getDAO(), getReviewAssignment(), and Form\setData().

◆ readInputData()

ThankReviewerForm::readInputData ( )

Assign form data to user-submitted data.

See also
Form::readInputData()

Reimplemented from Form.

Definition at line 88 of file ThankReviewerForm.inc.php.

References Form\readUserVars().

Field Documentation

◆ $_reviewAssignment

ThankReviewerForm::$_reviewAssignment

The review assignment associated with the reviewer

Definition at line 20 of file ThankReviewerForm.inc.php.

Referenced by getReviewAssignment().


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