EditorDecisionForm Class Reference

Inheritance diagram for EditorDecisionForm:

Public Member Functions
	__construct ($submission, $decision, $stageId, $template, $reviewRound=null)
	_initiateReviewRound ($submission, $stageId, $request, $status=null)
	fetch ($request, $template=null, $display=false)
	getDecision ()
	getReviewRound ()
	getStageId ()
	getSubmission ()
	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)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	initData ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_decision
	$_reviewRound
	$_stageId
	$_submission
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Base class for the editor decision forms.

Definition at line 21 of file EditorDecisionForm.inc.php.

Constructor & Destructor Documentation

__construct()

EditorDecisionForm::__construct	(		$submission,
			$decision,
			$stageId,
			$template,
			$reviewRound = null
	)

Constructor.

Parameters

$submission	Submission
$stageId	int
$template	string The template to display
$reviewRound	ReviewRound

Definition at line 54 of file EditorDecisionForm.inc.php.

References Form\addCheck().

Member Function Documentation

_initiateReviewRound()

EditorDecisionForm::_initiateReviewRound	(		$submission,
			$stageId,
			$request,
			$status = null
	)

Initiate a new review round and add selected files to it. Also saves the new round to the submission.

Parameters

$submission	Submission
$stageId	integer One of the WORKFLOW_STAGE_ID_* constants.
$request	Request
$status	integer One of the REVIEW_ROUND_STATUS_* constants.

Returns

$newRound integer The round number of the new review round.

Definition at line 150 of file EditorDecisionForm.inc.php.

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

Referenced by InitiateExternalReviewForm\execute(), NewReviewRoundForm\execute(), InitiateReviewForm\execute(), and PromoteForm\execute().

fetch()

EditorDecisionForm::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 EditorDecisionWithEmailForm, and SendReviewsForm.

Definition at line 116 of file EditorDecisionForm.inc.php.

References getDecision(), PKPTemplateManager\getManager(), getReviewRound(), getStageId(), getSubmission(), and Form\setData().

getDecision()

EditorDecisionForm::getDecision

(

)

Get the decision

Returns

integer

Definition at line 73 of file EditorDecisionForm.inc.php.

References $_decision.

Referenced by PromoteForm\execute(), SendReviewsForm\execute(), fetch(), and EditorDecisionWithEmailForm\initData().

getReviewRound()

EditorDecisionForm::getReviewRound

(

)

Get the review round object.

Returns

ReviewRound

Definition at line 97 of file EditorDecisionForm.inc.php.

References $_reviewRound.

Referenced by EditorDecisionWithEmailForm\_sendReviewMailToAuthor(), NewReviewRoundForm\execute(), PromoteForm\execute(), SendReviewsForm\execute(), EditorDecisionWithEmailForm\fetch(), fetch(), and EditorDecisionWithEmailForm\initData().

getStageId()

EditorDecisionForm::getStageId

(

)

Get the stage Id

Returns

int

Definition at line 89 of file EditorDecisionForm.inc.php.

References $_stageId.

Referenced by InitiateExternalReviewForm\execute(), NewReviewRoundForm\execute(), InitiateReviewForm\execute(), PromoteForm\execute(), SendReviewsForm\execute(), EditorDecisionWithEmailForm\fetch(), fetch(), SendReviewsForm\initData(), and PromoteForm\initData().

getSubmission()

EditorDecisionForm::getSubmission

(

)

Get the submission

Returns

Submission

Definition at line 81 of file EditorDecisionForm.inc.php.

References $_submission.

Referenced by EditorDecisionWithEmailForm\_getAllowedVariables(), InitiateExternalReviewForm\execute(), NewReviewRoundForm\execute(), InitiateReviewForm\execute(), PromoteForm\execute(), SendReviewsForm\execute(), SendReviewsForm\fetch(), EditorDecisionWithEmailForm\fetch(), fetch(), EditorDecisionWithEmailForm\initData(), and PromoteForm\initData().

readInputData()

EditorDecisionForm::readInputData

(

)

See also

Form::readInputData()

Reimplemented from Form.

Reimplemented in EditorDecisionWithEmailForm, PromoteForm, and SendReviewsForm.

Definition at line 107 of file EditorDecisionForm.inc.php.

References Form\readUserVars().

Field Documentation

$_decision

integer EditorDecisionForm::$_decision

The decision being taken

Definition at line 44 of file EditorDecisionForm.inc.php.

Referenced by getDecision().

$_reviewRound

ReviewRound EditorDecisionForm::$_reviewRound

Only required when in review stages

Definition at line 38 of file EditorDecisionForm.inc.php.

Referenced by getReviewRound().

$_stageId

int EditorDecisionForm::$_stageId

The stage ID where the decision is being made

Definition at line 32 of file EditorDecisionForm.inc.php.

Referenced by getStageId().

$_submission

Submission EditorDecisionForm::$_submission

The submission associated with the editor decision

Definition at line 26 of file EditorDecisionForm.inc.php.

Referenced by getSubmission().

---

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

• EditorDecisionForm.inc.php