ManageQueryNoteFilesForm Class Reference

Inheritance diagram for ManageQueryNoteFilesForm:

Public Member Functions
	__construct ($submissionId, $queryId, $noteId, $actionArgs=array())
	execute ($stageSubmissionFiles, $fileStage=null)
	fetch ($request, $template=null, $display=false)
Public Member Functions inherited from ManageSubmissionFilesForm
	__construct ($submissionId, $template)
	getSubmissionId ()
	initData ()
	readInputData ()
Public Member Functions inherited from Form
	_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
	$_actionArgs
	$_noteId
	$_queryId
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 query files grid.

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

Constructor & Destructor Documentation

__construct()

ManageQueryNoteFilesForm::__construct	(		$submissionId,
			$queryId,
			$noteId,
			$actionArgs = array()
	)

Constructor.

Parameters

$submissionId	int Submission ID.
$queryId	int Query ID.
$noteId	int Note ID.
$actionArgs	array Optional list of extra request parameters.

Reimplemented from Form.

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

Member Function Documentation

execute()

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

Save selection of query files

Parameters

$stageSubmissionFiles	array The list of submission files in the stage.
$fileStage	int SUBMISSION_FILE_...

Reimplemented from ManageSubmissionFilesForm.

Definition at line 69 of file ManageQueryNoteFilesForm.inc.php.

fetch()

ManageQueryNoteFilesForm::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 54 of file ManageQueryNoteFilesForm.inc.php.

References PKPTemplateManager\getManager().

fileExistsInStage()

ManageQueryNoteFilesForm::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 76 of file ManageQueryNoteFilesForm.inc.php.

importFile()

ManageQueryNoteFilesForm::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 91 of file ManageQueryNoteFilesForm.inc.php.

References DAORegistry\getDAO().

Field Documentation

$_actionArgs

array ManageQueryNoteFilesForm::$_actionArgs

Extra parameters to actions.

Definition at line 35 of file ManageQueryNoteFilesForm.inc.php.

$_noteId

int ManageQueryNoteFilesForm::$_noteId

Note ID

Definition at line 29 of file ManageQueryNoteFilesForm.inc.php.

$_queryId

int ManageQueryNoteFilesForm::$_queryId

Query ID

Definition at line 23 of file ManageQueryNoteFilesForm.inc.php.

---

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

• ManageQueryNoteFilesForm.inc.php