Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
NewSignoffNoteForm Class Reference
Inheritance diagram for NewSignoffNoteForm:
NewNoteForm Form

Public Member Functions

 fetch ($request)
 
 getAssocId ()
 
 getAssocType ()
 
 getNewNoteFormTemplate ()
 
 getSubmitNoteLocaleKey ()
 
 NewSignoffNoteForm ($signoffId, $submissionId, $signoffSymbolic, $stageId)
 
 readInputData ()
 
 validate ()
 
- Public Member Functions inherited from NewNoteForm
 execute ($request)
 
 fetch ($request)
 
 getAssocId ()
 
 getAssocType ()
 
 getNewNoteFormTemplate ()
 
 getSubmitNoteLocaleKey ()
 
 NewNoteForm ()
 
 readInputData ()
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Public Attributes

 $_actionArgs
 
 $_stageId
 
 $_submissionId
 
 $_symbolic
 
 $signoffId
 
- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form to display and post notes on a signoff.

Definition at line 18 of file NewSignoffNoteForm.inc.php.

Member Function Documentation

NewSignoffNoteForm::fetch (   $request)

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

Definition at line 116 of file NewSignoffNoteForm.inc.php.

NewSignoffNoteForm::getAssocId ( )

Return the assoc ID for this note.

Returns
int

Definition at line 78 of file NewSignoffNoteForm.inc.php.

NewSignoffNoteForm::getAssocType ( )

Return the assoc type for this note.

Returns
int

Definition at line 70 of file NewSignoffNoteForm.inc.php.

NewSignoffNoteForm::getNewNoteFormTemplate ( )

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

Returns
string

Definition at line 85 of file NewSignoffNoteForm.inc.php.

NewSignoffNoteForm::getSubmitNoteLocaleKey ( )

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

Returns
string

Definition at line 92 of file NewSignoffNoteForm.inc.php.

References $signoffId.

NewSignoffNoteForm::NewSignoffNoteForm (   $signoffId,
  $submissionId,
  $signoffSymbolic,
  $stageId 
)

Constructor.

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

NewSignoffNoteForm::readInputData ( )

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

Definition at line 99 of file NewSignoffNoteForm.inc.php.

NewSignoffNoteForm::validate ( )

Validate form data.

Definition at line 107 of file NewSignoffNoteForm.inc.php.

Member Data Documentation

array NewSignoffNoteForm::$_actionArgs

The fetch notes list action args.

Definition at line 47 of file NewSignoffNoteForm.inc.php.

int NewSignoffNoteForm::$_stageId

The signoff stage id.

Definition at line 41 of file NewSignoffNoteForm.inc.php.

int NewSignoffNoteForm::$_submissionId

The ID of the signoff submission

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

int NewSignoffNoteForm::$_symbolic

The signoff symbolic.

Definition at line 35 of file NewSignoffNoteForm.inc.php.

int NewSignoffNoteForm::$signoffId

The ID of the signoff to attach the note to

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

Referenced by getSubmitNoteLocaleKey().


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