diff options
| author | Derek Jones <derek.jones@ellislab.com> | 2008-05-06 17:59:14 +0200 |
|---|---|---|
| committer | Derek Jones <derek.jones@ellislab.com> | 2008-05-06 17:59:14 +0200 |
| commit | 00618de8c4aca96edb09094a86242b2495ba124d (patch) | |
| tree | 84114be8dabcea1660cf254c971e12d8eb5e9683 /user_guide | |
| parent | fd93d22814b090ef85f3079d31fffa66d23d95e8 (diff) | |
Added a Compatibility Helper
Diffstat (limited to 'user_guide')
| -rw-r--r-- | user_guide/changelog.html | 2 | ||||
| -rw-r--r-- | user_guide/helpers/compatibility_helper.html | 118 | ||||
| -rw-r--r-- | user_guide/nav/nav.js | 1 | ||||
| -rw-r--r-- | user_guide/toc.html | 1 |
4 files changed, 121 insertions, 1 deletions
diff --git a/user_guide/changelog.html b/user_guide/changelog.html index 0279e48b2..2166c5e54 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -89,7 +89,7 @@ SVN Commit: not currently released</p> </li>
<li>Helpers
<ul>
- <li>Added a Compatibility Helper for using some common PHP 5 functions safely in applications that might run on PHP 4 servers</li>
+ <li>Added a <a href="helpers/compatibility_helper.html">Compatibility Helper</a> for using some common PHP 5 functions safely in applications that might run on PHP 4 servers</li>
<li>Added <kbd>form_button()</kbd> in the <a href="helpers/form_helper.html">Form helper</a>.</li>
<li>Changed the radio() and checkbox() functions to default to not checked by default.</li>
<li>Added the ability to include an optional HTTP Response Code in the <kbd>redirect()</kbd> function of the <a href="helpers/url_helper.html">URL Helper</a>.</li>
diff --git a/user_guide/helpers/compatibility_helper.html b/user_guide/helpers/compatibility_helper.html new file mode 100644 index 000000000..15411c9dd --- /dev/null +++ b/user_guide/helpers/compatibility_helper.html @@ -0,0 +1,118 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + +<title>Compatibility Helper : CodeIgniter User Guide</title> + +<style type='text/css' media='all'>@import url('../userguide.css');</style> +<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> + +<script type="text/javascript" src="../nav/nav.js"></script> +<script type="text/javascript" src="../nav/prototype.lite.js"></script> +<script type="text/javascript" src="../nav/moo.fx.js"></script> +<script type="text/javascript" src="../nav/user_guide_menu.js"></script> + +<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<meta http-equiv='expires' content='-1' /> +<meta http-equiv= 'pragma' content='no-cache' /> +<meta name='robots' content='all' /> +<meta name='author' content='ExpressionEngine Dev Team' /> +<meta name='description' content='CodeIgniter User Guide' /> + +</head> +<body> + +<!-- START NAVIGATION --> +<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div> +<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div> +<div id="masthead"> +<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> +<tr> +<td><h1>CodeIgniter User Guide Version 1.6.1</h1></td> +<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td> +</tr> +</table> +</div> +<!-- END NAVIGATION --> + + +<!-- START BREADCRUMB --> + +<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> +<tr> +<td id="breadcrumb"> +<a href="http://codeigniter.com/">CodeIgniter Home</a> › +<a href="../index.html">User Guide Home</a> › +Compatibility Helper +</td> +<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 <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" /> <input type="submit" class="submit" name="sa" value="Go" /></form></td> +</tr> +</table> +<!-- END BREADCRUMB --> + +<br clear="all" /> + + +<!-- START CONTENT --> +<div id="content"> + + +<h1>Compatibility Helper</h1> + +<p>The Compatibility Helper file contains PHP 4 implementations of some PHP 5 only native PHP functions and constants. This can be useful + if you'd like to take advantage of some of these native function but your application may end up running on a PHP 4 server. + In these cases, it may be advantageous to <a href="../general/autoloader.html">Auto-load</a> the Compatibility Helper so you + do not have to load it in each controller.</p> + +<p class="important"><strong>Note:</strong> There are a few compatibility functions that are in CodeIgniter's native Compat.php file. + You may use those functions without loading this helper. The functions are split between that file and this Helper so that only + functions required by the framework are included by default. This way, whether or not you load the additional functions in this Helper + remains your choice.</p> + +<h2>Loading this Helper</h2> + +<p>This helper is loaded using the following code:</p> +<code>$this->load->helper('compatibility');</code> + +<h2>Available Constants</h2> +<p>The following constants are available:</p> + +<h3>PHP_EOL</h3> +<p>The newline character for the server's current OS, e.g. on Windows systems "\r\n", on *nix "\n". + +<h2>Available Functions</h2> +<p>The following functions are available (see linked PHP documentation for documentation):</p> + +<h3><a href="http://us.php.net/manual/en/function.file-put-contents.php">file_put_contents()</a> - The fourth parameter, <var>$context</var>, is not supported.</h3> + +<h3><a href="http://us.php.net/manual/en/function.fputcsv.php">fputcsv()</a></h3> + +<h3><a href="http://us.php.net/manual/en/function.http-build-query.php">http_build_query()</a></h3> + +<h3><a href="http://us.php.net/manual/en/function.str-ireplace.php">str_ireplace()</a> - The fourth parameter, <var>$count</var>, is not supported, as PHP 4 would make it become required.</h3> + +<h3><a href="http://us.php.net/manual/en/function.stripos.php">stripos()</a></h3> + + + + + + + +</div> +<!-- END CONTENT --> + + +<div id="footer"> +<p> +Previous Topic: <a href="array_helper.html">Array Helper</a> + · +<a href="#top">Top of Page</a> · +<a href="../index.html">User Guide Home</a> · +Next Topic: <a href="cookie_helper.html">Cookie Helper</a> +</p> +<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> +</div> + +</body> +</html>
\ No newline at end of file diff --git a/user_guide/nav/nav.js b/user_guide/nav/nav.js index c3c0d1122..88992804f 100644 --- a/user_guide/nav/nav.js +++ b/user_guide/nav/nav.js @@ -98,6 +98,7 @@ function create_menu(basepath) '<h3>Helper Reference</h3>' +
'<ul>' +
'<li><a href="'+base+'helpers/array_helper.html">Array Helper</a></li>' +
+ '<li><a href="'+base+'helpers/compatibility_helper.html">Compatibility Helper</a></li>' +
'<li><a href="'+base+'helpers/cookie_helper.html">Cookie Helper</a></li>' +
'<li><a href="'+base+'helpers/date_helper.html">Date Helper</a></li>' +
'<li><a href="'+base+'helpers/directory_helper.html">Directory Helper</a></li>' +
diff --git a/user_guide/toc.html b/user_guide/toc.html index 6a1813a32..e9dd44859 100644 --- a/user_guide/toc.html +++ b/user_guide/toc.html @@ -154,6 +154,7 @@ Table of Contents <h3>Helper Reference</h3>
<ul>
<li><a href="./helpers/array_helper.html">Array Helper</a></li>
+<li><a href="./helpers/compatibility_helper.html">Compatibility Helper</a></li>
<li><a href="./helpers/cookie_helper.html">Cookie Helper</a></li>
<li><a href="./helpers/date_helper.html">Date Helper</a></li>
<li><a href="./helpers/directory_helper.html">Directory Helper</a></li>
|