Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 917c3455cc70d5117daa7359f345a820154ada3e / . / user_guide / general / common_functions.html
blob: f290521a99e43b134d1f287943ff7c82e641717a [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<title>Common Functions : CodeIgniter User Guide</title>
7
8<style type='text/css' media='all'>@import url('../userguide.css');</style>
9<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
11<script type="text/javascript" src="../nav/nav.js"></script>
12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
13<script type="text/javascript" src="../nav/moo.fx.js"></script>
14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='ExpressionEngine Dev Team' />
20<meta name='description' content='CodeIgniter User Guide' />
21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle_darker.jpg" width="154" height="43" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Phil Sturgeon9c63d0b2011-10-27 01:55:44 +0100[diff] [blame]31<td><h1>CodeIgniter User Guide Version 2.1.0</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45Auto-loading Resources
46</td>
47<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58<h1>Common Functions</h1>
59
60<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>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]61
Derek Jones086ee5a2009-07-28 14:42:12 +0000[diff] [blame]62<h2>is_php('<var>version_number</var>')</h2>
63
64<p>is_php() determines of the PHP version being used is greater than the supplied <var>version_number</var>.</p>
65
66<code>if (is_php('5.3.0'))<br />
67{<br />
68&nbsp;&nbsp;&nbsp;&nbsp;$str = quoted_printable_encode($str);<br />
69}</code>
70
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]71<p>Returns boolean <kbd>TRUE</kbd> if the installed version of PHP is equal to or greater than the supplied version number. Returns <kbd>FALSE</kbd> if the installed version of PHP is lower than the supplied version number.</p>
Derek Jones086ee5a2009-07-28 14:42:12 +0000[diff] [blame]72
73
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]74<h2>is_really_writable('<var>path/to/file</var>')</h2>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]75
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]76<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>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]77
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]78<code>if (is_really_writable('file.txt'))<br />
79{<br />
80&nbsp;&nbsp;&nbsp;&nbsp;echo &quot;I could write to this if I wanted to&quot;;<br />
81}<br />
82else<br />
83{<br />
84&nbsp;&nbsp;&nbsp;&nbsp;echo &quot;File is not writable&quot;;<br />
85}</code>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]86
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]87<h2>config_item('<var>item_key</var>')</h2>
88<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>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]89
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]90<h2>show_error('<var>message</var>'), show_404('<var>page</var>'), log_message('<var>level</var>', '<samp>message</samp>')</h2>
91<p>These are each outlined on the <a href="errors.html">Error Handling</a> page.</p>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]92
93<h2>set_status_header(<var>code</var>, '<var>text</var>');</h2>
94
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]95<p>Permits you to manually set a server status header. Example:</p>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]96
97<code>set_status_header(401);<br />
Derek Jones4b9c6292011-07-01 17:40:48 -0500[diff] [blame]98// Sets the header as: Unauthorized</code>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]99
100<p><a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">See here</a> for a full list of headers.</p>
101
Greg Aker757dda62010-04-14 19:06:19 -0500[diff] [blame]102
103<h2>remove_invisible_characters(<var>$str</var>)</h2>
104<p>This function prevents inserting null characters between ascii characters, like Java\0script.</p>
105
106
kenjis55027802011-08-25 10:51:44 +0900[diff] [blame]107<h2>html_escape(<var>$mixed</var>)</h2>
108<p>This function provides short cut for htmlspecialchars() function. It accepts string and array. To prevent Cross Site Scripting (XSS), it is very useful.</p>
Greg Aker757dda62010-04-14 19:06:19 -0500[diff] [blame]109
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]110</div>
Derek Jones817163a2009-07-11 17:05:58 +0000[diff] [blame]111
112
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]113<!-- END CONTENT -->
114
115
116<div id="footer">
117<p>
118Previous Topic:&nbsp;&nbsp;<a href="autoloader.html">Auto-loading Resources</a><a href="hooks.html"></a>
119&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
120<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
121<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
Derek Jonescf579552010-03-11 09:13:34 -0600[diff] [blame]122Next Topic:&nbsp;&nbsp;<a href="routing.html">URI Routing</a></p>
Derek Jones898949f2011-01-28 07:42:16 -0600[diff] [blame]123<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 - 2011 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">EllisLab, Inc.</a></p>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]124</div>
125
126</body>
Derek Allardee0a7f02008-05-08 13:59:27 +0000[diff] [blame]127</html>