Action Class Reference
[Submission]

Action class. More...

Inheritance diagram for Action:

List of all members.

Public Member Functions
	Action ()
	deleteComment ($commentId, $user=null)
	downloadFile ($articleId, $fileId, $revision=null)
	editComment ($article, $comment)
	instructions ($type, $allowed=array('copy', 'layout', 'proof', 'referenceLinking'))
	saveComment ($article, &$comment, $emailComment)
	saveMetadata ($article)
	viewFile ($articleId, $fileId, $revision=null)
	viewMetadata ($article, $roleId)

---

Detailed Description

Action class.

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

---

Member Function Documentation

Action.Action

(

)

Constructor.

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

Action.deleteComment	(	$	commentId,
		$	user = null
	)

Delete comment.

Parameters:

	$commentId	int
	$user	object The user who owns the comment, or null to default to Request.getUser

Definition at line 272 of file Action.inc.php.

References HookRegistry.call(), DAORegistry.getDAO(), and Request.getUser().

Referenced by SubmissionCommentsHandler.deleteComment().

Action.downloadFile	(	$	articleId,
		$	fileId,
		$	revision = null
	)

Download file.

Parameters:

	$articleId	int
	$fileId	int
	$revision	int

Reimplemented in LayoutEditorAction.

Definition at line 168 of file Action.inc.php.

Referenced by TrackSubmissionHandler.download(), AuthorAction.downloadAuthorFile(), CopyeditorAction.downloadCopyeditorFile(), SubmissionEditHandler.downloadFile(), ProofreaderAction.downloadProofreaderFile(), and ReviewerAction.downloadReviewerFile().

Action.editComment	(	$	article,
		$	comment
	)

Edit comment.

Parameters:

$commentId

int

Definition at line 233 of file Action.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.editComment().

Action.instructions	(	$	type,
		$	allowed = array('copy', 'layout', 'proof', 'referenceLinking')
	)

Parameters:

$type

string the type of instructions (copy, layout, or proof).

Definition at line 190 of file Action.inc.php.

References HookRegistry.call(), Request.getJournal(), and TemplateManager.getManager().

Referenced by SectionEditorHandler.instructions(), ProofreaderHandler.instructions(), LayoutEditorHandler.instructions(), CopyeditorHandler.instructions(), and AuthorHandler.instructions().

Action.saveComment	(	$	article,
		&$	comment,
		$	emailComment
	)

Save comment.

Parameters:

$commentId

int

Definition at line 247 of file Action.inc.php.

References HookRegistry.call().

Referenced by SubmissionCommentsHandler.saveComment().

Action.saveMetadata

(

$

article

)

Save metadata.

Parameters:

$article

object

Definition at line 76 of file Action.inc.php.

References HookRegistry.call(), Request.getUser(), Request.getUserVar(), and ArticleLog.logEvent().

Action.viewFile	(	$	articleId,
		$	fileId,
		$	revision = null
	)

View file.

Parameters:

	$articleId	int
	$fileId	int
	$revision	int

Definition at line 180 of file Action.inc.php.

Referenced by SubmissionEditHandler.viewFile(), SubmissionProofreadHandler.viewFile(), SubmissionLayoutHandler.viewFile(), SubmissionCopyeditHandler.viewFile(), TrackSubmissionHandler.viewFile(), and ArticleHandler.viewFile().

Action.viewMetadata	(	$	article,
		$	roleId
	)

Actions. View metadata of an article.

Parameters:

$article

object

Definition at line 59 of file Action.inc.php.

References HookRegistry.call().

Referenced by SubmissionReviewHandler.viewMetadata(), and SubmissionCopyeditHandler.viewMetadata().

---

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

• classes/submission/common/Action.inc.php