ManageProofFilesForm Class Reference

Inheritance diagram for ManageProofFilesForm:

Public Member Functions
	__construct ($submissionId, $publicationId, $representationId)
	fetch ($request, $template=null, $display=false)
Public Member Functions inherited from ManageSubmissionFilesForm
	__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)
	getData ($key)
	getDefaultFormLocale ()
	getErrorsArray ()
	getLocaleFieldNames ()
	getRequiredLocale ()
	getTemplate ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_representationId
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
	fileExistsInStage ($submissionFile, $stageSubmissionFiles, $fileStage)
	importFile ($context, $submissionFile, $fileStage)

Detailed Description

Form to add files to the proof files grid.

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

Constructor & Destructor Documentation

__construct()

ManageProofFilesForm::__construct	(		$submissionId,
			$publicationId,
			$representationId
	)

Constructor.

Parameters

$submissionId	int Submission ID.
$publicationId	int Publication ID
$representationId	int Representation ID.

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

Member Function Documentation

fetch()

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

Definition at line 45 of file ManageProofFilesForm.inc.php.

References PKPTemplateManager\getManager().

fileExistsInStage()

ManageProofFilesForm::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 from ManageSubmissionFilesForm.

Definition at line 55 of file ManageProofFilesForm.inc.php.

importFile()

ManageProofFilesForm::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 from ManageSubmissionFilesForm.

Definition at line 63 of file ManageProofFilesForm.inc.php.

References DAORegistry\getDAO(), and Application\getRepresentationDAO().

Field Documentation

$_representationId

int ManageProofFilesForm::$_representationId

Representation ID.

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

---

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

• ManageProofFilesForm.inc.php