Open Journal Systems  3.3.0
PKPSubmissionSubmitStep1Form Class Reference
Inheritance diagram for PKPSubmissionSubmitStep1Form:
SubmissionSubmitForm Form SubmissionSubmitStep1Form

Public Member Functions

 __construct ($context, $submission=null)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getCommentsToEditor ($submissionId)
 
 initData ($data=array())
 
 readInputData ()
 
 setCommentsToEditor ($submissionId, $commentsToEditor, $userId, $query=null)
 
 setPublicationData ($publication, $submission)
 
 setSubmissionData ($submission)
 
 validate ($callHooks=true)
 
- Public Member Functions inherited from SubmissionSubmitForm
 __construct ($context, $submission, $step)
 
- 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)
 

Data Fields

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

Detailed Description

Form for Step 1 of author submission: terms, conditions, etc.

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

Constructor & Destructor Documentation

◆ __construct()

PKPSubmissionSubmitStep1Form::__construct (   $context,
  $submission = null 
)

Constructor.

Parameters
$contextContext
$submissionSubmission (optional)

Reimplemented in SubmissionSubmitStep1Form.

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

References SubmissionSubmitForm\$context, SubmissionSubmitForm\$submission, Form\addCheck(), PKPApplication\get(), and Config\getVar().

Member Function Documentation

◆ execute()

PKPSubmissionSubmitStep1Form::execute (   $functionArgs)

◆ fetch()

PKPSubmissionSubmitStep1Form::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 SubmissionSubmitForm.

Reimplemented in SubmissionSubmitStep1Form.

Definition at line 87 of file PKPSubmissionSubmitStep1Form.inc.php.

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

◆ getCommentsToEditor()

PKPSubmissionSubmitStep1Form::getCommentsToEditor (   $submissionId)

Get comments to editor

Parameters
$submissionIdint
Returns
null|Query

Definition at line 316 of file PKPSubmissionSubmitStep1Form.inc.php.

References SubmissionSubmitForm\$submissionId, and DAORegistry\getDAO().

Referenced by execute(), and initData().

◆ initData()

PKPSubmissionSubmitStep1Form::initData (   $data = array())

Initialize form data from current submission.

See also
SubmissionSubmitForm::initData
Parameters
$dataarray

Reimplemented in SubmissionSubmitStep1Form.

Definition at line 191 of file PKPSubmissionSubmitStep1Form.inc.php.

References getCommentsToEditor(), and AppLocale\getLocale().

◆ readInputData()

PKPSubmissionSubmitStep1Form::readInputData ( )

Assign form data to user-submitted data.

Reimplemented from Form.

Reimplemented in SubmissionSubmitStep1Form.

Definition at line 222 of file PKPSubmissionSubmitStep1Form.inc.php.

References Form\readUserVars().

◆ setCommentsToEditor()

PKPSubmissionSubmitStep1Form::setCommentsToEditor (   $submissionId,
  $commentsToEditor,
  $userId,
  $query = null 
)

Add or update comments to editor

Parameters
$submissionIdint
$commentsToEditorstring
$userIdint
$queryQuery optional

Definition at line 262 of file PKPSubmissionSubmitStep1Form.inc.php.

References SubmissionSubmitForm\$submissionId, Core\getCurrentDate(), and DAORegistry\getDAO().

Referenced by execute().

◆ setPublicationData()

PKPSubmissionSubmitStep1Form::setPublicationData (   $publication,
  $submission 
)

Set the publication data from the form.

Parameters
Publication$publication
Submission$submission

Reimplemented in SubmissionSubmitStep1Form.

Definition at line 244 of file PKPSubmissionSubmitStep1Form.inc.php.

References SubmissionSubmitForm\$submission, DAORegistry\getDAO(), Form\getData(), and PKPString\substr().

Referenced by execute().

◆ setSubmissionData()

PKPSubmissionSubmitStep1Form::setSubmissionData (   $submission)

Set the submission data from the form.

Parameters
Submission$submission

Definition at line 237 of file PKPSubmissionSubmitStep1Form.inc.php.

Referenced by execute().

◆ validate()

PKPSubmissionSubmitStep1Form::validate (   $callHooks = true)

Perform additional validation checks Validate form data.

Parameters
$callHooksboolean True (default) iff hooks are to be called.

Reimplemented from Form.

Reimplemented in SubmissionSubmitStep1Form.

Definition at line 62 of file PKPSubmissionSubmitStep1Form.inc.php.

References SubmissionSubmitForm\$context, PKPApplication\get(), DAORegistry\getDAO(), and Form\getData().

Field Documentation

◆ $hasPrivacyStatement

boolean PKPSubmissionSubmitStep1Form::$hasPrivacyStatement = true

Is there a privacy statement to be confirmed?

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


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