diff options
| author | Joas Schilling <nickvergessen@gmx.de> | 2013-01-16 14:18:09 +0100 |
|---|---|---|
| committer | Joas Schilling <nickvergessen@gmx.de> | 2013-01-16 14:18:09 +0100 |
| commit | 37014abd022be4f7824a590b93a329f74aef442c (patch) | |
| tree | bc7e55e6a29660ae4e3b1e52e2372f03286b858b /phpBB/includes/log/interface.php | |
| parent | 512697341a9c570ee11697eb221ef18d2fadfe45 (diff) | |
| download | forums-37014abd022be4f7824a590b93a329f74aef442c.tar forums-37014abd022be4f7824a590b93a329f74aef442c.tar.gz forums-37014abd022be4f7824a590b93a329f74aef442c.tar.bz2 forums-37014abd022be4f7824a590b93a329f74aef442c.tar.xz forums-37014abd022be4f7824a590b93a329f74aef442c.zip | |
[ticket/10714] Fix several comments and variable names
PHPBB3-10714
Diffstat (limited to 'phpBB/includes/log/interface.php')
| -rw-r--r-- | phpBB/includes/log/interface.php | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/phpBB/includes/log/interface.php b/phpBB/includes/log/interface.php index b85dc3a474..254b65cb19 100644 --- a/phpBB/includes/log/interface.php +++ b/phpBB/includes/log/interface.php @@ -25,40 +25,42 @@ interface phpbb_log_interface /** * This function returns the state of the log system. * - * @param string $type The log type we want to check. Empty to get global log status. + * @param string $type The log type we want to check. Empty to get + * global log status. * * @return bool True if log for the type is enabled */ public function is_enabled($type = ''); /** - * This function allows disable the log system. When add_log is called, the log will not be added to the database. + * This function allows disabling the log system. When add_log is called + * and the type is disabled, the log will not be added to the database. * - * @param mixed $type The log type we want to disable. Empty to disable all logs. - * Can also be an array of types + * @param mixed $type The log type we want to disable. Empty to + * disable all logs. Can also be an array of types. * * @return null */ public function disable($type = ''); /** - * This function allows re-enable the log system. + * This function allows re-enabling the log system. * - * @param mixed $type The log type we want to enable. Empty to enable all logs. - * Can also be an array of types + * @param mixed $type The log type we want to enable. Empty to + * enable all logs. Can also be an array of types. * * @return null */ public function enable($type = ''); /** - * Adds a log to the database + * 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 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 was added. + * @param int $log_time Timestamp when the log entry was added. * @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. |