EventLog Class Reference

Event logging class. More...

List of all members.

Public Member Functions
	__construct ()
	Constructor.
	write ($eventid, $notes="")
	Write a log message in table eventlog.
	clear ($untildate=0)
	Clear event log.
Private Attributes
	$areaid
	area id
	$enabled
	event logging enabled
	$uid
	user id

---

Detailed Description

Event logging class.

Log events in table eventlog.

Definition at line 36 of file eventlog.php.

---

Constructor & Destructor Documentation

EventLog::__construct

(

)

Constructor.

Do garbage collection for table eventlog even if event logging disabled.

Definition at line 46 of file eventlog.php.

References $cfg, and $session.

---

Member Function Documentation

EventLog::write	(	$	eventid,
		$	notes = ""
	)

Write a log message in table eventlog.

Parameters:

	eventid	event id (not including trailing string "LANG_EVENTLOG_" - see include/lang/logmsg_*.php for reference)
	notes	(optional) additional description text

Definition at line 70 of file eventlog.php.

EventLog::clear

(

$

untildate = 0

)

Clear event log.

Remove all entries from table eventlog. Optionally, remove all entries until the specified date/time.

Parameters:

untildate

max date/time for records to be deleted (UNIX time)

Definition at line 94 of file eventlog.php.

---

Member Data Documentation

EventLog::$areaid [private]

area id

Definition at line 37 of file eventlog.php.

EventLog::$enabled [private]

event logging enabled

Definition at line 38 of file eventlog.php.

EventLog::$uid [private]

user id

Definition at line 39 of file eventlog.php.

---

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

• eventlog.php

---