diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2012-03-24 15:06:32 +0100 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2012-08-21 11:59:36 +0200 |
| commit | 9248b9b25fdc3c05cc9fb1e99f607817f8ec7bcb (patch) | |
| tree | 2dd59b80ecc477c997ca0275c8fb2fa58c875445 /phpBB/includes/functions_admin.php | |
| parent | f5063a6eda49d2a35b2aed486f86cde76e0f04a8 (diff) | |
| download | forums-9248b9b25fdc3c05cc9fb1e99f607817f8ec7bcb.tar forums-9248b9b25fdc3c05cc9fb1e99f607817f8ec7bcb.tar.gz forums-9248b9b25fdc3c05cc9fb1e99f607817f8ec7bcb.tar.bz2 forums-9248b9b25fdc3c05cc9fb1e99f607817f8ec7bcb.tar.xz forums-9248b9b25fdc3c05cc9fb1e99f607817f8ec7bcb.zip | |
[ticket/10714] Add doc block for view_log function
PHPBB3-10714
Diffstat (limited to 'phpBB/includes/functions_admin.php')
| -rw-r--r-- | phpBB/includes/functions_admin.php | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/phpBB/includes/functions_admin.php b/phpBB/includes/functions_admin.php index fd1f5568ab..49c34f7fff 100644 --- a/phpBB/includes/functions_admin.php +++ b/phpBB/includes/functions_admin.php @@ -2470,7 +2470,21 @@ function cache_moderators() /** * View log -* If $log_count is set to false, we will skip counting all entries in the database. +* +* @param string $mode The mode defines which log_type is used and in which log the entry is displayed. +* @param array &$log The result array with the logs +* @param mixed &$log_count If $log_count is set to false, we will skip counting all entries in the database. +* Otherwise an integer with the number of total matching entries is returned. +* @param int $limit Limit the number of entries that are returned +* @param int $offset Offset when fetching the log entries, f.e. on paginations +* @param mixed $forum_id Restrict the log entries to the given forum_id (can also be an array of forum_ids) +* @param int $topic_id Restrict the log entries to the given topic_id +* @param int $user_id Restrict the log entries to the given user_id +* @param int $log_time Only get log entries newer than the given timestamp +* @param string $sort_by SQL order option, e.g. 'l.log_time DESC' +* @param string $keywords Will only return log entries that have the keywords in log_operation or log_data +* +* @return int Returns the offset of the last valid page, if the specified offset was invalid (too high) */ function view_log($mode, &$log, &$log_count, $limit = 0, $offset = 0, $forum_id = 0, $topic_id = 0, $user_id = 0, $limit_days = 0, $sort_by = 'l.log_time DESC', $keywords = '') { |