diff options
| -rw-r--r-- | system/core/Common.php | 8 | ||||
| -rw-r--r-- | system/core/Loader.php | 2 | ||||
| -rw-r--r-- | system/core/Log.php | 4 | ||||
| -rw-r--r-- | tests/mocks/core/common.php | 2 | ||||
| -rw-r--r-- | user_guide_src/source/_themes/eldocs/layout.html | 2 | ||||
| -rw-r--r-- | user_guide_src/source/general/common_functions.rst | 6 | ||||
| -rw-r--r-- | user_guide_src/source/general/controllers.rst | 4 | ||||
| -rw-r--r-- | user_guide_src/source/general/errors.rst | 6 |
8 files changed, 18 insertions, 16 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/Loader.php b/system/core/Loader.php index 6f90aec8b..49bd641b1 100644 --- a/system/core/Loader.php +++ b/system/core/Loader.php @@ -713,7 +713,7 @@ class CI_Loader { * * Return a list of all package paths. * - * @param bool $include_base Whether to include BASEPATH (default: TRUE) + * @param bool $include_base Whether to include BASEPATH (default: FALSE) * @return array */ public function get_package_paths($include_base = FALSE) 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/_themes/eldocs/layout.html b/user_guide_src/source/_themes/eldocs/layout.html index 51d61b849..7f2fe1a34 100644 --- a/user_guide_src/source/_themes/eldocs/layout.html +++ b/user_guide_src/source/_themes/eldocs/layout.html @@ -81,7 +81,7 @@ {%- block content %} <div id="table-contents"> <div class="toctree-wrapper compound"> - {{ toctree(collapse=true) }} + {{ toctree }} </div> </div> 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/controllers.rst b/user_guide_src/source/general/controllers.rst index 8cfb012a0..04f23276d 100644 --- a/user_guide_src/source/general/controllers.rst +++ b/user_guide_src/source/general/controllers.rst @@ -214,7 +214,9 @@ Here is an example:: echo $output; } -.. note:: Please note that your ``_output()`` method will receive the +.. note:: + + Please note that your ``_output()`` method will receive the data in its finalized state. Benchmark and memory usage data will be rendered, cache files written (if you have caching enabled), and headers will be sent (if you use that 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 |