SuppFileForm Class Reference
[Submission_form]
Supplementary file form.
More...
Public Member Functions | |
| display () | |
| execute ($fileName=null) | |
| getLocaleFieldNames () | |
| initData () | |
| readInputData () | |
| setSuppFileData (&$suppFile) | |
| SuppFileForm ($article, $suppFileId=null) | |
| validate () | |
Detailed Description
Supplementary file form.Definition at line 20 of file SuppFileForm.inc.php.
Member Function Documentation
| SuppFileForm.display | ( | ) |
Display the form.
Reimplemented from Form.
Definition at line 65 of file SuppFileForm.inc.php.
References Request.getJournal(), TemplateManager.getManager(), Request.getRequestedPage(), and Request.getUserVar().
| SuppFileForm.execute | ( | $ | fileName = null |
) |
Save changes to the supplementary file.
- Returns:
- int the supplementary file ID
Definition at line 179 of file SuppFileForm.inc.php.
References DAORegistry.getDAO(), ArticleSearchIndex.indexSuppFileMetadata(), setSuppFileData(), ArticleSearchIndex.updateFileIndex(), and ArticleFileManager.uploadSuppFile().
| SuppFileForm.getLocaleFieldNames | ( | ) |
Get the names of fields for which data should be localized
- Returns:
- array
Reimplemented from Form.
Definition at line 57 of file SuppFileForm.inc.php.
References DAORegistry.getDAO().
| SuppFileForm.initData | ( | ) |
Initialize form data from current supplementary file (if applicable).
Reimplemented from Form.
Definition at line 124 of file SuppFileForm.inc.php.
| SuppFileForm.readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Definition at line 155 of file SuppFileForm.inc.php.
References Form.readUserVars().
| SuppFileForm.setSuppFileData | ( | &$ | suppFile | ) |
Assign form data to a SuppFile.
- Parameters:
-
$suppFile SuppFile
Definition at line 229 of file SuppFileForm.inc.php.
References Core.getCurrentDate(), and Form.getData().
Referenced by execute().
| SuppFileForm.SuppFileForm | ( | $ | article, | |
| $ | suppFileId = null | |||
| ) |
Constructor.
- Parameters:
-
$article object $suppFileId int (optional)
Definition at line 35 of file SuppFileForm.inc.php.
References Form.addCheck(), and DAORegistry.getDAO().
| SuppFileForm.validate | ( | ) |
Validate the form
Reimplemented from Form.
Definition at line 108 of file SuppFileForm.inc.php.
References Form.addError(), Form.addErrorField(), DAORegistry.getDAO(), Form.getData(), Request.getJournal(), and Locale.translate().
The documentation for this class was generated from the following file:
- classes/submission/form/SuppFileForm.inc.php
