Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
SuppFileForm Class Reference
Inheritance diagram for SuppFileForm:
Form

Public Member Functions

 display ()
 
 execute ($fileName=null, $createRemote=false)
 
 getDefaultFormLocale ()
 
 getLocaleFieldNames ()
 
 initData ()
 
 readInputData ()
 
 setSuppFileData (&$suppFile)
 
 SuppFileForm ($article, $journal, $suppFileId=null)
 
 validate ()
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch (&$request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Additional Inherited Members

- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 

Detailed Description

Supplementary file form.

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

Member Function Documentation

SuppFileForm::execute (   $fileName = null,
  $createRemote = false 
)

Save changes to the supplementary file.

Returns
int the supplementary file ID

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

References DAORegistry\getDAO(), Form\getData(), setSuppFileData(), and ArticleFileManager\uploadSuppFile().

SuppFileForm::getDefaultFormLocale ( )

Get the default form locale.

Returns
string

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

SuppFileForm::getLocaleFieldNames ( )

Get the names of fields for which data should be localized

Returns
array

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

References DAORegistry\getDAO().

SuppFileForm::initData ( )

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

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

SuppFileForm::readInputData ( )

Assign form data to user-submitted data.

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

References Form\readUserVars().

SuppFileForm::setSuppFileData ( $suppFile)

Assign form data to a SuppFile.

Parameters
$suppFileSuppFile

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

References Core\getCurrentDate(), and Form\getData().

Referenced by execute().

SuppFileForm::SuppFileForm (   $article,
  $journal,
  $suppFileId = null 
)

Constructor.

Parameters
$articleobject
$suppFileIdint (optional)

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

References Form\addCheck(), PKPLocale\getAllLocales(), and DAORegistry\getDAO().

SuppFileForm::validate ( )

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