Open Journal Systems  3.3.0
EditLibraryFileForm Class Reference
Inheritance diagram for EditLibraryFileForm:
LibraryFileForm Form

Public Member Functions

 __construct ($contextId, $fileId)
 
 __construct ($contextId, $fileId, $submissionId)
 
 execute (... $functionArgs)
 
 execute (... $functionArgs)
 
 getSubmissionId ()
 
 initData ()
 
 initData ()
 
- Public Member Functions inherited from LibraryFileForm
 fetch ($request, $template=null, $display=false)
 
 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)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $contextId
 
 $libraryFile
 
 $submissionId
 
- Data Fields inherited from LibraryFileForm
 $contextId
 
 $libraryFileManager
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for editing a library file.

Definition at line 18 of file files/submissionDocuments/form/EditLibraryFileForm.inc.php.

Constructor & Destructor Documentation

◆ __construct() [1/2]

EditLibraryFileForm::__construct (   $contextId,
  $fileId,
  $submissionId 
)

Constructor.

Parameters
$contextIdint
$fileTypeint LIBRARY_FILE_TYPE_...
$fileIdint optional

Definition at line 31 of file files/submissionDocuments/form/EditLibraryFileForm.inc.php.

References $contextId, $submissionId, fatalError(), and DAORegistry\getDAO().

◆ __construct() [2/2]

EditLibraryFileForm::__construct (   $contextId,
  $fileId 
)

Constructor.

Parameters
$contextIdint
$fileTypeint LIBRARY_FILE_TYPE_...
$fileIdint optional

Reimplemented from LibraryFileForm.

Definition at line 31 of file settings/library/form/EditLibraryFileForm.inc.php.

References $contextId, fatalError(), and DAORegistry\getDAO().

Member Function Documentation

◆ execute() [1/2]

EditLibraryFileForm::execute (   $functionArgs)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters
mixed$functionArgs,...Arguments from the caller to be passed to the hook consumer
Returns
mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Definition at line 55 of file settings/library/form/EditLibraryFileForm.inc.php.

References DAORegistry\getDAO(), and Form\getData().

◆ execute() [2/2]

EditLibraryFileForm::execute (   $functionArgs)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters
mixed$functionArgs,...Arguments from the caller to be passed to the hook consumer
Returns
mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Definition at line 57 of file files/submissionDocuments/form/EditLibraryFileForm.inc.php.

References DAORegistry\getDAO(), and Form\getData().

◆ getSubmissionId()

EditLibraryFileForm::getSubmissionId ( )

return the submission ID for this library file.

Returns
int

Definition at line 71 of file files/submissionDocuments/form/EditLibraryFileForm.inc.php.

References $submissionId.

◆ initData() [1/2]

EditLibraryFileForm::initData ( )

Initialize form data from current settings.

Reimplemented from Form.

Definition at line 44 of file settings/library/form/EditLibraryFileForm.inc.php.

◆ initData() [2/2]

EditLibraryFileForm::initData ( )

Initialize form data from current settings.

Reimplemented from Form.

Definition at line 46 of file files/submissionDocuments/form/EditLibraryFileForm.inc.php.

Field Documentation

◆ $contextId

EditLibraryFileForm::$contextId

the id of the context this library file is attached to

Definition at line 23 of file settings/library/form/EditLibraryFileForm.inc.php.

Referenced by __construct().

◆ $libraryFile

EditLibraryFileForm::$libraryFile

the file being edited, or null for new

Definition at line 20 of file files/submissionDocuments/form/EditLibraryFileForm.inc.php.

◆ $submissionId

EditLibraryFileForm::$submissionId

the id of the submission for this library file

Definition at line 23 of file files/submissionDocuments/form/EditLibraryFileForm.inc.php.

Referenced by __construct(), and getSubmissionId().


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