PaperLog Class Reference [Paper_log]

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

List of all members.

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

---

Detailed Description

Static class for adding / accessing paper log entries.

Definition at line 17 of file PaperLog.inc.php.

---

Member Function Documentation

& PaperLog.getEmailLogEntries	(	$	paperId,
		$	rangeInfo = null
	)

Get all email log entries for a paper.

Parameters:

$paperId

int

Returns:

array PaperEmailLogEntry

Definition at line 142 of file PaperLog.inc.php.

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

& PaperLog.getEventLogEntries	(	$	paperId,
		$	rangeInfo = null
	)

Get all event log entries for a paper.

Parameters:

$paperId

int

Returns:

array PaperEventLogEntry

Definition at line 96 of file PaperLog.inc.php.

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

PaperLog.logEmailEntry	(	$	paperId,
		&$	entry
	)

Add an email log entry to this paper.

Parameters:

	$paperId	int
	$entry	PaperEmailLogEntry

Definition at line 107 of file PaperLog.inc.php.

Referenced by PaperMailTemplate.log().

PaperLog.logEvent	(	$	paperId,
		$	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:

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

Definition at line 63 of file PaperLog.inc.php.

References logEventLevel().

Referenced by TrackDirectorAction.addReviewer(), TrackDirectorAction.archiveSubmission(), DirectorAction.assignDirector(), TrackDirectorAction.cancelReview(), TrackDirectorAction.clearReview(), TrackDirectorAction.completePaper(), AuthorSubmitStep5Form.execute(), AuthorSubmitStep3Form.execute(), TrackDirectorAction.rateReviewer(), TrackDirectorAction.recordDecision(), TrackDirectorAction.restoreToQueue(), Action.saveMetadata(), TrackDirectorAction.setDueDate(), TrackDirectorAction.setEditingFile(), TrackDirectorAction.setReviewerRecommendation(), TrackDirectorAction.uploadDirectorVersion(), and AuthorAction.uploadRevisedVersion().

PaperLog.logEventEntry	(	$	paperId,
		&$	entry
	)

Add an event log entry to this paper.

Parameters:

	$paperId	int
	$entry	PaperEventLogEntry

Definition at line 24 of file PaperLog.inc.php.

Referenced by ReviewerAction.confirmReview(), TrackDirectorAction.confirmReviewForReviewer(), logEventLevel(), ReviewerAction.recordRecommendation(), ReviewerAction.uploadReviewerVersion(), and TrackDirectorAction.uploadReviewForReviewer().

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

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

Parameters:

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

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

References logEventEntry().

Referenced by logEvent().

---

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

• classes/paper/log/PaperLog.inc.php