ReviewerReviewForm Class Reference

Inheritance diagram for ReviewerReviewForm:

Public Member Functions
	__construct ($request, $reviewerSubmission, $reviewAssignment, $step)
	fetch ($request, $template=null, $display=false)
	getReviewAssignment ()
	getReviewerSubmission ()
	getStep ()
	updateReviewStepAndSaveSubmission ($reviewerSubmission)
Public Member Functions inherited from Form
	_decomposeArray ($name, $value, $stack)
	addCheck ($formValidator)
	addError ($field, $message)
	addErrorField ($field)
	addSupportedFormLocale ($supportedLocale)
	display ($request=null, $template=null)
	execute (... $functionArgs)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	initData ()
	isValid ()
	readInputData ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_reviewAssignment
	$_reviewerSubmission
	$_step
	$request
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Base class for reviewer forms.

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

Constructor & Destructor Documentation

__construct()

ReviewerReviewForm::__construct	(		$request,
			$reviewerSubmission,
			$reviewAssignment,
			$step
	)

Constructor.

Parameters

$reviewerSubmission	ReviewerSubmission
$step	integer
$request	PKPRequest

Reimplemented from Form.

Definition at line 49 of file ReviewerReviewForm.inc.php.

References $request, and Form\addCheck().

Member Function Documentation

fetch()

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

Reimplemented in PKPReviewerReviewStep3Form, PKPReviewerReviewStep1Form, and PKPReviewerReviewStep2Form.

Definition at line 94 of file ReviewerReviewForm.inc.php.

References $request, PKPTemplateManager\getManager(), getReviewAssignment(), getReviewerSubmission(), and getStep().

getReviewAssignment()

ReviewerReviewForm::getReviewAssignment

(

)

Get the review assignment.

Returns

ReviewAssignment

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

References $_reviewAssignment.

Referenced by PKPReviewerReviewStep3Form\execute(), PKPReviewerReviewStep2Form\fetch(), PKPReviewerReviewStep3Form\fetch(), fetch(), PKPReviewerReviewStep3Form\initData(), and PKPReviewerReviewStep3Form\saveForLater().

getReviewerSubmission()

ReviewerReviewForm::getReviewerSubmission

(

)

Get the reviewer submission.

Returns

ReviewerSubmission

Definition at line 67 of file ReviewerReviewForm.inc.php.

References $_reviewerSubmission.

Referenced by PKPReviewerReviewStep2Form\execute(), PKPReviewerReviewStep3Form\execute(), PKPReviewerReviewStep1Form\execute(), PKPReviewerReviewStep1Form\fetch(), and fetch().

getStep()

ReviewerReviewForm::getStep

(

)

Get the review step.

Returns

integer

Definition at line 83 of file ReviewerReviewForm.inc.php.

References $_step.

Referenced by fetch(), and updateReviewStepAndSaveSubmission().

updateReviewStepAndSaveSubmission()

ReviewerReviewForm::updateReviewStepAndSaveSubmission

(

$reviewerSubmission

)

Set the review step of the submission to the given value if it is not already set to a higher value. Then update the given reviewer submission.

Parameters

$reviewerSubmission

ReviewerSubmission

Definition at line 114 of file ReviewerReviewForm.inc.php.

References DAORegistry\getDAO(), and getStep().

Referenced by PKPReviewerReviewStep2Form\execute(), PKPReviewerReviewStep3Form\execute(), and PKPReviewerReviewStep1Form\execute().

Field Documentation

$_reviewAssignment

ReviewAssignment ReviewerReviewForm::$_reviewAssignment

Definition at line 29 of file ReviewerReviewForm.inc.php.

Referenced by getReviewAssignment().

$_reviewerSubmission

ReviewerSubmission ReviewerReviewForm::$_reviewerSubmission

current submission

Definition at line 23 of file ReviewerReviewForm.inc.php.

Referenced by getReviewerSubmission().

$_step

int ReviewerReviewForm::$_step

the current step

Definition at line 35 of file ReviewerReviewForm.inc.php.

Referenced by getStep().

$request

PKPRequest ReviewerReviewForm::$request

the request object

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

Referenced by PKPReviewerReviewStep2Form\__construct(), ReviewerReviewStep3Form\__construct(), PKPReviewerReviewStep3Form\__construct(), PKPReviewerReviewStep1Form\__construct(), __construct(), PKPReviewerReviewStep3Form\execute(), PKPReviewerReviewStep2Form\fetch(), PKPReviewerReviewStep1Form\fetch(), PKPReviewerReviewStep3Form\fetch(), and fetch().

---

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

• ReviewerReviewForm.inc.php