Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
CommentForm Class Reference
Inheritance diagram for CommentForm:
Form Form CopyeditCommentForm EditorDecisionCommentForm LayoutCommentForm PeerReviewCommentForm ProofreadCommentForm

Public Member Functions

 CommentForm ($article, $commentType, $roleId, $assocId=null)
 
 CommentForm ($commentId, $articleId, $galleyId, $parentId=null)
 
 display ()
 
 display ()
 
 email ($recipients, $request)
 
 execute ()
 
 execute ()
 
 initData ()
 
 readInputData ()
 
 readInputData ()
 
 setUser (&$user)
 
- 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)
 

Additional Inherited Members

- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 

Detailed Description

Form to change metadata information for an RT comment.

Comment form.

See Also
Comment, CommentDAO
Comment, ArticleCommentDAO

Definition at line 23 of file comment/form/CommentForm.inc.php.

Member Function Documentation

CommentForm::CommentForm (   $article,
  $commentType,
  $roleId,
  $assocId = null 
)

Constructor.

Parameters
$articleobject

Definition at line 40 of file submission/form/comment/CommentForm.inc.php.

References Form\addCheck(), and PKPRequest\getUser().

CommentForm::CommentForm (   $commentId,
  $articleId,
  $galleyId,
  $parentId = null 
)
CommentForm::display ( )

Display the form.

Definition at line 71 of file submission/form/comment/CommentForm.inc.php.

References DAORegistry\getDAO().

CommentForm::display ( )

Display the form.

Definition at line 110 of file comment/form/CommentForm.inc.php.

References Request\getJournal(), PKPRequest\getUser(), Config\getVar(), and Form\setData().

CommentForm::email (   $recipients,
  $request 
)

Email the comment.

Parameters
$recipientsarray of recipients (email address => name)

Definition at line 126 of file submission/form/comment/CommentForm.inc.php.

References DAORegistry\getDAO(), Form\getData(), Request\getJournal(), and String\html2text().

CommentForm::execute ( )

Add the comment.

Definition at line 103 of file submission/form/comment/CommentForm.inc.php.

References Core\getCurrentDate(), DAORegistry\getDAO(), and Form\getData().

CommentForm::execute ( )

Save changes to comment.

Returns
int the comment ID

Definition at line 182 of file comment/form/CommentForm.inc.php.

References DAORegistry\getDAO(), Form\getData(), Request\getJournal(), PKPRequest\getUser(), and PKPRequest\getUserVar().

CommentForm::initData ( )

Initialize form data from current comment.

Definition at line 85 of file comment/form/CommentForm.inc.php.

References DAORegistry\getDAO(), and PKPRequest\getUser().

CommentForm::readInputData ( )

Assign form data to user-submitted data.

Definition at line 90 of file submission/form/comment/CommentForm.inc.php.

References Form\readUserVars().

CommentForm::readInputData ( )

Assign form data to user-submitted data.

Definition at line 158 of file comment/form/CommentForm.inc.php.

References Form\readUserVars().

CommentForm::setUser ( $user)

Set the user this comment form is associated with.

Parameters
$userobject

Definition at line 64 of file submission/form/comment/CommentForm.inc.php.


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