CommentForm Class Reference
[Rt_ojs_form, Submission_form]

Form to change metadata information for an RT comment. More...

Inheritance diagram for CommentForm:

List of all members.

Public Member Functions
	CommentForm ($article, $commentType, $roleId, $assocId=null)
	CommentForm ($commentId, $articleId, $galleyId, $parentId=null)
	display ()
	display ()
	email ($recipients)
	execute ()
	execute ()
	initData ()
	readInputData ()
	readInputData ()
	setUser (&$user)

---

Detailed Description

Form to change metadata information for an RT comment.

Comment form.

See also:

Comment, CommentDAO

Comment, ArticleCommentDAO

Definition at line 26 of file CommentForm.inc.php.

---

Member Function Documentation

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

Constructor.

Parameters:

$article

object

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

References Form.addCheck(), and Request.getUser().

CommentForm.CommentForm	(	$	commentId,
		$	articleId,
		$	galleyId,
		$	parentId = null
	)

Constructor.

Definition at line 49 of file CommentForm.inc.php.

References Form.addCheck(), DAORegistry.getDAO(), and Config.getVar().

CommentForm.display

(

)

Display the form.

Reimplemented from Form.

Reimplemented in CopyeditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, and ProofreadCommentForm.

Definition at line 73 of file CommentForm.inc.php.

References DAORegistry.getDAO(), and TemplateManager.getManager().

CommentForm.display

(

)

Display the form.

Reimplemented from Form.

Reimplemented in CopyeditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, and ProofreadCommentForm.

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

References Request.getJournal(), TemplateManager.getManager(), Request.getUser(), and Form.setData().

CommentForm.email

(

$

recipients

)

Email the comment.

Parameters:

$recipients

array of recipients (email address => name)

Definition at line 127 of file CommentForm.inc.php.

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

CommentForm.execute

(

)

Add the comment.

Reimplemented from Form.

Reimplemented in CopyeditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, and ProofreadCommentForm.

Definition at line 104 of file CommentForm.inc.php.

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

CommentForm.execute

(

)

Save changes to comment.

Returns:

int the comment ID

Reimplemented from Form.

Reimplemented in CopyeditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, and ProofreadCommentForm.

Definition at line 156 of file CommentForm.inc.php.

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

CommentForm.initData

(

)

Initialize form data from current comment.

Reimplemented from Form.

Definition at line 77 of file CommentForm.inc.php.

References Request.getUser().

CommentForm.readInputData

(

)

Assign form data to user-submitted data.

Reimplemented from Form.

Reimplemented in CopyeditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, and ProofreadCommentForm.

Definition at line 91 of file CommentForm.inc.php.

References Form.readUserVars().

CommentForm.readInputData

(

)

Assign form data to user-submitted data.

Reimplemented from Form.

Reimplemented in CopyeditCommentForm, EditorDecisionCommentForm, LayoutCommentForm, PeerReviewCommentForm, and ProofreadCommentForm.

Definition at line 137 of file CommentForm.inc.php.

References Form.readUserVars().

CommentForm.setUser

(

&$

user

)

Set the user this comment form is associated with.

Parameters:

$user

object

Definition at line 66 of file CommentForm.inc.php.

---

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

• classes/comment/form/CommentForm.inc.php
• classes/submission/form/comment/CommentForm.inc.php