Open Journal Systems  3.3.0
ManageReviewFilesForm Class Reference
Inheritance diagram for ManageReviewFilesForm:
ManageSubmissionFilesForm Form

Public Member Functions

 __construct ($submissionId, $stageId, $reviewRoundId)
 
 execute ($stageSubmissionFiles, $fileStage=null)
 
 getReviewRound ()
 
 getReviewRoundId ()
 
 getStageId ()
 
 initData ()
 
- Public Member Functions inherited from ManageSubmissionFilesForm
 __construct ($submissionId, $template)
 
 getSubmissionId ()
 
 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 ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $_reviewRoundId
 
 $_stageId
 
- Data Fields inherited from ManageSubmissionFilesForm
 $_submissionId
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Protected Member Functions

 importFile ($context, $submissionFile, $fileStage)
 
- Protected Member Functions inherited from ManageSubmissionFilesForm
 fileExistsInStage ($submissionFile, $stageSubmissionFiles, $fileStage)
 

Detailed Description

Form for add or removing files from a review.

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

Constructor & Destructor Documentation

◆ __construct()

ManageReviewFilesForm::__construct (   $submissionId,
  $stageId,
  $reviewRoundId 
)

Constructor.

Definition at line 36 of file ManageReviewFilesForm.inc.php.

Member Function Documentation

◆ execute()

ManageReviewFilesForm::execute (   $stageSubmissionFiles,
  $fileStage = null 
)

Save review round files @stageSubmissionFiles array The files that belongs to a file stage that is currently being used by a grid inside this form.

Parameters
$fileStageint SUBMISSION_FILE_...

Reimplemented from ManageSubmissionFilesForm.

Definition at line 93 of file ManageReviewFilesForm.inc.php.

◆ getReviewRound()

ManageReviewFilesForm::getReviewRound ( )
Returns
ReviewRound

Definition at line 65 of file ManageReviewFilesForm.inc.php.

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

Referenced by initData().

◆ getReviewRoundId()

ManageReviewFilesForm::getReviewRoundId ( )

Get the round

Returns
int

Definition at line 58 of file ManageReviewFilesForm.inc.php.

References $_reviewRoundId.

Referenced by getReviewRound(), and initData().

◆ getStageId()

ManageReviewFilesForm::getStageId ( )

Get the review stage id

Returns
int

Definition at line 50 of file ManageReviewFilesForm.inc.php.

References $_stageId.

Referenced by initData().

◆ importFile()

ManageReviewFilesForm::importFile (   $context,
  $submissionFile,
  $fileStage 
)
protected

Make a copy of the file to the specified file stage.

Parameters
$contextContext
$submissionFileSubmissionFile
$fileStageint SUBMISSION_FILE_...
Returns
SubmissionFile Resultant new submission file

Reimplemented from ManageSubmissionFilesForm.

Definition at line 100 of file ManageReviewFilesForm.inc.php.

References DAORegistry\getDAO().

◆ initData()

ManageReviewFilesForm::initData ( )

Initialize form data for a new form.

Reimplemented from ManageSubmissionFilesForm.

Definition at line 77 of file ManageReviewFilesForm.inc.php.

References getReviewRound(), getReviewRoundId(), getStageId(), and Form\setData().

Field Documentation

◆ $_reviewRoundId

int ManageReviewFilesForm::$_reviewRoundId

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

Referenced by getReviewRoundId().

◆ $_stageId

int ManageReviewFilesForm::$_stageId

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

Referenced by getStageId().


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