interface log_interface

The interface for the log-system.

Methods

bool
is_enabled(string $type = '')

This function returns the state of the log system.

null
disable(mixed $type = '')

Disable log

null
enable(mixed $type = '')

Enable log

int|bool
add(string $mode, int $user_id, string $log_ip, string $log_operation, int|bool $log_time = false, array $additional_data = array())

Adds a log entry to the database

delete(string $mode, array $conditions = array())

Delete entries in the logs

array
get_logs(string $mode, bool $count_logs = true, int $limit = 0, int $offset = 0, mixed $forum_id = 0, int $topic_id = 0, int $user_id = 0, int $log_time = 0, string $sort_by = 'l.log_time DESC', string $keywords = '')

Grab the logs from the database

int
get_log_count()

Get total log count

int
get_valid_offset()

Get offset of the last valid page

Details

at line 29
bool is_enabled(string $type = '')

This function returns the state of the log system.

Parameters

string $type

The log type we want to check. Empty to get global log status.

Return Value

bool

True if log for the type is enabled

at line 43
null disable(mixed $type = '')

Disable log

This function allows disabling the log system or parts of it, for this page call. When add() is called and the type is disabled, the log will not be added to the database.

Parameters

mixed $type

The log type we want to disable. Empty to disable all logs. Can also be an array of types.

Return Value

null

at line 55
null enable(mixed $type = '')

Enable log

This function allows re-enabling the log system.

Parameters

mixed $type

The log type we want to enable. Empty to enable all logs. Can also be an array of types.

Return Value

null

at line 69
int|bool add(string $mode, int $user_id, string $log_ip, string $log_operation, int|bool $log_time = false, array $additional_data = array())

Adds a log entry to the database

Parameters

string $mode

The mode defines which log_type is used and from which log the entry is retrieved

int $user_id

User ID of the user

string $log_ip

IP address of the user

string $log_operation

Name of the operation

int|bool $log_time

Timestamp when the log entry was added. If false, time() will be used

array $additional_data

More arguments can be added, depending on the log_type

Return Value

int|bool

Returns the log_id, if the entry was added to the database, false otherwise.

at line 81
delete(string $mode, array $conditions = array())

Delete entries in the logs

Parameters

string $mode

The mode defines which log_type is used and from which log the entries are deleted

array $conditions

An array of conditions, 3 different forms are accepted 1) => transformed into 'AND = ' (value should be an integer) 2) => array(, ) transformed into 'AND ' (values can't be an array) 3) => array('IN' => array()) transformed into 'AND IN ' A special field, keywords, can also be defined. In this case only the log entries that have the keywords in log_operation or log_data will be deleted.

at line 99
array get_logs(string $mode, bool $count_logs = true, int $limit = 0, int $offset = 0, mixed $forum_id = 0, int $topic_id = 0, int $user_id = 0, int $log_time = 0, string $sort_by = 'l.log_time DESC', string $keywords = '')

Grab the logs from the database

Parameters

string $mode

The mode defines which log_type is used and ifrom which log the entry is retrieved

bool $count_logs

Shall we count all matching log entries?

int $limit

Limit the number of entries that are returned

int $offset

Offset when fetching the log entries, f.e. when paginating

mixed $forum_id

Restrict the log entries to the given forum_id (can also be an array of forum_ids)

int $topic_id

Restrict the log entries to the given topic_id

int $user_id

Restrict the log entries to the given user_id

int $log_time

Only get log entries newer than the given timestamp

string $sort_by

SQL order option, e.g. 'l.log_time DESC'

string $keywords

Will only return log entries that have the keywords in log_operation or log_data

Return Value

array

The result array with the logs

at line 106
int get_log_count()

Get total log count

Return Value

int

Returns the number of matching logs from the last call to get_logs()

at line 113
int get_valid_offset()

Get offset of the last valid page

Return Value

int

Returns the offset of the last valid page from the last call to get_logs()