ConferenceEventLogEntry Class Reference
[Conference_log]

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

List of all members.

Public Member Functions

 ConferenceEventLogEntry ()
 getAssocId ()
 getAssocType ()
 getAssocTypeLongString ()
 getAssocTypeString ()
 getConferenceId ()
 getConferenceTitle ()
 getDateLogged ()
 getEntryParams ()
 getEntryParamsSerialized ()
 getEventTitle ()
 getEventType ()
 getIPAddress ()
 getIsTranslated ()
 getLogId ()
 getLogLevel ()
 getLogLevelString ()
 getMessage ()
 getSchedConfId ()
 getSchedConfTitle ()
 getUserEmail ()
 getUserFullName ()
 getUserId ()
 setAssocId ($assocId)
 setAssocType ($assocType)
 setConferenceId ($conferenceId)
 setConferenceTitle ($conferenceTitle)
 setDateLogged ($dateLogged)
 setEntryParams ($entryParams=array())
 setEventType ($eventType)
 setIPAddress ($ipAddress)
 setIsTranslated ($isTranslated)
 setLogId ($logId)
 setLogLevel ($logLevel)
 setLogMessage ($key, $params=array())
 setMessage ($message)
 setSchedConfId ($schedConfId)
 setSchedConfTitle ($schedConfTitle)
 setUserId ($userId)


Detailed Description

Describes an entry in the conference history log.

See also:
ConferenceEventLogDAO

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


Member Function Documentation

ConferenceEventLogEntry.ConferenceEventLogEntry (  ) 

Constructor.

Definition at line 32 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.getAssocId (  ) 

Get associated ID.

Returns:
int

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

ConferenceEventLogEntry.getAssocType (  ) 

Get associated type.

Returns:
int

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

ConferenceEventLogEntry.getAssocTypeLongString (  ) 

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

Returns:
string

Definition at line 370 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.getAssocTypeString (  ) 

Return string representation of the associated type.

Returns:
string

Definition at line 359 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.getConferenceId (  ) 

Get ID of conference.

Returns:
int

Definition at line 70 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.getConferenceTitle (  ) 

Get conference title.

Returns:
string

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

ConferenceEventLogEntry.getDateLogged (  ) 

Get date entry was logged.

Returns:
datestamp

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

ConferenceEventLogEntry.getEntryParams (  ) 

Get parameters for log message.

Returns:
array

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

ConferenceEventLogEntry.getEntryParamsSerialized (  ) 

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

Returns:
array

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

ConferenceEventLogEntry.getEventTitle (  ) 

Return locale message key describing event type.

Returns:
string

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

ConferenceEventLogEntry.getEventType (  ) 

Get event type.

Returns:
int

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

ConferenceEventLogEntry.getIPAddress (  ) 

Get IP address of user that initiated the event.

Returns:
string

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

ConferenceEventLogEntry.getIsTranslated (  ) 

Get is_translated value (0/1).

Returns:
int

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

ConferenceEventLogEntry.getLogId (  ) 

Get ID of log entry.

Returns:
int

Definition at line 54 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.getLogLevel (  ) 

Get the log level.

Returns:
int

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

ConferenceEventLogEntry.getLogLevelString (  ) 

Return locale message key for the log level.

Returns:
string

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

ConferenceEventLogEntry.getMessage (  ) 

Get log message key.

Returns:
string

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

ConferenceEventLogEntry.getSchedConfId (  ) 

Get ID of sched conf.

Returns:
int

Definition at line 86 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.getSchedConfTitle (  ) 

Get sched conf title.

Returns:
string

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

ConferenceEventLogEntry.getUserEmail (  ) 

Return the email address of the user.

Returns:
string

Definition at line 350 of file ConferenceEventLogEntry.inc.php.

References getUserId().

ConferenceEventLogEntry.getUserFullName (  ) 

Return the full name of the user.

Returns:
string

Definition at line 341 of file ConferenceEventLogEntry.inc.php.

References getUserId().

ConferenceEventLogEntry.getUserId (  ) 

Get user ID of user that initiated the event.

Returns:
int

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

Referenced by getUserEmail(), and getUserFullName().

ConferenceEventLogEntry.setAssocId ( assocId  ) 

Set associated ID.

Parameters:
$assocId int

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

ConferenceEventLogEntry.setAssocType ( assocType  ) 

Set associated type.

Parameters:
$assocType int

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

ConferenceEventLogEntry.setConferenceId ( conferenceId  ) 

Set ID of conference.

Parameters:
$conferenceId int

Definition at line 78 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.setConferenceTitle ( conferenceTitle  ) 

Set conference title.

Parameters:
$conferenceTitle string

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

ConferenceEventLogEntry.setDateLogged ( dateLogged  ) 

Set date entry was logged.

Parameters:
$dateLogged datestamp

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

ConferenceEventLogEntry.setEntryParams ( entryParams = array()  ) 

Set parameters for log message.

Parameters:
$entryParams array

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

Referenced by setLogMessage().

ConferenceEventLogEntry.setEventType ( eventType  ) 

Set event type.

Parameters:
$eventType int

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

ConferenceEventLogEntry.setIPAddress ( ipAddress  ) 

Set IP address of user that initiated the event.

Parameters:
$ipAddress string

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

ConferenceEventLogEntry.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 ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.setLogId ( logId  ) 

Set ID of log entry.

Parameters:
$logId int

Definition at line 62 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.setLogLevel ( logLevel  ) 

Set the log level.

Parameters:
$logLevel char

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

ConferenceEventLogEntry.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 41 of file ConferenceEventLogEntry.inc.php.

References setEntryParams(), and setMessage().

ConferenceEventLogEntry.setMessage ( message  ) 

Set log message key.

Parameters:
$message string

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

Referenced by setLogMessage().

ConferenceEventLogEntry.setSchedConfId ( schedConfId  ) 

Set ID of sched conf.

Parameters:
$schedConfId int

Definition at line 94 of file ConferenceEventLogEntry.inc.php.

ConferenceEventLogEntry.setSchedConfTitle ( schedConfTitle  ) 

Set sched conf title.

Parameters:
$schedConfTitle string

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

ConferenceEventLogEntry.setUserId ( userId  ) 

Set user ID of user that initiated the event.

Parameters:
$userId int

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


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7