Application-specific submission actions. More...

Inheritance diagram for Action:

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, $request)
	saveMetadata ($article, &$request)
	viewFile ($articleId, $fileId, $revision=null)
	viewMetadata ($article, $journal)

Detailed Description

Application-specific submission actions.

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

Member Function Documentation

Action.Action ( )

Constructor.

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

Referenced by AuthorAction.AuthorAction(), and SectionEditorAction.SectionEditorAction().

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 295 of file Action.inc.php.

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

Download file.

Parameters:

	$articleId	int
	$fileId	int
	$revision	int

Reimplemented in LayoutEditorAction.

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

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

Action.editComment	(	$	article,
		$	comment
	)

Edit comment.

Parameters:

$commentId

int

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

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

Display submission management instructions.

Parameters:

$type

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

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

References Request.getJournal().

Referenced by ProofreaderHandler.instructions().

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

Save comment.

Parameters:

$commentId

int

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

Action.saveMetadata	(	$	article,
		&$	request
	)

Save metadata.

Parameters:

	$article	object
	$request	PKPRequest

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

References ArticleLog.logEvent().

Referenced by SubmissionEditHandler.saveMetadata(), and SubmissionCopyeditHandler.saveMetadata().

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

View file.

Parameters:

	$articleId	int
	$fileId	int
	$revision	int

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

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

Action.viewMetadata	(	$	article,
		$	journal
	)

View metadata of an article.

Parameters:

$article

object

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

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

classes/submission/common/Action.inc.php

Action Class Reference [Submission_common]

Public Member Functions

Detailed Description

Member Function Documentation

Action Class Reference
[Submission_common]