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

Public Member Functions

 __construct ()
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getAssocId ()
 
 getAssocType ()
 
 getNewNoteFormTemplate ()
 
 getSubmitNoteLocaleKey ()
 
 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)
 

Additional Inherited Members

- 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 NewNoteForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

NewNoteForm::__construct ( )

Constructor.

Definition at line 23 of file NewNoteForm.inc.php.

References Form\addCheck().

Member Function Documentation

◆ execute()

NewNoteForm::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 91 of file NewNoteForm.inc.php.

References PKPApplication\get(), getAssocId(), getAssocType(), DAORegistry\getDAO(), and Form\getData().

◆ fetch()

NewNoteForm::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 NewFileNoteForm.

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

References DAORegistry\getDAO(), and PKPTemplateManager\getManager().

◆ getAssocId()

NewNoteForm::getAssocId ( )

Return the assoc ID for this note.

Returns
int

Reimplemented in NewFileNoteForm, and NewSubmissionNoteForm.

Definition at line 42 of file NewNoteForm.inc.php.

Referenced by execute().

◆ getAssocType()

NewNoteForm::getAssocType ( )

Return the assoc type for this note.

Returns
int

Reimplemented in NewFileNoteForm, and NewSubmissionNoteForm.

Definition at line 34 of file NewNoteForm.inc.php.

Referenced by execute().

◆ getNewNoteFormTemplate()

NewNoteForm::getNewNoteFormTemplate ( )

Get the new note form template. Subclasses can override this method to define other template.

Returns
string

Definition at line 60 of file NewNoteForm.inc.php.

◆ getSubmitNoteLocaleKey()

NewNoteForm::getSubmitNoteLocaleKey ( )

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

Returns
string

Reimplemented in NewFileNoteForm, and NewSubmissionNoteForm.

Definition at line 51 of file NewNoteForm.inc.php.

◆ readInputData()

NewNoteForm::readInputData ( )

Assign form data to user-submitted data. Can be overridden from subclasses.

Reimplemented from Form.

Definition at line 81 of file NewNoteForm.inc.php.

References Form\readUserVars().


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