Open Journal Systems  3.3.0
SubmissionSubmitForm Class Reference
Inheritance diagram for SubmissionSubmitForm:
Form PKPSubmissionSubmitStep1Form PKPSubmissionSubmitStep2Form PKPSubmissionSubmitStep3Form PKPSubmissionSubmitStep4Form SubmissionSubmitStep1Form SubmissionSubmitStep2Form SubmissionSubmitStep3Form SubmissionSubmitStep4Form

Public Member Functions

 __construct ($context, $submission, $step)
 
 fetch ($request, $template=null, $display=false)
 
- 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 ()
 
 readInputData ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $context
 
 $step
 
 $submission
 
 $submissionId
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Base class for author submit forms.

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

Constructor & Destructor Documentation

◆ __construct()

SubmissionSubmitForm::__construct (   $context,
  $submission,
  $step 
)

Constructor.

Parameters
$submissionobject
$stepint

Reimplemented in PKPSubmissionSubmitStep3Form.

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

References $context, $step, $submission, and Form\addCheck().

Member Function Documentation

◆ fetch()

SubmissionSubmitForm::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 PKPSubmissionSubmitStep1Form, PKPSubmissionSubmitStep3Form, SubmissionSubmitStep3Form, and SubmissionSubmitStep1Form.

Definition at line 64 of file SubmissionSubmitForm.inc.php.

References PKPTemplateManager\getManager().

Field Documentation

◆ $context

◆ $step

int SubmissionSubmitForm::$step

the current step

Definition at line 44 of file SubmissionSubmitForm.inc.php.

Referenced by __construct().

◆ $submission

◆ $submissionId


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