Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
EditorDecisionForm Class Reference
Inheritance diagram for EditorDecisionForm:
Form EditorDecisionWithEmailForm InitiateReviewForm NewReviewRoundForm PromoteForm SendReviewsForm

Public Member Functions

 _initiateReviewRound ($submission, $stageId, $request, $status=null)
 
 EditorDecisionForm ($submission, $decision, $stageId, $template, $reviewRound=null)
 
 fetch ($request)
 
 getDecision ()
 
 getReviewRound ()
 
 getStageId ()
 
 getSubmission ()
 
 readInputData ()
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Public Attributes

 $_decision
 
 $_reviewRound
 
 $_stageId
 
 $_submission
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Base class for the editor decision forms.

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

Member Function Documentation

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
$submissionSubmission
$stageIdinteger One of the WORKFLOW_STAGE_ID_* constants.
$requestRequest
$statusinteger 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.

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

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

Constructor.

Parameters
$submissionSubmission
$stageIdint
$templatestring The template to display
$reviewRoundReviewRound

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

References $_decision.

EditorDecisionForm::fetch (   $request)
See Also
Form::fetch()

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

EditorDecisionForm::getDecision ( )

Get the decision

Returns
integer

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

Referenced by SendReviewsForm\execute(), and PromoteForm\execute().

EditorDecisionForm::getReviewRound ( )

Get the review round object.

Returns
ReviewRound

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

Referenced by NewReviewRoundForm\execute(), SendReviewsForm\execute(), and PromoteForm\execute().

EditorDecisionForm::getStageId ( )

Get the stage Id

Returns
int

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

References Form\readUserVars().

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

EditorDecisionForm::getSubmission ( )
EditorDecisionForm::readInputData ( )
See Also
Form::readInputData()

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

Member Data Documentation

integer EditorDecisionForm::$_decision

The decision being taken

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

Referenced by EditorDecisionForm().

ReviewRound EditorDecisionForm::$_reviewRound

Only required when in review stages

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

int EditorDecisionForm::$_stageId

The stage ID where the decision is being made

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

Submission EditorDecisionForm::$_submission

The submission associated with the editor decision

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


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