diff options
| -rw-r--r-- | user_guide/changelog.html | 7 | ||||
| -rw-r--r-- | user_guide/general/autoloader.html | 3 | ||||
| -rw-r--r-- | user_guide/general/common_functions.html | 90 | ||||
| -rw-r--r-- | user_guide/general/controllers.html | 50 | ||||
| -rw-r--r-- | user_guide/general/reserved_names.html | 151 | ||||
| -rw-r--r-- | user_guide/general/scaffolding.html | 8 | ||||
| -rw-r--r-- | user_guide/general/urls.html | 3 | ||||
| -rw-r--r-- | user_guide/helpers/file_helper.html | 9 | ||||
| -rw-r--r-- | user_guide/nav/nav.js | 2 | ||||
| -rw-r--r-- | user_guide/toc.html | 2 |
10 files changed, 266 insertions, 59 deletions
diff --git a/user_guide/changelog.html b/user_guide/changelog.html index 6521636b6..07637db08 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -105,6 +105,13 @@ SVN Commit: not currently released</p> <li>Modified captcha generation to first look for the function imagecreatetruecolor, and fallback to imagecreate if it isn't available (#4226).</li>
</ul>
</li>
+ <li>Other
+ Changes
+ <ul>
+ <li>Added a <a href="general/reserved_names.html">Reserved Names</a> page to the userguide, and migrated reserved controller names into it.</li>
+ <li>Added a <a href="general/common_functions.html">Common Functions</a> page to the userguide for globally available functions.</li>
+ </ul>
+ </li>
</ul>
<h3>Bugfixes for 1.6.2</h3>
diff --git a/user_guide/general/autoloader.html b/user_guide/general/autoloader.html index b75a71d19..3456fba2a 100644 --- a/user_guide/general/autoloader.html +++ b/user_guide/general/autoloader.html @@ -93,8 +93,7 @@ Previous Topic: <a href="hooks.html">Hooks - Extending the Core</a> ·
<a href="#top">Top of Page</a> ·
<a href="../index.html">User Guide Home</a> ·
-Next Topic: <a href="scaffolding.html">Scaffolding</a>
-</p>
+Next Topic: <a href="common_functions.html">Common Functions</a></p>
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
</div>
diff --git a/user_guide/general/common_functions.html b/user_guide/general/common_functions.html new file mode 100644 index 000000000..e7cf9e068 --- /dev/null +++ b/user_guide/general/common_functions.html @@ -0,0 +1,90 @@ +<!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>Common Functions : 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.2</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> ›
+Auto-loading Resources
+</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>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 />
+ echo "I could write to this if I wanted to";<br />
+}<br />
+else<br />
+{<br />
+ echo "File is not writable";<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>
+</div>
+<!-- END CONTENT -->
+
+
+<div id="footer">
+<p>
+Previous Topic: <a href="autoloader.html">Auto-loading Resources</a><a href="hooks.html"></a>
+ ·
+<a href="#top">Top of Page</a> ·
+<a href="../index.html">User Guide Home</a> ·
+Next Topic: <a href="scaffolding.html">Scaffolding</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/general/controllers.html b/user_guide/general/controllers.html index 2dac6e0d7..4c0c506af 100644 --- a/user_guide/general/controllers.html +++ b/user_guide/general/controllers.html @@ -359,50 +359,7 @@ Constructors can't return a value, but they can do some default work.</p> <p>Since your controller classes will extend the main application controller you
must be careful not to name your functions identically to the ones used by that class, otherwise your local functions
-will override them. The following
-is a list of reserved names. Do not name your controller functions any of these:</p>
-
-<ul>
-<li>Controller</li>
-<li>CI_Base</li>
-<li>_ci_initialize</li>
-<li>_ci_scaffolding</li>
-</ul>
-
-<p><br />If you are running PHP 4 there are some additional reserved names. These ONLY apply if you are running PHP 4.</p>
-
-<ul>
-<li>CI_Loader</li>
-<li>config</li>
-<li>database</li>
-<li>dbutil</li>
-<li>dbforge</li>
-<li>file</li>
-<li>helper</li>
-<li>helpers</li>
-<li>language</li>
-<li>library</li>
-<li>model</li>
-<li>plugin</li>
-<li>plugins</li>
-<li>scaffolding</li>
-<li>script</li>
-<li>view</li>
-<li>vars</li>
-<li>_ci_assign_to_models</li>
-<li>_ci_autoloader</li>
-<li>_ci_init_class</li>
-<li>_ci_init_scaffolding</li>
-<li>_ci_is_instance</li>
-<li>_ci_load</li>
-<li>_ci_load_class</li>
-<li>_ci_object_to_array</li>
-</ul>
-
-
-
-
-
+will override them. See <a href="reserved_names.html">Reserved Names</a> for a full list.</p>
<h2>That's it!</h2>
@@ -416,12 +373,11 @@ is a list of reserved names. Do not name your controller functions any of these <div id="footer">
<p>
-Previous Topic: <a href="urls.html">CodeIgniter URLs</a>
+Previous Topic: <a href="reserved_names.html">Reserved Names</a>
·
<a href="#top">Top of Page</a> ·
<a href="../index.html">User Guide Home</a> ·
-Next Topic: <a href="views.html">Views</a>
-</p>
+Next Topic: <a href="views.html">Views</a></p>
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
</div>
diff --git a/user_guide/general/reserved_names.html b/user_guide/general/reserved_names.html new file mode 100644 index 000000000..60bdec2fc --- /dev/null +++ b/user_guide/general/reserved_names.html @@ -0,0 +1,151 @@ +<!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>Reserved Names : 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.2</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> ›
+Controllers
+</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>Reserved Names</h1>
+
+<p>In order to help out, CodeIgniter uses a series of functions and names in its operation. Because of this, some names cannot be used by a developer. Following is a list of reserved names that cannot be used.</p>
+<h3>Controller names</h3>
+<p>Since your controller classes will extend the main application controller you
+must be careful not to name your functions identically to the ones used by that class, otherwise your local functions
+will override them. The following
+is a list of reserved names. Do not name your controller functions any of these:</p>
+<ul>
+ <li>Controller</li>
+ <li>CI_Base</li>
+ <li>_ci_initialize</li>
+ <li>_ci_scaffolding</li>
+</ul>
+<p><br />
+ If you are running PHP 4 there are some additional reserved names. These ONLY apply if you are running PHP 4.</p>
+<ul>
+ <li>CI_Loader</li>
+ <li>config</li>
+ <li>database</li>
+ <li>dbutil</li>
+ <li>dbforge</li>
+ <li>file</li>
+ <li>helper</li>
+ <li>helpers</li>
+ <li>language</li>
+ <li>library</li>
+ <li>model</li>
+ <li>plugin</li>
+ <li>plugins</li>
+ <li>scaffolding</li>
+ <li>script</li>
+ <li>view</li>
+ <li>vars</li>
+ <li>_ci_assign_to_models</li>
+ <li>_ci_autoloader</li>
+ <li>_ci_init_class</li>
+ <li>_ci_init_scaffolding</li>
+ <li>_ci_is_instance</li>
+ <li>_ci_load</li>
+ <li>_ci_load_class</li>
+ <li>_ci_object_to_array</li>
+</ul>
+<h3>Functions</h3>
+<ul>
+ <li>is_really_writable</li>
+ <li>config_item</li>
+ <li>show_error</li>
+ <li>show_404</li>
+ <li>log_message</li>
+ <li>_exception_handler</li>
+ </ul>
+<h3>Variables</h3>
+<ul>
+ <li>config</li>
+ <li>mimes</li>
+ </ul>
+<h3>Constants</h3>
+<ul>
+ <li>CI_VERSION</li>
+ <li>EXT</li>
+ <li>FCPATH</li>
+ <li>SELF</li>
+ <li>BASEPATH</li>
+ <li>APPPATH</li>
+ <li>FILE_READ_MODE</li>
+ <li>FILE_WRITE_MODE</li>
+ <li>DIR_READ_MODE</li>
+ <li>DIR_WRITE_MODE</li>
+ <li>FOPEN_READ</li>
+ <li>FOPEN_READ_WRITE</li>
+ <li>FOPEN_WRITE_CREATE_DESTRUCTIVE</li>
+ <li>FOPEN_READ_WRITE_CREATE_DESTRUCTIVE</li>
+ <li>FOPEN_WRITE_CREATE</li>
+ <li>FOPEN_READ_WRITE_CREATE</li>
+ <li>FOPEN_WRITE_CREATE_STRICT</li>
+ <li>FOPEN_READ_WRITE_CREATE_STRICT</li>
+</ul>
+</div>
+<!-- END CONTENT -->
+
+
+<div id="footer">
+<p>
+Previous Topic: <a href="urls.html">CodeIgniter URLs</a>
+ ·
+<a href="#top">Top of Page</a> ·
+<a href="../index.html">User Guide Home</a> ·
+Next Topic: <a href="controllers.html">Controllers</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/general/scaffolding.html b/user_guide/general/scaffolding.html index 764e3b4cf..7dc66d1d8 100644 --- a/user_guide/general/scaffolding.html +++ b/user_guide/general/scaffolding.html @@ -104,7 +104,7 @@ class Blog extends Controller {<br /> function Blog()<br />
{<br />
parent::Controller();<br /><br />
- <samp>$this->load->scaffolding(</samp><kbd>'table_name'</kbd>);</samp><br />
+ <samp>$this->load->scaffolding(</samp><kbd>'table_name'</kbd>);<br />
}<br />
}<br />
?></code>
@@ -135,12 +135,10 @@ database functions.</p> <div id="footer">
<p>
-Previous Topic: <a href="autoloader.html">Auto-loading Resources</a>
- ·
+Previous Topic: <a href="common_functions.html">Common Functions</a> ·
<a href="#top">Top of Page</a> ·
<a href="../index.html">User Guide Home</a> ·
-Next Topic: <a href="routing.html">URI Routing</a>
-</p>
+Next Topic: <a href="routing.html">URI Routing</a></p>
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
</div>
diff --git a/user_guide/general/urls.html b/user_guide/general/urls.html index 9902083fa..8ba46e3d8 100644 --- a/user_guide/general/urls.html +++ b/user_guide/general/urls.html @@ -145,8 +145,7 @@ Previous Topic: <a href="index.html">Getting Started</a> ·
<a href="#top">Top of Page</a> ·
<a href="../index.html">User Guide Home</a> ·
-Next Topic: <a href="controllers.html">Controllers</a>
-</p>
+Next Topic: <a href="reserved_names.html">Reserved Names</a></p>
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
</div>
diff --git a/user_guide/helpers/file_helper.html b/user_guide/helpers/file_helper.html index a88e5dfc9..3fa92462b 100644 --- a/user_guide/helpers/file_helper.html +++ b/user_guide/helpers/file_helper.html @@ -134,11 +134,14 @@ can optionally be added to the file names by setting the second parameter to TRU <p>Given a file and path, returns the name, path, size, date modified. Second parameter allows you to explicitly declare what information you want returned; options are: name, server_path, size, date, readable, writable, executable, fileperms. Returns FALSE if the file cannot be found.</p>
<p class="important"><strong>Note:</strong> The "writable" uses the PHP function is_writable() which is known to have issues on the IIS webserver. Consider using fileperms instead, which returns information from PHP's fileperms() function.</p>
-<h2>get_mime_by_extension('<var>path/to/file/</var>')</h2>
+<h2>get_mime_by_extension('<var>file</var>')</h2>
<p>Translates a file extension into a mime type based on config/mimes.php. Returns FALSE if it can't determine the type, or open the mime config file.</p>
-
-<p class="important"><strong>Note:</strong> This is not an accurate way of determining file mime types, and is here strictly as a convenience. It should not be used for security.</p>
+<p>
+<code>$file = "somefile.png";<br />
+echo $file . ' is has a mime type of ' . get_mime_by_extension($file);</code>
+</p>
+<p class="critical"><strong>Note:</strong> This is not an accurate way of determining file mime types, and is here strictly as a convenience. It should not be used for security.</p>
</div>
<!-- END CONTENT -->
diff --git a/user_guide/nav/nav.js b/user_guide/nav/nav.js index 88992804f..e82429943 100644 --- a/user_guide/nav/nav.js +++ b/user_guide/nav/nav.js @@ -42,6 +42,7 @@ function create_menu(basepath) '<ul>' +
'<li><a href="'+base+'general/index.html">Getting Started</a></li>' +
'<li><a href="'+base+'general/urls.html">CodeIgniter URLs</a></li>' +
+ '<li><a href="'+base+'general/reserved_names.html">Reserved Names</a></li>' +
'<li><a href="'+base+'general/controllers.html">Controllers</a></li>' +
'<li><a href="'+base+'general/views.html">Views</a></li>' +
'<li><a href="'+base+'general/models.html">Models</a></li>' +
@@ -52,6 +53,7 @@ function create_menu(basepath) '<li><a href="'+base+'general/core_classes.html">Creating Core Classes</a></li>' +
'<li><a href="'+base+'general/hooks.html">Hooks - Extending the Core</a></li>' +
'<li><a href="'+base+'general/autoloader.html">Auto-loading Resources</a></li>' +
+ '<li><a href="'+base+'general/common_functions.html">Common Functions</a></li>' +
'<li><a href="'+base+'general/scaffolding.html">Scaffolding</a></li>' +
'<li><a href="'+base+'general/routing.html">URI Routing</a></li>' +
'<li><a href="'+base+'general/errors.html">Error Handling</a></li>' +
diff --git a/user_guide/toc.html b/user_guide/toc.html index ee4975286..5a4763492 100644 --- a/user_guide/toc.html +++ b/user_guide/toc.html @@ -95,6 +95,7 @@ Table of Contents <ul>
<li><a href="./general/index.html">Getting Started</a></li>
<li><a href="./general/urls.html">CodeIgniter URLs</a></li>
+ <li><a href="general/reserved_names.html">Reserved Names</a></li>
<li><a href="./general/controllers.html">Controllers</a></li>
<li><a href="./general/views.html">Views</a></li>
<li><a href="./general/models.html">Models</a></li>
@@ -105,6 +106,7 @@ Table of Contents <li><a href="./general/core_classes.html">Creating Core Classes</a></li>
<li><a href="./general/hooks.html">Hooks - Extending the Core</a></li>
<li><a href="./general/autoloader.html">Auto-loading Resources</a></li>
+ <li><a href="general/common_functions.html">Common Functions</a></li>
<li><a href="./general/scaffolding.html">Scaffolding</a></li>
<li><a href="./general/routing.html">URI Routing</a></li>
<li><a href="./general/errors.html">Error Handling</a></li>
|