summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMaster Yoda <jim_parry@bcit.ca>2015-01-30 19:19:55 +0100
committerMaster Yoda <jim_parry@bcit.ca>2015-01-30 19:19:55 +0100
commit5da18e977253e4519ee32dcaef1d37657fec9fab (patch)
tree8c04b82fff20102a3b1a0ebdd6835d2592f0622b
parent8b669f5bffafb26d83f5d78f45e267693d06606e (diff)
Incorporated suggested changes.
Signed-off-by:Master Yoda <jim_parry@bcit.ca>
-rw-r--r--user_guide_src/source/general/errors.rst16
1 files changed, 7 insertions, 9 deletions
diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst
index efa0f19ff..112dd83e1 100644
--- a/user_guide_src/source/general/errors.rst
+++ b/user_guide_src/source/general/errors.rst
@@ -37,9 +37,10 @@ The following functions let you generate errors:
:rtype: void
This function will display the error message supplied to it using the
-following error template::
+error template appropriate to your execution::
- application/views/errors/html/error_general.php
+ application/views/errors/html/error_general.php or
+ application/views/errors/cli/error_general.php
The optional parameter ``$status_code`` determines what HTTP status
code should be sent with the error. If ``$status_code`` is less than 100,
@@ -56,9 +57,10 @@ status code will be set to ``EXIT_ERROR``. You can check in
:rtype: void
This function will display the 404 error message supplied to it using
-the following error template::
+the error template appropriate to your execution::
- application/views/errors/html/error_404.php
+ application/views/errors/html/error_404.php or
+ application/views/errors/cli/error_404.php
The function expects the string passed to it to be the file path to the
page that isn't found. The exit status code will be set to ``EXIT_UNKNOWN_FILE``.
@@ -107,8 +109,4 @@ There are three message types:
directory must be writable. In addition, you must set the "threshold"
for logging in *application/config/config.php*. You might, for example,
only want error messages to be logged, and not the other two types.
- If you set it to zero logging will be disabled.
-
-.. note:: If you run PHP from the command line, then the error templates mentioned
- above will come from the "application/views/errors/cli" folder, instead
- of the "application/views/errors/html" one. \ No newline at end of file
+ If you set it to zero logging will be disabled. \ No newline at end of file