Open Journal Systems  3.3.0
NewFileNoteForm Class Reference
Inheritance diagram for NewFileNoteForm:
NewNoteForm Form

Public Member Functions

 __construct ($fileId)
 
 fetch ($request, $template=null, $display=false)
 
 getAssocId ()
 
 getAssocType ()
 
 getSubmitNoteLocaleKey ()
 
- Public Member Functions inherited from NewNoteForm
 __construct ()
 
 execute (... $functionArgs)
 
 getNewNoteFormTemplate ()
 
 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

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

Detailed Description

Form to display and post notes on a file.

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

Constructor & Destructor Documentation

◆ __construct()

NewFileNoteForm::__construct (   $fileId)

Constructor.

Definition at line 29 of file NewFileNoteForm.inc.php.

References $fileId.

Member Function Documentation

◆ fetch()

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

Reimplemented from NewNoteForm.

Definition at line 63 of file NewFileNoteForm.inc.php.

References PKPTemplateManager\getManager().

◆ getAssocId()

NewFileNoteForm::getAssocId ( )

Return the assoc ID for this note.

Returns
int

Reimplemented from NewNoteForm.

Definition at line 56 of file NewFileNoteForm.inc.php.

References $fileId.

◆ getAssocType()

NewFileNoteForm::getAssocType ( )

Return the assoc type for this note.

Returns
int

Reimplemented from NewNoteForm.

Definition at line 39 of file NewFileNoteForm.inc.php.

◆ getSubmitNoteLocaleKey()

NewFileNoteForm::getSubmitNoteLocaleKey ( )

Return the submit note button locale key. Can be overriden by subclasses.

Returns
string

Reimplemented from NewNoteForm.

Definition at line 48 of file NewFileNoteForm.inc.php.

Field Documentation

◆ $fileId

int NewFileNoteForm::$fileId

The ID of the submission file to attach the note to

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

Referenced by __construct(), and getAssocId().


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