diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2013-02-25 15:57:21 +0100 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2013-02-25 15:57:21 +0100 |
| commit | c1b4cdb1883bb6771a303624ece131eb5c7f071d (patch) | |
| tree | 04401dd7300484aee91459bd3dcf143a53bc8fda /phpBB/includes/functions.php | |
| parent | 447e845274daedd12bc40f813680fb5df64d114a (diff) | |
| download | forums-c1b4cdb1883bb6771a303624ece131eb5c7f071d.tar forums-c1b4cdb1883bb6771a303624ece131eb5c7f071d.tar.gz forums-c1b4cdb1883bb6771a303624ece131eb5c7f071d.tar.bz2 forums-c1b4cdb1883bb6771a303624ece131eb5c7f071d.tar.xz forums-c1b4cdb1883bb6771a303624ece131eb5c7f071d.zip | |
[ticket/10714] Update add_log docs block with @param and @deprecated
PHPBB3-10714
Diffstat (limited to 'phpBB/includes/functions.php')
| -rw-r--r-- | phpBB/includes/functions.php | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php index 6f9d8ad8d6..d9116084fd 100644 --- a/phpBB/includes/functions.php +++ b/phpBB/includes/functions.php @@ -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() { |