Public Member Functions | |
| __construct ($contextId) | |
| __construct ($contextId, $submissionId) | |
| execute (... $functionArgs) | |
| execute (... $functionArgs) | |
| fetch ($request, $template=null, $display=false) | |
| getSubmissionId () | |
| readInputData () | |
| 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 () | |
| initData () | |
| isValid () | |
| readUserVars ($vars) | |
| setData ($key, $value=null) | |
| setDefaultFormLocale ($defaultLocale) | |
| setTemplate ($template) | |
| validate ($callHooks=true) | |
Data Fields | |
| $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
Definition at line 18 of file files/submissionDocuments/form/NewLibraryFileForm.inc.php.
Constructor & Destructor Documentation
◆ __construct() [1/2]
| NewLibraryFileForm::__construct | ( | $contextId, | |
| $submissionId | |||
| ) |
Constructor.
- Parameters
-
$contextId int
Reimplemented from LibraryFileForm.
Definition at line 30 of file files/submissionDocuments/form/NewLibraryFileForm.inc.php.
References LibraryFileForm\$contextId, $submissionId, and Form\addCheck().
◆ __construct() [2/2]
| NewLibraryFileForm::__construct | ( | $contextId | ) |
Constructor.
- Parameters
-
$contextId int
Definition at line 24 of file settings/library/form/NewLibraryFileForm.inc.php.
References LibraryFileForm\$contextId, and Form\addCheck().
Member Function Documentation
◆ execute() [1/2]
| NewLibraryFileForm::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.
- $fileId int The new library file id.
Reimplemented from Form.
Definition at line 42 of file settings/library/form/NewLibraryFileForm.inc.php.
References LibraryFileForm\$libraryFileManager, PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().
◆ execute() [2/2]
| NewLibraryFileForm::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.
- $fileId int The new library file id.
Reimplemented from Form.
Definition at line 58 of file files/submissionDocuments/form/NewLibraryFileForm.inc.php.
References LibraryFileForm\$libraryFileManager, PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().
◆ fetch()
| NewLibraryFileForm::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 LibraryFileForm.
Definition at line 48 of file files/submissionDocuments/form/NewLibraryFileForm.inc.php.
References PKPTemplateManager\getManager(), and getSubmissionId().
◆ getSubmissionId()
| NewLibraryFileForm::getSubmissionId | ( | ) |
return the submission ID for this library file.
- Returns
- int
Definition at line 94 of file files/submissionDocuments/form/NewLibraryFileForm.inc.php.
References $submissionId.
Referenced by fetch().
◆ readInputData() [1/2]
| NewLibraryFileForm::readInputData | ( | ) |
Assign form data to user-submitted data.
- See also
- Form::readInputData()
Reimplemented from LibraryFileForm.
Definition at line 33 of file settings/library/form/NewLibraryFileForm.inc.php.
References Form\readUserVars().
◆ readInputData() [2/2]
| NewLibraryFileForm::readInputData | ( | ) |
Assign form data to user-submitted data. Assign form data to user-submitted data. Can be overridden from subclasses.
Reimplemented from LibraryFileForm.
Definition at line 40 of file files/submissionDocuments/form/NewLibraryFileForm.inc.php.
References Form\readUserVars().
Field Documentation
◆ $submissionId
| int NewLibraryFileForm::$submissionId |
Definition at line 24 of file files/submissionDocuments/form/NewLibraryFileForm.inc.php.
Referenced by __construct(), and getSubmissionId().
The documentation for this class was generated from the following file:
