summaryrefslogtreecommitdiffstats
path: root/user_guide/general/common_functions.html
diff options
context:
space:
mode:
authorDerek Jones <derek.jones@ellislab.com>2009-07-11 19:05:58 +0200
committerDerek Jones <derek.jones@ellislab.com>2009-07-11 19:05:58 +0200
commit817163a1bcff02285f763bcf72ff02e86f218cf8 (patch)
treeca429f1c3b2acc8d72e97e6269ca3cdb5598f95b /user_guide/general/common_functions.html
parent55acc8b4d980c43e4bde04f0e0b99a594dea28ff (diff)
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.
Diffstat (limited to 'user_guide/general/common_functions.html')
-rw-r--r--user_guide/general/common_functions.html17
1 files changed, 17 insertions, 0 deletions
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
<h1>Common Functions</h1>
<p>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.</p>
+
<h2>is_really_writable('<var>path/to/file</var>')</h2>
+
<p>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.</p>
+
<code>if (is_really_writable('file.txt'))<br />
{<br />
&nbsp;&nbsp;&nbsp;&nbsp;echo &quot;I could write to this if I wanted to&quot;;<br />
@@ -68,11 +71,25 @@ else<br />
{<br />
&nbsp;&nbsp;&nbsp;&nbsp;echo &quot;File is not writable&quot;;<br />
}</code>
+
<h2>config_item('<var>item_key</var>')</h2>
<p>The <a href="../libraries/config.html">Config library</a> 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.</p>
+
<h2>show_error('<var>message</var>'), show_404('<var>page</var>'), log_message('<var>level</var>', '<samp>message</samp>')</h2>
<p>These are each outlined on the <a href="errors.html">Error Handling</a> page.</p>
+
+<h2>set_status_header(<var>code</var>, '<var>text</var>');</h2>
+
+<p>Permits you to manually set a server status header. Example:</p>
+
+<code>set_status_header(401);<br />
+// Sets the header as: Unauthorized</code>
+
+<p><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">See here</a> for a full list of headers.</p>
+
</div>
+
+
<!-- END CONTENT -->