diff options
| author | vlakoff <vlakoff@gmail.com> | 2013-05-07 07:49:23 +0200 |
|---|---|---|
| committer | vlakoff <vlakoff@gmail.com> | 2013-05-07 07:51:59 +0200 |
| commit | d0c30ab416b0f6bc7fdc9ea70f6fd5e07ac13884 (patch) | |
| tree | 2e7a675a4123e031a0524547c7d833a8437256d0 | |
| parent | 206d951e3da15bf9c69b3b8860c8bd274fb82b6f (diff) | |
Logging functions: level parameter is not optional
This parameter cannot be optional, as the following parameter is mandatory.
Also completed the corresponding documentation.
| -rw-r--r-- | system/core/Common.php | 8 | ||||
| -rw-r--r-- | system/core/Log.php | 4 | ||||
| -rw-r--r-- | tests/mocks/core/common.php | 2 | ||||
| -rw-r--r-- | user_guide_src/source/general/common_functions.rst | 6 | ||||
| -rw-r--r-- | user_guide_src/source/general/errors.rst | 6 |
5 files changed, 13 insertions, 13 deletions
diff --git a/system/core/Common.php b/system/core/Common.php index b4f0c388e..cad340f33 100644 --- a/system/core/Common.php +++ b/system/core/Common.php @@ -424,12 +424,12 @@ if ( ! function_exists('log_message')) * We use this as a simple mechanism to access the logging * class and send messages to be logged. * - * @param string - * @param string - * @param bool + * @param string the error level: 'error', 'debug' or 'info' + * @param string the error message + * @param bool whether the error is a native PHP error * @return void */ - function log_message($level = 'error', $message, $php_error = FALSE) + function log_message($level, $message, $php_error = FALSE) { static $_log, $_log_threshold; diff --git a/system/core/Log.php b/system/core/Log.php index a84d3dc22..e4d72b544 100644 --- a/system/core/Log.php +++ b/system/core/Log.php @@ -138,12 +138,12 @@ class CI_Log { * * Generally this function will be called using the global log_message() function * - * @param string the error level + * @param string the error level: 'error', 'debug' or 'info' * @param string the error message * @param bool whether the error is a native PHP error * @return bool */ - public function write_log($level = 'error', $msg, $php_error = FALSE) + public function write_log($level, $msg, $php_error = FALSE) { if ($this->_enabled === FALSE) { diff --git a/tests/mocks/core/common.php b/tests/mocks/core/common.php index 24d645ae3..0ccfe1ea4 100644 --- a/tests/mocks/core/common.php +++ b/tests/mocks/core/common.php @@ -178,7 +178,7 @@ if ( ! function_exists('is_loaded')) if ( ! function_exists('log_message')) { - function log_message($level = 'error', $message, $php_error = FALSE) + function log_message($level, $message, $php_error = FALSE) { return TRUE; } diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst index 79bd9b459..a133fdc6d 100644 --- a/user_guide_src/source/general/common_functions.rst +++ b/user_guide_src/source/general/common_functions.rst @@ -100,11 +100,11 @@ please see the :doc:`Error Handling <errors>` documentation. log_message() ============= -.. php:function:: log_message($level = 'error', $message, $php_error = FALSE) +.. php:function:: log_message($level, $message, $php_error = FALSE) - :param string $level: Log level + :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log - :param bool $php_error: Whether we're loggin a native PHP error message + :param bool $php_error: Whether we're logging a native PHP error message :returns: void This function is an alias for ``CI_Log::write_log()``. For more info, diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst index a247c1b9f..f12d992f8 100644 --- a/user_guide_src/source/general/errors.rst +++ b/user_guide_src/source/general/errors.rst @@ -77,11 +77,11 @@ optional second parameter to FALSE will skip logging. log_message() ============= -.. php:function:: log_message($level = 'error', $message, $php_error = FALSE) +.. php:function:: log_message($level, $message, $php_error = FALSE) - :param string $level: Log level + :param string $level: Log level: 'error', 'debug' or 'info' :param string $message: Message to log - :param bool $php_error: Whether we're loggin a native PHP error message + :param bool $php_error: Whether we're logging a native PHP error message :returns: void This function lets you write messages to your log files. You must supply |