EventLogEntry Class Reference

Inheritance diagram for EventLogEntry:

Public Member Functions
	getAssocId ()
	getAssocType ()
	getDateLogged ()
	getEventType ()
	getIsTranslated ()
	getMessage ()
	getParams ()
	getTranslatedMessage ($locale=null, $hideReviewerName=false)
	getUserEmail ()
	getUserFullName ()
	getUserId ()
	setAssocId ($assocId)
	setAssocType ($assocType)
	setDateLogged ($dateLogged)
	setEventType ($eventType)
	setIsTranslated ($isTranslated)
	setMessage ($message)
	setParams ($params)
	setUserId ($userId)
Public Member Functions inherited from DataObject
	__construct ()
	addSupportedMetadataAdapter ($metadataAdapter)
	extractMetadata ($metadataSchema)
	getAdditionalMetadataFieldNames ()
&	getAllData ()
	getDAO ()
&	getData ($key, $locale=null)
	getHasLoadableAdapters ()
	getId ()
	getLocaleMetadataFieldNames ()
	getLocalizedData ($key, $preferredLocale=null)
	getMetadataFieldNames ($translated=true)
	getSetMetadataFieldNames ($translated=true)
	getSupportedExtractionAdapters ()
	getSupportedInjectionAdapters ()
	getSupportedMetadataSchemas ()
	hasData ($key, $locale=null)
	injectMetadata ($metadataDescription)
	removeSupportedMetadataAdapter ($metadataSchemaName)
	setAllData (&$data)
	setData ($key, $value, $locale=null)
	setHasLoadableAdapters ($hasLoadableAdapters)
	setId ($id)
	unsetData ($key, $locale=null)
	upcastTo ($targetObject)

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()
	$_extractionAdaptersLoaded = false
	$_hasLoadableAdapters = false
	$_injectionAdaptersLoaded = false
	$_metadataExtractionAdapters = array()
	$_metadataInjectionAdapters = array()

Detailed Description

Describes an entry in the event log.

See also

EventLogDAO

Definition at line 21 of file EventLogEntry.inc.php.

Member Function Documentation

getAssocId()

EventLogEntry::getAssocId

(

)

Get associated ID.

Returns

int

Definition at line 95 of file EventLogEntry.inc.php.

References DataObject\getData().

Referenced by SubmissionFileEventLogEntry\getFileId(), and PKPSubmissionEventLogEntry\getSubmissionId().

getAssocType()

EventLogEntry::getAssocType

(

)

Get associated type.

Returns

int

Reimplemented in PKPSubmissionEventLogEntry.

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

References DataObject\getData().

getDateLogged()

EventLogEntry::getDateLogged

(

)

Get date entry was logged.

Returns

datestamp

Definition at line 47 of file EventLogEntry.inc.php.

References DataObject\getData().

getEventType()

EventLogEntry::getEventType

(

)

Get event type.

Returns

int

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

References DataObject\getData().

getIsTranslated()

EventLogEntry::getIsTranslated

(

)

Get flag indicating whether or not message is translated.

Returns

boolean

Definition at line 127 of file EventLogEntry.inc.php.

References DataObject\getData().

Referenced by getTranslatedMessage().

getMessage()

EventLogEntry::getMessage

(

)

Get custom log message (either locale key or literal string).

Returns

string

Definition at line 111 of file EventLogEntry.inc.php.

References DataObject\getData().

Referenced by getTranslatedMessage().

getParams()

EventLogEntry::getParams

(

)

Get custom log message parameters.

Returns

array

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

References DataObject\getData().

Referenced by getTranslatedMessage().

getTranslatedMessage()

EventLogEntry::getTranslatedMessage	(		$locale = null,
			$hideReviewerName = false
	)

Get translated message, translating it if necessary.

Parameters

$locale	string optional
$hideReviewerName	boolean optional Don't reveal reviewer names in log descriptions.

Definition at line 145 of file EventLogEntry.inc.php.

References DAORegistry\getDAO(), getIsTranslated(), AppLocale\getLocale(), getMessage(), and getParams().

getUserEmail()

EventLogEntry::getUserEmail

(

)

Return the email address of the user.

Returns

string

Definition at line 232 of file EventLogEntry.inc.php.

References DAORegistry\getDAO(), DataObject\getData(), and getUserId().

getUserFullName()

EventLogEntry::getUserFullName

(

)

Return the full name of the user.

Returns

string

Definition at line 218 of file EventLogEntry.inc.php.

References DAORegistry\getDAO(), DataObject\getData(), and getUserId().

getUserId()

EventLogEntry::getUserId

(

)

Get user ID of user that initiated the event.

Returns

int

Definition at line 31 of file EventLogEntry.inc.php.

References DataObject\getData().

Referenced by getUserEmail(), and getUserFullName().

setAssocId()

EventLogEntry::setAssocId

(

$assocId

)

Set associated ID.

Parameters

$assocId

int

Definition at line 103 of file EventLogEntry.inc.php.

References DataObject\setData().

Referenced by SubmissionFileEventLogEntry\setFileId(), and PKPSubmissionEventLogEntry\setSubmissionId().

setAssocType()

EventLogEntry::setAssocType

(

$assocType

)

Set associated type.

Parameters

$assocType

int

Definition at line 87 of file EventLogEntry.inc.php.

References DataObject\setData().

setDateLogged()

EventLogEntry::setDateLogged

(

$dateLogged

)

Set date entry was logged.

Parameters

$dateLogged

datestamp

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

References DataObject\setData().

setEventType()

EventLogEntry::setEventType

(

$eventType

)

Set event type.

Parameters

$eventType

int

Definition at line 71 of file EventLogEntry.inc.php.

References DataObject\setData().

setIsTranslated()

EventLogEntry::setIsTranslated

(

$isTranslated

)

Set flag indicating whether or not message is translated.

Parameters

$isTranslated

int

Definition at line 135 of file EventLogEntry.inc.php.

References DataObject\setData().

setMessage()

EventLogEntry::setMessage

(

$message

)

Set custom log message (either locale key or literal string).

Parameters

$message

string

Definition at line 119 of file EventLogEntry.inc.php.

References DataObject\setData().

setParams()

EventLogEntry::setParams

(

$params

)

Set custom log message parameters.

Parameters

$params

array

Definition at line 210 of file EventLogEntry.inc.php.

References DataObject\setData().

setUserId()

EventLogEntry::setUserId

(

$userId

)

Set user ID of user that initiated the event.

Parameters

$userId

int

Definition at line 39 of file EventLogEntry.inc.php.

References DataObject\setData().

---

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

• EventLogEntry.inc.php