Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
EventLogEntry Class Reference
Inheritance diagram for EventLogEntry:
DataObject ArticleEventLogEntry

Public Member Functions

 EventLogEntry ()
 
 getAssocId ()
 
 getAssocType ()
 
 getDateLogged ()
 
 getEventType ()
 
 getIPAddress ()
 
 getIsTranslated ()
 
 getMessage ()
 
 getParams ()
 
 getTranslatedMessage ($locale=null)
 
 getUserEmail ()
 
 getUserFullName ()
 
 getUserId ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setDateLogged ($dateLogged)
 
 setEventType ($eventType)
 
 setIPAddress ($ipAddress)
 
 setIsTranslated ($isTranslated)
 
 setMessage ($message)
 
 setParams ($params)
 
 setUserId ($userId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Describes an entry in the event log.

See Also
EventLogDAO

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

Member Function Documentation

EventLogEntry::EventLogEntry ( )

Constructor.

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

EventLogEntry::getAssocId ( )

Get associated ID.

Returns
int

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

References DataObject\getData().

EventLogEntry::getAssocType ( )

Get associated type.

Returns
int

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

References DataObject\getData().

EventLogEntry::getDateLogged ( )

Get date entry was logged.

Returns
datestamp

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

References DataObject\getData().

EventLogEntry::getEventType ( )

Get event type.

Returns
int

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

References DataObject\getData().

EventLogEntry::getIPAddress ( )

Get IP address of user that initiated the event.

Returns
string

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

References DataObject\getData().

EventLogEntry::getIsTranslated ( )

Get flag indicating whether or not message is translated.

Returns
boolean

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

References DataObject\getData().

Referenced by getTranslatedMessage().

EventLogEntry::getMessage ( )

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

Returns
string

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

References DataObject\getData().

Referenced by getTranslatedMessage().

EventLogEntry::getParams ( )

Get custom log message parameters.

Returns
array

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

References DataObject\getData().

Referenced by getTranslatedMessage().

EventLogEntry::getTranslatedMessage (   $locale = null)

Get translated message, translating it if necessary.

Parameters
$localestring optional

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

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

EventLogEntry::getUserEmail ( )

Return the email address of the user.

Returns
string

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

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

EventLogEntry::getUserFullName ( )

Return the full name of the user.

Returns
string

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

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

EventLogEntry::getUserId ( )

Get user ID of user that initiated the event.

Returns
int

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

References DataObject\getData().

Referenced by getUserEmail(), and getUserFullName().

EventLogEntry::setAssocId (   $assocId)

Set associated ID.

Parameters
$assocIdint

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

References DataObject\setData().

EventLogEntry::setAssocType (   $assocType)

Set associated type.

Parameters
$assocTypeint

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

References DataObject\setData().

EventLogEntry::setDateLogged (   $dateLogged)

Set date entry was logged.

Parameters
$dateLoggeddatestamp

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

References DataObject\setData().

EventLogEntry::setEventType (   $eventType)

Set event type.

Parameters
$eventTypeint

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

References DataObject\setData().

EventLogEntry::setIPAddress (   $ipAddress)

Set IP address of user that initiated the event.

Parameters
$ipAddressstring

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

References DataObject\setData().

EventLogEntry::setIsTranslated (   $isTranslated)

Set flag indicating whether or not message is translated.

Parameters
$isTranslatedint

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

References DataObject\setData().

EventLogEntry::setMessage (   $message)

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

Parameters
$messagestring

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

References DataObject\setData().

EventLogEntry::setParams (   $params)

Set custom log message parameters.

Parameters
$paramsarray

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

References DataObject\setData().

EventLogEntry::setUserId (   $userId)

Set user ID of user that initiated the event.

Parameters
$userIdint

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

References DataObject\setData().


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