makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-27 21:58:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/10714] Fix several doc blocks and comments

Browse source 
PHPBB3-10714
This commit is contained in:
Joas Schilling 2013-01-22 15:45:20 +01:00
parent 2c4e7eabe2
commit c0ab3f3ddd
3 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
phpBB/includes/functions_admin.php
View file

@ -2489,12 +2489,12 @@ function cache_moderators()
/**
* View log
*
* @param string $mode The mode defines which log_type is used and in which log the entry is displayed.
* @param string $mode The mode defines which log_type is used and from which log the entry is retrieved
* @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 int $offset Offset when fetching the log entries, f.e. when paginating
* @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

10
phpBB/includes/log/interface.php
View file

@ -56,24 +56,24 @@ interface phpbb_log_interface
/**
* Adds a log entry to the database
*
* @param string $mode The mode defines which log_type is used and in which log the entry is displayed.
* @param string $mode The mode defines which log_type is used and from which log the entry is retrieved
* @param int $user_id User ID of the user
* @param string $log_ip IP address of the user
* @param string $log_operation Name of the operation
* @param int $log_time Timestamp when the log entry was added.
* @param int $log_time Timestamp when the log entry was added, if empty time() will be used
* @param array $additional_data More arguments can be added, depending on the log_type
*
* @return int|bool Returns the log_id, if the entry was added to the database, false otherwise.
*/
public function add($mode, $user_id, $log_ip, $log_operation, $log_time, $additional_data);
public function add($mode, $user_id, $log_ip, $log_operation, $log_time = false, $additional_data = array());
/**
* Grab the logs from the database
*
* @param string $mode The mode defines which log_type is used and in which log the entry is displayed.
* @param string $mode The mode defines which log_type is used and ifrom which log the entry is retrieved
* @param bool $count_logs Shall we count all matching log entries?
* @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 int $offset Offset when fetching the log entries, f.e. when paginating
* @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

5
phpBB/includes/log/log.php
View file

@ -31,16 +31,19 @@ class phpbb_log implements phpbb_log_interface
/**
* Keeps the total log count of the last call to get_logs()
* @var int
*/
protected $entry_count;
/**
* Keeps the offset of the last valid page of the last call to get_logs()
* @var int
*/
protected $last_page_offset;
/**
* The table we use to store our logs.
* @var string
*/
protected $log_table;
@ -112,7 +115,7 @@ class phpbb_log implements phpbb_log_interface
/*
* IN_ADMIN is set after the session was created,
* so we need to take ADMIN_START into account aswell, otherwise
* so we need to take ADMIN_START into account as well, otherwise
* it will not work for the phpbb_log object we create in common.php
*/
$this->set_is_admin((defined('ADMIN_START') && ADMIN_START) || (defined('IN_ADMIN') && IN_ADMIN));