SuppFileForm Class Reference
[Submission_form]

Supplementary file form. More...

List of all members.

Public Member Functions
	display ()
	execute ($fileName=null)
	getLocaleFieldNames ()
	initData ()
	readInputData ()
	setSuppFileData (&$suppFile)
	SuppFileForm ($paper, $suppFileId=null)
	validate ()
Public Attributes
	$paper
	$suppFile
	$suppFileId

---

Detailed Description

Supplementary file form.

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

---

Member Function Documentation

SuppFileForm.display

(

)

Display the form.

Definition at line 64 of file SuppFileForm.inc.php.

References Request.getConference().

SuppFileForm.execute

(

$

fileName = null

)

Save changes to the supplementary file.

Returns:

int the supplementary file ID

Definition at line 178 of file SuppFileForm.inc.php.

References $suppFile, PaperSearchIndex.indexSuppFileMetadata(), setSuppFileData(), PaperSearchIndex.updateFileIndex(), and PaperFileManager.uploadSuppFile().

SuppFileForm.getLocaleFieldNames

(

)

Get the names of fields for which data should be localized

Returns:

array

Definition at line 56 of file SuppFileForm.inc.php.

SuppFileForm.initData

(

)

Initialize form data from current supplementary file (if applicable).

Definition at line 123 of file SuppFileForm.inc.php.

References $suppFile.

SuppFileForm.readInputData

(

)

Assign form data to user-submitted data.

Definition at line 154 of file SuppFileForm.inc.php.

SuppFileForm.setSuppFileData

(

&$

suppFile

)

Assign form data to a SuppFile.

Parameters:

$suppFile

SuppFile

Definition at line 228 of file SuppFileForm.inc.php.

References $suppFile.

Referenced by execute().

SuppFileForm.SuppFileForm	(	$	paper,
		$	suppFileId = null
	)

Constructor.

Parameters:

	$paper	object
	$suppFileId	int (optional)

Definition at line 34 of file SuppFileForm.inc.php.

References $paper, and $suppFileId.

SuppFileForm.validate

(

)

Validate the form

Definition at line 107 of file SuppFileForm.inc.php.

References Request.getConference().

---

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

• classes/submission/form/SuppFileForm.inc.php

---