ArticleLog Class Reference
[Article_log]

Static class for adding / accessing article log entries. More...

List of all members.

Public Member Functions
&	getEmailLogEntries ($articleId, $rangeInfo=null)
&	getEventLogEntries ($articleId, $rangeInfo=null)
	logEmailEntry ($articleId, &$entry)
	logEvent ($articleId, $eventType, $assocType=0, $assocId=0, $messageKey=null, $messageParams=array())
	logEventEntry ($articleId, &$entry)
	logEventLevel ($articleId, $logLevel, $eventType, $assocType=0, $assocId=0, $messageKey=null, $messageParams=array())

---

Detailed Description

Static class for adding / accessing article log entries.

Definition at line 22 of file ArticleLog.inc.php.

---

Member Function Documentation

& ArticleLog.getEmailLogEntries	(	$	articleId,
		$	rangeInfo = null
	)

Get all email log entries for an article.

Parameters:

$articleId

int

Returns:

array ArticleEmailLogEntry

Definition at line 141 of file ArticleLog.inc.php.

References DAORegistry.getDAO().

Referenced by SubmissionEditHandler.submissionEmailLog(), and SubmissionEditHandler.submissionHistory().

& ArticleLog.getEventLogEntries	(	$	articleId,
		$	rangeInfo = null
	)

Get all event log entries for an article.

Parameters:

$articleId

int

Returns:

array ArticleEventLogEntry

Definition at line 98 of file ArticleLog.inc.php.

References DAORegistry.getDAO().

Referenced by SubmissionEditHandler.submissionEventLog(), and SubmissionEditHandler.submissionHistory().

ArticleLog.logEmailEntry	(	$	articleId,
		&$	entry
	)

Add an email log entry to this article.

Parameters:

	$articleId	int
	$entry	ArticleEmailLogEntry

Definition at line 109 of file ArticleLog.inc.php.

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

Referenced by ArticleMailTemplate.log().

ArticleLog.logEvent	(	$	articleId,
		$	eventType,
		$	assocType = 0,
		$	assocId = 0,
		$	messageKey = null,
		$	messageParams = array()
	)

Add a new event log entry with the specified parameters, at the default log level

Parameters:

	$articleId	int
	$eventType	int
	$assocType	int
	$assocId	int
	$messageKey	string
	$messageParams	array

Definition at line 65 of file ArticleLog.inc.php.

References logEventLevel().

Referenced by SectionEditorAction.addReviewer(), SectionEditorAction.archiveSubmission(), EditorAction.assignEditor(), SectionEditorAction.assignLayoutEditor(), SectionEditorAction.cancelReview(), SectionEditorAction.clearReview(), AuthorAction.completeAuthorCopyedit(), SectionEditorAction.completeCopyedit(), CopyeditorAction.completeCopyedit(), SectionEditorAction.completeFinalCopyedit(), CopyeditorAction.completeFinalCopyedit(), LayoutEditorAction.completeLayoutEditing(), CopyeditorAction.copyeditUnderway(), AuthorSubmitStep5Form.execute(), EditorAction.expediteSubmission(), SectionEditorAction.rateReviewer(), SectionEditorAction.recordDecision(), SectionEditorAction.restoreToQueue(), SectionEditorAction.resubmitFile(), Action.saveMetadata(), SectionEditorAction.selectCopyeditor(), ProofreaderAction.selectProofreader(), SectionEditorAction.setCopyeditFile(), SectionEditorAction.setDueDate(), SectionEditorAction.setReviewerRecommendation(), SectionEditorAction.uploadEditorVersion(), and AuthorAction.uploadRevisedVersion().

ArticleLog.logEventEntry	(	$	articleId,
		&$	entry
	)

Add an event log entry to this article.

Parameters:

	$articleId	int
	$entry	ArticleEventLogEntry

Definition at line 29 of file ArticleLog.inc.php.

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

Referenced by ReviewerAction.confirmReview(), SectionEditorAction.confirmReviewForReviewer(), logEventLevel(), ReviewerAction.recordRecommendation(), CopyeditorAction.uploadCopyeditVersion(), ReviewerAction.uploadReviewerVersion(), and SectionEditorAction.uploadReviewForReviewer().

ArticleLog.logEventLevel	(	$	articleId,
		$	logLevel,
		$	eventType,
		$	assocType = 0,
		$	assocId = 0,
		$	messageKey = null,
		$	messageParams = array()
	)

Add a new event log entry with the specified parameters, including log level.

Parameters:

	$articleId	int
	$logLevel	char
	$eventType	int
	$assocType	int
	$assocId	int
	$messageKey	string
	$messageParams	array

Definition at line 79 of file ArticleLog.inc.php.

References logEventEntry().

Referenced by logEvent().

---

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

• classes/article/log/ArticleLog.inc.php