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] Update add_log docs block with @param and @deprecated

Browse source 
PHPBB3-10714
This commit is contained in:
Joas Schilling 2013-02-25 15:57:21 +01:00
parent 447e845274
commit c1b4cdb188
1 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
phpBB/includes/functions.php
View file

@ -3508,7 +3508,18 @@ function parse_cfg_file($filename, $lines = false)
}
/**
* Add log event
* Add log entry
*
* @param string $mode The mode defines which log_type is used and from which log the entry is retrieved
* @param int $forum_id Mode 'mod' ONLY: forum id of the related item, NOT INCLUDED otherwise
* @param int $topic_id Mode 'mod' ONLY: topic id of the related item, NOT INCLUDED otherwise
* @param int $reportee_id Mode 'user' ONLY: user id of the reportee, NOT INCLUDED otherwise
* @param string $log_operation Name of the operation
* @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.
*
* @deprecated Use $phpbb_log->add() instead
*/
function add_log()
{