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

Public Member Functions

 __construct ($reviewAssignment)
 
 execute ($submission)
 
 fetch ($request, $template=null, $display=false, $requestArgs=array())
 
 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)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 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 an email to a user.

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

Constructor & Destructor Documentation

◆ __construct()

EmailReviewerForm::__construct (   $reviewAssignment)

Constructor.

Parameters
$reviewAssignmentReviewAssignment The review assignment to use for this contact.

Definition at line 30 of file EmailReviewerForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ execute()

EmailReviewerForm::execute (   $submission)

Send the email

Parameters
$submissionSubmission

Definition at line 75 of file EmailReviewerForm.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().

◆ fetch()

EmailReviewerForm::fetch (   $request,
  $template = null,
  $display = false,
  $requestArgs = array() 
)

Display the form.

Parameters
$requestArgsarray Request parameters to bounce back with the form submission.
See also
Form::fetch

Definition at line 57 of file EmailReviewerForm.inc.php.

References DAORegistry\getDAO(), and PKPTemplateManager\getManager().

◆ readInputData()

EmailReviewerForm::readInputData ( )

Assign form data to user-submitted data.

See also
Form::readInputData()

Reimplemented from Form.

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

References Form\readUserVars().

Field Documentation

◆ $_reviewAssignment

ReviewAssignment EmailReviewerForm::$_reviewAssignment

The review assignment to use for this contact

Definition at line 24 of file EmailReviewerForm.inc.php.


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