From 8b669f5bffafb26d83f5d78f45e267693d06606e Mon Sep 17 00:00:00 2001 From: Master Yoda Date: Thu, 29 Jan 2015 11:36:42 -0800 Subject: Clarified the template folder for errors. Verified that the user guide build works. Signed-off-by:Master Yoda --- user_guide_src/source/general/errors.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'user_guide_src/source/general') diff --git a/user_guide_src/source/general/errors.rst b/user_guide_src/source/general/errors.rst index 721c78ca7..efa0f19ff 100644 --- a/user_guide_src/source/general/errors.rst +++ b/user_guide_src/source/general/errors.rst @@ -39,7 +39,7 @@ The following functions let you generate errors: This function will display the error message supplied to it using the following error template:: - application/views/errors/error_general.php + application/views/errors/html/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, @@ -58,7 +58,7 @@ status code will be set to ``EXIT_ERROR``. You can check in This function will display the 404 error message supplied to it using the following error template:: - application/views/errors/error_404.php + application/views/errors/html/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,4 +107,8 @@ 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. \ No newline at end of file + 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 -- cgit v1.2.3-24-g4f1b From 5da18e977253e4519ee32dcaef1d37657fec9fab Mon Sep 17 00:00:00 2001 From: Master Yoda Date: Fri, 30 Jan 2015 10:19:55 -0800 Subject: Incorporated suggested changes. Signed-off-by:Master Yoda --- user_guide_src/source/general/errors.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) (limited to 'user_guide_src/source/general') 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 -- cgit v1.2.3-24-g4f1b