PaperEventLogDAO Class Reference
[Paper_log]

Class for inserting/accessing paper history log entries. More...

List of all members.

Public Member Functions
&	_returnLogEntryFromRow (&$row)
	deleteLogEntry ($logId, $paperId=null)
	deletePaperLogEntries ($paperId)
	getInsertLogId ()
&	getLogEntry ($logId, $paperId=null)
&	getPaperLogEntries ($paperId, $rangeInfo=null)
&	getPaperLogEntriesByAssoc ($paperId, $assocType=null, $assocId=null, $rangeInfo=null)
	insertLogEntry (&$entry)
	transferPaperLogEntries ($oldUserId, $newUserId)

---

Detailed Description

Class for inserting/accessing paper history log entries.

See also:

PaperEventLogEntry

Definition at line 20 of file PaperEventLogDAO.inc.php.

---

Member Function Documentation

& PaperEventLogDAO._returnLogEntryFromRow

(

&$

row

)

Internal function to return an PaperEventLogEntry object from a row.

Parameters:

$row

array

Returns:

PaperEventLogEntry

Definition at line 92 of file PaperEventLogDAO.inc.php.

Referenced by getLogEntry(), and getPaperLogEntriesByAssoc().

PaperEventLogDAO.deleteLogEntry	(	$	logId,
		$	paperId = null
	)

Delete a single log entry for a paper.

Parameters:

	$logId	int
	$paperId	int optional

Definition at line 152 of file PaperEventLogDAO.inc.php.

PaperEventLogDAO.deletePaperLogEntries

(

$

paperId

)

Delete all log entries for a paper.

Parameters:

$paperId

int

Definition at line 170 of file PaperEventLogDAO.inc.php.

PaperEventLogDAO.getInsertLogId

(

)

Get the ID of the last inserted log entry.

Returns:

int

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

Referenced by insertLogEntry().

& PaperEventLogDAO.getLogEntry	(	$	logId,
		$	paperId = null
	)

Retrieve a log entry by ID.

Parameters:

	$logId	int
	$paperId	int optional

Returns:

PaperEventLogEntry

Definition at line 27 of file PaperEventLogDAO.inc.php.

References _returnLogEntryFromRow().

& PaperEventLogDAO.getPaperLogEntries	(	$	paperId,
		$	rangeInfo = null
	)

Retrieve all log entries for a paper.

Parameters:

$paperId

int

Returns:

DAOResultFactory containing matching PaperEventLogEntry PaperEventLogEntry ordered by sequence

Definition at line 55 of file PaperEventLogDAO.inc.php.

References getPaperLogEntriesByAssoc().

& PaperEventLogDAO.getPaperLogEntriesByAssoc	(	$	paperId,
		$	assocType = null,
		$	assocId = null,
		$	rangeInfo = null
	)

Retrieve all log entries for a paper matching the specified association.

Parameters:

	$paperId	int
	$assocType	int
	$assocId	int
	$limit	int limit the number of entries retrieved (default false)
	$recentFirst	boolean order with most recent entries first (default true)

Returns:

DAOResultFactory containing matching PaperEventLogEntry ordered by sequence

Definition at line 69 of file PaperEventLogDAO.inc.php.

References _returnLogEntryFromRow().

Referenced by getPaperLogEntries().

PaperEventLogDAO.insertLogEntry

(

&$

entry

)

Insert a new log entry.

Parameters:

$entry

PaperEventLogEntry

Definition at line 116 of file PaperEventLogDAO.inc.php.

References getInsertLogId().

PaperEventLogDAO.transferPaperLogEntries	(	$	oldUserId,
		$	newUserId
	)

Transfer all paper log entries to another user.

Parameters:

$paperId

int

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

---

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

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

---