PaperEventLogEntry Class Reference

Describes an entry in the paper history log. More...

List of all members.

Public Member Functions
	getAssocId ()
	getAssocType ()
	getAssocTypeLongString ()
	getAssocTypeString ()
	getDateLogged ()
	getEntryParams ()
	getEntryParamsSerialized ()
	getEventTitle ()
	getEventType ()
	getIPAddress ()
	getIsTranslated ()
	getLogId ()
	getLogLevel ()
	getLogLevelString ()
	getMessage ()
	getPaperId ()
	getUserEmail ()
	getUserFullName ()
	getUserId ()
	PaperEventLogEntry ()
	setAssocId ($assocId)
	setAssocType ($assocType)
	setDateLogged ($dateLogged)
	setEntryParams ($entryParams=array())
	setEventType ($eventType)
	setIPAddress ($ipAddress)
	setIsTranslated ($isTranslated)
	setLogId ($logId)
	setLogLevel ($logLevel)
	setLogMessage ($key, $params=array())
	setMessage ($message)
	setPaperId ($paperId)
	setUserId ($userId)

---

Detailed Description

Describes an entry in the paper history log.

See also:

PaperEventLogDAO

Definition at line 74 of file PaperEventLogEntry.inc.php.

---

Member Function Documentation

PaperEventLogEntry.getAssocId

(

)

Get associated ID.

Returns:

int

Definition at line 230 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getAssocType

(

)

Get associated type.

Returns:

int

Definition at line 214 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getAssocTypeLongString

(

)

Return locale message key for the long format of the associated type.

Returns:

string

Definition at line 448 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getAssocTypeString

(

)

Return string representation of the associated type.

Returns:

string

Definition at line 431 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getDateLogged

(

)

Get date entry was logged.

Returns:

datestamp

Definition at line 150 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getEntryParams

(

)

Get parameters for log message.

Returns:

array

Definition at line 265 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getEntryParamsSerialized

(

)

Get serialized parameters for log message (to store in database).

Returns:

array

Definition at line 273 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getEventTitle

(

)

Return locale message key describing event type.

Returns:

string

Definition at line 324 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getEventType

(

)

Get event type.

Returns:

int

Definition at line 198 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getIPAddress

(

)

Get IP address of user that initiated the event.

Returns:

string

Definition at line 166 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getIsTranslated

(

)

Get is_translated value (0/1).

Returns:

int

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

PaperEventLogEntry.getLogId

(

)

Get ID of log entry.

Returns:

int

Definition at line 102 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getLogLevel

(

)

Get the log level.

Returns:

int

Definition at line 182 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getLogLevelString

(

)

Return locale message key for the log level.

Returns:

string

Definition at line 305 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getMessage

(

)

Get log message key.

Returns:

string

Definition at line 289 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getPaperId

(

)

Get ID of paper.

Returns:

int

Definition at line 118 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.getUserEmail

(

)

Return the email address of the user.

Returns:

string

Definition at line 416 of file PaperEventLogEntry.inc.php.

References getUserId().

PaperEventLogEntry.getUserFullName

(

)

Return the full name of the user.

Returns:

string

Definition at line 401 of file PaperEventLogEntry.inc.php.

References getUserId().

PaperEventLogEntry.getUserId

(

)

Get user ID of user that initiated the event.

Returns:

int

Definition at line 134 of file PaperEventLogEntry.inc.php.

Referenced by getUserEmail(), and getUserFullName().

PaperEventLogEntry.PaperEventLogEntry

(

)

Constructor.

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

PaperEventLogEntry.setAssocId

(

$

assocId

)

Set associated ID.

Parameters:

$assocId

int

Definition at line 238 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setAssocType

(

$

assocType

)

Set associated type.

Parameters:

$assocType

int

Definition at line 222 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setDateLogged

(

$

dateLogged

)

Set date entry was logged.

Parameters:

$dateLogged

datestamp

Definition at line 158 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setEntryParams

(

$

entryParams = array()

)

Set parameters for log message.

Parameters:

$entryParams

array

Definition at line 281 of file PaperEventLogEntry.inc.php.

Referenced by setLogMessage().

PaperEventLogEntry.setEventType

(

$

eventType

)

Set event type.

Parameters:

$eventType

int

Definition at line 206 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setIPAddress

(

$

ipAddress

)

Set IP address of user that initiated the event.

Parameters:

$ipAddress

string

Definition at line 174 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setIsTranslated

(

$

isTranslated

)

Set is_translated value. WARNING: This is for legacy purposes only and should be assumed to be TRUE for all new entries (i.e. messages should be locale keys, not translated strings)!

Parameters:

$isTranslated

int

Definition at line 257 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setLogId

(

$

logId

)

Set ID of log entry.

Parameters:

$logId

int

Definition at line 110 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setLogLevel

(

$

logLevel

)

Set the log level.

Parameters:

$logLevel

char

Definition at line 190 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setLogMessage	(	$	key,
		$	params = array()
	)

Set localized log message (in the conference's primary locale)

Parameters:

	$key	localization message key
	$params	array optional array of parameters

Definition at line 88 of file PaperEventLogEntry.inc.php.

References setEntryParams(), and setMessage().

PaperEventLogEntry.setMessage

(

$

message

)

Set log message key.

Parameters:

$message

string

Definition at line 297 of file PaperEventLogEntry.inc.php.

Referenced by setLogMessage().

PaperEventLogEntry.setPaperId

(

$

paperId

)

Set ID of paper.

Parameters:

$paperId

int

Definition at line 126 of file PaperEventLogEntry.inc.php.

PaperEventLogEntry.setUserId

(

$

userId

)

Set user ID of user that initiated the event.

Parameters:

$userId

int

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

---

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

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

---