From 817163a1bcff02285f763bcf72ff02e86f218cf8 Mon Sep 17 00:00:00 2001 From: Derek Jones Date: Sat, 11 Jul 2009 17:05:58 +0000 Subject: Modified show_error() to allow sending of HTTP server response codes. Added set_status_header() to the Common functions to allow use when the Output class is unavailable. Fixed a bug where the 400 status header sent with the 'disallowed URI characters' was not compatible with CGI environments. --- user_guide/general/common_functions.html | 17 +++++++++++++++++ user_guide/general/errors.html | 3 ++- 2 files changed, 19 insertions(+), 1 deletion(-) (limited to 'user_guide/general') diff --git a/user_guide/general/common_functions.html b/user_guide/general/common_functions.html index df5dfea6e..980a5a969 100644 --- a/user_guide/general/common_functions.html +++ b/user_guide/general/common_functions.html @@ -58,8 +58,11 @@ Auto-loading Resources

Common Functions

CodeIgniter uses a few functions for its operation that are globally defined, and are available to you at any point. These do not require loading any libraries or helpers.

+

is_really_writable('path/to/file')

+

is_writable() returns TRUE on Windows servers when you really can't write to the file as the OS reports to PHP as FALSE only if the read-only attribute is marked. This function determines if a file is actually writable by attempting to write to it first. Generally only recommended on platforms where this information may be unreliable.

+ if (is_really_writable('file.txt'))
{
    echo "I could write to this if I wanted to";
@@ -68,11 +71,25 @@ else
{
    echo "File is not writable";
} +

config_item('item_key')

The Config library is the preferred way of accessing configuration information, however config_item() can be used to retrieve single keys. See Config library documentation for more information.

+

show_error('message'), show_404('page'), log_message('level', 'message')

These are each outlined on the Error Handling page.

+ +

set_status_header(code, 'text');

+ +

Permits you to manually set a server status header. Example:

+ +set_status_header(401);
+// Sets the header as: Unauthorized + +

See here for a full list of headers.

+ + + diff --git a/user_guide/general/errors.html b/user_guide/general/errors.html index c1bb69119..af1184593 100644 --- a/user_guide/general/errors.html +++ b/user_guide/general/errors.html @@ -71,9 +71,10 @@ about class/function scoping.

The following functions let you generate errors:

-

show_error('message')

+

show_error('message' [, int $status_code= 500 ] )

This function will display the error message supplied to it using the following error template:

application/errors/error_general.php

+

The optional parameter $status_code determines what HTTP status code should be sent with the error.

show_404('page')

This function will display the 404 error message supplied to it using the following error template:

-- cgit v1.2.3-24-g4f1b