Open Journal Systems  3.3.0
UnassignReviewerForm Class Reference
Inheritance diagram for UnassignReviewerForm:
ReviewerNotifyActionForm Form

Public Member Functions

 __construct ($reviewAssignment, $reviewRound, $submission)
 
 execute (... $functionArgs)
 
 getEmailKey ()
 
- Public Member Functions inherited from ReviewerNotifyActionForm
 __construct ($reviewAssignment, $reviewRound, $submission, $template)
 
 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)
 

Additional Inherited Members

- Data Fields inherited from ReviewerNotifyActionForm
 $_reviewAssignment
 
 $_reviewRound
 
 $_submission
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Allow the editor to remove a review assignment.

Definition at line 17 of file UnassignReviewerForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

UnassignReviewerForm::__construct (   $reviewAssignment,
  $reviewRound,
  $submission 
)

Constructor

Parameters
mixed$reviewAssignmentReviewAssignment
mixed$reviewRoundReviewRound
mixed$submissionSubmission

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

Member Function Documentation

◆ execute()

UnassignReviewerForm::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 deleted successfully

Reimplemented from ReviewerNotifyActionForm.

Definition at line 39 of file UnassignReviewerForm.inc.php.

References HookRegistry\call(), PKPApplication\get(), DAORegistry\getDAO(), ReviewerNotifyActionForm\getReviewAssignment(), ReviewerNotifyActionForm\getSubmission(), and SubmissionLog\logEvent().

◆ getEmailKey()

UnassignReviewerForm::getEmailKey ( )

Reimplemented from ReviewerNotifyActionForm.

Definition at line 31 of file UnassignReviewerForm.inc.php.


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