PKPSubmissionFilesUploadBaseForm Class Reference

Inheritance diagram for PKPSubmissionFilesUploadBaseForm:

Public Member Functions
	__construct ($request, $template, $submissionId, $stageId, $fileStage, $revisionOnly=false, $reviewRound=null, $revisedFileId=null, $assocType=null, $assocId=null)
	fetch ($request, $template=null, $display=false)
	getAssocId ()
	getAssocType ()
	getReviewRound ()
	getRevisedFileId ()
	getRevisionSubmissionFilesSelection ($user, $uploadedFile=null)
	getStageId ()
	getSubmissionFiles ()
	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 ()
	initData ()
	isValid ()
	readUserVars ($vars)
	setData ($key, $value=null)
	setDefaultFormLocale ($defaultLocale)
	setTemplate ($template)
	validate ($callHooks=true)

Data Fields
	$_reviewRound
	$_stageId
	$_submissionFiles
Data Fields inherited from Form
	$_checks
	$_data
	$_errors
	$_template
	$cssValidation
	$defaultLocale
	$errorFields
	$errorsArray
	$formSectionErrors
	$requiredLocale
	$supportedLocales

Detailed Description

Form for adding/editing a submission file.

Definition at line 20 of file PKPSubmissionFilesUploadBaseForm.inc.php.

Constructor & Destructor Documentation

__construct()

PKPSubmissionFilesUploadBaseForm::__construct	(		$request,
			$template,
			$submissionId,
			$stageId,
			$fileStage,
			$revisionOnly = false,
			$reviewRound = null,
			$revisedFileId = null,
			$assocType = null,
			$assocId = null
	)

Constructor.

Parameters

$request	Request
$template	string
$submissionId	integer
$stageId	integer One of the WORKFLOW_STAGE_ID_* constants.
$fileStage	integer
$revisionOnly	boolean
$reviewRound	ReviewRound
$revisedFileId	integer

Reimplemented in SubmissionFilesUploadForm.

Definition at line 51 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References Form\addCheck(), fatalError(), DAORegistry\getDAO(), and Form\setData().

Member Function Documentation

fetch()

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

Reimplemented in SubmissionFilesUploadForm.

Definition at line 220 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References fatalError(), Form\getData(), PKPTemplateManager\getManager(), getReviewRound(), getRevisedFileId(), getRevisionSubmissionFilesSelection(), getStageId(), and Form\setData().

getAssocId()

PKPSubmissionFilesUploadBaseForm::getAssocId

(

)

Get the associated id.

Returns

integer

Definition at line 133 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References Form\getData().

Referenced by getSubmissionFiles().

getAssocType()

PKPSubmissionFilesUploadBaseForm::getAssocType

(

)

Get the associated type

Returns

integer

Definition at line 125 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References Form\getData().

Referenced by getSubmissionFiles().

getReviewRound()

PKPSubmissionFilesUploadBaseForm::getReviewRound

(

)

Get the review round object (if any).

Returns

ReviewRound

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

References $_reviewRound.

Referenced by fetch(), and getSubmissionFiles().

getRevisedFileId()

PKPSubmissionFilesUploadBaseForm::getRevisedFileId

(

)

Get the revised file id (if any).

Returns

int the revised file id

Definition at line 117 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References Form\getData().

Referenced by SubmissionFilesUploadConfirmationForm\execute(), SubmissionFilesUploadForm\execute(), fetch(), and SubmissionFilesUploadForm\validate().

getRevisionSubmissionFilesSelection()

PKPSubmissionFilesUploadBaseForm::getRevisionSubmissionFilesSelection	(		$user,
			$uploadedFile = null
	)

Get the submission files possible to select/consider for revision by the given user.

Parameters

$user	User
$uploadedFile	uploaded SubmissionFile

Returns

array a list of SubmissionFile instances.

Definition at line 186 of file PKPSubmissionFilesUploadBaseForm.inc.php.

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

Referenced by fetch().

getStageId()

PKPSubmissionFilesUploadBaseForm::getStageId

(

)

Get the workflow stage id.

Returns

integer

Definition at line 101 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References $_stageId.

Referenced by fetch(), and getSubmissionFiles().

getSubmissionFiles()

PKPSubmissionFilesUploadBaseForm::getSubmissionFiles

(

)

Get the submission files belonging to the submission and to the file stage.

Returns

array a list of SubmissionFile instances.

Definition at line 142 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References $_submissionFiles, fatalError(), getAssocId(), getAssocType(), DAORegistry\getDAO(), Form\getData(), getReviewRound(), and getStageId().

Referenced by getRevisionSubmissionFilesSelection().

readInputData()

PKPSubmissionFilesUploadBaseForm::readInputData

(

)

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from Form.

Reimplemented in SubmissionFilesUploadForm, and SubmissionFilesUploadConfirmationForm.

Definition at line 211 of file PKPSubmissionFilesUploadBaseForm.inc.php.

References Form\readUserVars().

Field Documentation

$_reviewRound

ReviewRound PKPSubmissionFilesUploadBaseForm::$_reviewRound

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

Referenced by getReviewRound().

$_stageId

integer PKPSubmissionFilesUploadBaseForm::$_stageId

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

Referenced by getStageId().

$_submissionFiles

array PKPSubmissionFilesUploadBaseForm::$_submissionFiles

the submission files for this submission and file stage

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

Referenced by getSubmissionFiles().

---

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

• PKPSubmissionFilesUploadBaseForm.inc.php