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

Public Member Functions

 __construct ($reviewAssignment)
 
 _getMailTemplateKey ($context)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 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)
 
 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 review reminder to a reviewer.

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

Constructor & Destructor Documentation

◆ __construct()

ReviewReminderForm::__construct (   $reviewAssignment)

Constructor.

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

References Form\addCheck(), and AppLocale\requireComponents().

Member Function Documentation

◆ _getMailTemplateKey()

ReviewReminderForm::_getMailTemplateKey (   $context)

Get the email template key depending on if reviewer one click access is enabled or not.

Parameters
$contextContext The user's current context.
Returns
int Email template key

Definition at line 190 of file ReviewReminderForm.inc.php.

Referenced by execute(), and initData().

◆ execute()

ReviewReminderForm::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 132 of file ReviewReminderForm.inc.php.

References _getMailTemplateKey(), Validation\generatePasswordResetHash(), PKPApplication\get(), Core\getCurrentDate(), DAORegistry\getDAO(), Form\getData(), and getReviewAssignment().

◆ fetch()

ReviewReminderForm::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 Form.

Definition at line 101 of file ReviewReminderForm.inc.php.

References PKPTemplateManager\getManager().

◆ getReviewAssignment()

ReviewReminderForm::getReviewAssignment ( )

Get the review assignment

Returns
ReviewAssignment

Definition at line 42 of file ReviewReminderForm.inc.php.

References $_reviewAssignment.

Referenced by execute(), and initData().

◆ initData()

ReviewReminderForm::initData ( )

Initialize form data for a new form.

Reimplemented from Form.

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

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

◆ readInputData()

ReviewReminderForm::readInputData ( )

Assign form data to user-submitted data.

See also
Form::readInputData()

Reimplemented from Form.

Definition at line 122 of file ReviewReminderForm.inc.php.

References Form\readUserVars().

Field Documentation

◆ $_reviewAssignment

ReviewReminderForm::$_reviewAssignment

The review assignment associated with the reviewer

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

Referenced by getReviewAssignment().


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