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

Public Member Functions

 __construct ($template, $contextId)
 
 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)
 
 execute (... $functionArgs)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

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

Detailed Description

Form for adding/editing a file.

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

Constructor & Destructor Documentation

◆ __construct()

LibraryFileForm::__construct (   $template,
  $contextId 
)

Constructor.

Parameters
$templatestring
$contextIdint

Reimplemented in NewLibraryFileForm, and EditLibraryFileForm.

Definition at line 31 of file LibraryFileForm.inc.php.

References $contextId, $libraryFileManager, and Form\addCheck().

Member Function Documentation

◆ fetch()

LibraryFileForm::fetch (   $request,
  $template = null,
  $display = false 
)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from Form.

Reimplemented in NewLibraryFileForm.

Definition at line 52 of file LibraryFileForm.inc.php.

References PKPTemplateManager\getManager(), and AppLocale\requireComponents().

◆ readInputData()

LibraryFileForm::readInputData ( )

Assign form data to user-submitted data.

See also
Form::readInputData()

Reimplemented from Form.

Reimplemented in NewLibraryFileForm, and NewLibraryFileForm.

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

References Form\readUserVars().

Field Documentation

◆ $contextId

LibraryFileForm::$contextId

the id of the context this library file is attached to

Definition at line 21 of file LibraryFileForm.inc.php.

Referenced by NewLibraryFileForm\__construct(), and __construct().

◆ $libraryFileManager

LibraryFileForm::$libraryFileManager

the library file manager instantiated in this form.

Definition at line 24 of file LibraryFileForm.inc.php.

Referenced by __construct(), and NewLibraryFileForm\execute().


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