ManageSubmissionFilesForm Class Reference

Inheritance diagram for ManageSubmissionFilesForm:

Public Member Functions
	__construct ($submissionId, $template)
	execute ($stageSubmissionFiles, $fileStage=null)
	getSubmissionId ()
	initData ()
	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
	$_submissionId
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Protected Member Functions
	fileExistsInStage ($submissionFile, $stageSubmissionFiles, $fileStage)
	importFile ($context, $submissionFile, $fileStage)

Detailed Description

Form for add or removing files from a review.

Definition at line 19 of file ManageSubmissionFilesForm.inc.php.

Constructor & Destructor Documentation

__construct()

ManageSubmissionFilesForm::__construct	(		$submissionId,
			$template
	)

Constructor.

Parameters

$submissionId	int Submission ID
$template	string Template filename

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

References Form\addCheck().

Member Function Documentation

execute()

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

Save selection of submission files

Parameters

$stageSubmissionFiles	array The files that belongs to a file stage that is currently being used by a grid inside this form.
$fileStage	int SUBMISSION_FILE_...

Reimplemented in ManageReviewFilesForm, ManageQueryNoteFilesForm, ManageFinalDraftFilesForm, and ManageCopyeditFilesForm.

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

References fileExistsInStage(), PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), getSubmissionId(), and importFile().

fileExistsInStage()

ManageSubmissionFilesForm::fileExistsInStage (   $submissionFile,   $stageSubmissionFiles,   $fileStage  )

protected

Determine if a file with the same file stage is already present in the workflow stage.

Parameters

$submissionFile	SubmissionFile The submission file
$stageSubmissionFiles	array The list of submission files in the stage.
$fileStage	int FILE_STAGE_...

Reimplemented in ManageQueryNoteFilesForm, and ManageProofFilesForm.

Definition at line 109 of file ManageSubmissionFilesForm.inc.php.

Referenced by execute().

getSubmissionId()

ManageSubmissionFilesForm::getSubmissionId

(

)

Get the submission id

Returns

int

Definition at line 47 of file ManageSubmissionFilesForm.inc.php.

References $_submissionId.

Referenced by execute().

importFile()

ManageSubmissionFilesForm::importFile (   $context,   $submissionFile,   $fileStage  )

protected

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

Parameters

$context	Context
$submissionFile	SubmissionFile
$fileStage	int SUBMISSION_FILE_...

Returns

SubmissionFile Resultant new submission file

Reimplemented in ManageReviewFilesForm, ManageQueryNoteFilesForm, and ManageProofFilesForm.

Definition at line 124 of file ManageSubmissionFilesForm.inc.php.

References DAORegistry\getDAO().

Referenced by execute().

initData()

ManageSubmissionFilesForm::initData

(

)

Initialize form data for a new form.

Reimplemented from Form.

Reimplemented in ManageReviewFilesForm.

Definition at line 57 of file ManageSubmissionFilesForm.inc.php.

References Form\setData().

readInputData()

ManageSubmissionFilesForm::readInputData

(

)

Assign form data to user-submitted data.

See also

Form::readInputData()

Reimplemented from Form.

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

References Form\readUserVars().

Field Documentation

$_submissionId

int ManageSubmissionFilesForm::$_submissionId

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

Referenced by getSubmissionId().

---

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

• ManageSubmissionFilesForm.inc.php