mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-07-25 02:51:35 +02:00
Code Issues Releases Wiki Activity

[ticket/10714] Fix several comments and variable names

Browse Source 
PHPBB3-10714
This commit is contained in:
Joas Schilling
2013-01-16 14:18:09 +01:00
parent 512697341a
commit 37014abd02
3 changed files with 53 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
phpBB/includes/log/interface.php
View File

@@ -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.