Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Action Class Reference
Inheritance diagram for Action:
PKPAction AuthorAction CopyeditorAction LayoutEditorAction ProofreaderAction ReviewerAction SectionEditorAction EditorAction

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)
 
- Public Member Functions inherited from PKPAction
 editCitations (&$request, &$submission)
 
 PKPAction ()
 

Detailed Description

Application-specific submission actions.

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

Member Function Documentation

Action::Action ( )

Constructor.

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

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

Delete comment.

Parameters
$commentIdint
$userobject The user who owns the comment, or null to default to Request::getUser

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

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

Referenced by SubmissionCommentsHandler\deleteComment().

Action::downloadFile (   $articleId,
  $fileId,
  $revision = null 
)
Action::editComment (   $article,
  $comment 
)

Edit comment.

Parameters
$commentIdint

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

References HookRegistry\call().

Referenced by SubmissionCommentsHandler\editComment().

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

Display submission management instructions.

Parameters
$typestring the type of instructions (copy, layout, or proof).

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

References HookRegistry\call(), Request\getJournal(), and AppLocale\requireComponents().

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

Action::saveComment (   $article,
$comment,
  $emailComment,
  $request 
)

Save comment.

Parameters
$commentIdint

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

References HookRegistry\call().

Referenced by SubmissionCommentsHandler\saveComment().

Action::saveMetadata (   $article,
$request 
)

Save metadata.

Parameters
$articleobject
$requestPKPRequest

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

References HookRegistry\call(), and ArticleLog\logEvent().

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

Action::viewFile (   $articleId,
  $fileId,
  $revision = null 
)
Action::viewMetadata (   $article,
  $journal 
)

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