Emre Akay
12 years ago
168 changed files with 0 additions and 29529 deletions
@ -1,824 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Active Record : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Active Record |
||||
</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>Active Record Class</h1> |
||||
|
||||
<p>CodeIgniter uses a modified version of the Active Record Database Pattern. |
||||
This pattern allows information to be retrieved, inserted, and updated in your database with minimal scripting. |
||||
In some cases only one or two lines of code are necessary to perform a database action. |
||||
CodeIgniter does not require that each database table be its own class file. It instead provides a more simplified interface.</p> |
||||
|
||||
<p>Beyond simplicity, a major benefit to using the Active Record features is that it allows you to create database independent applications, since the query syntax |
||||
is generated by each database adapter. It also allows for safer queries, since the values are escaped automatically by the system.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you intend to write your own queries you can disable this class in your database config file, allowing the core database library and adapter to utilize fewer resources.<br /></p> |
||||
|
||||
<ul> |
||||
<li><a href="#select">Selecting Data</a></li> |
||||
<li><a href="#insert">Inserting Data</a></li> |
||||
<li><a href="#update">Updating Data</a></li> |
||||
<li><a href="#delete">Deleting Data</a></li> |
||||
<li><a href="#chaining">Method Chaining</a></li> |
||||
<li><a href="#caching">Active Record Caching</a></li> |
||||
</ul> |
||||
|
||||
<h1><a name="select"> </a>Selecting Data</h1> |
||||
|
||||
<p>The following functions allow you to build SQL <strong>SELECT</strong> statements.</p> |
||||
|
||||
<p><strong>Note: If you are using PHP 5 you can use method chaining for more compact syntax. This is described at the end of the page.</strong></p> |
||||
|
||||
|
||||
<h2>$this->db->get();</h2> |
||||
|
||||
<p>Runs the selection query and returns the result. Can be used by itself to retrieve all records from a table:</p> |
||||
|
||||
<code>$query = $this->db->get('mytable');<br /> |
||||
<br /> |
||||
// Produces: SELECT * FROM mytable</code> |
||||
|
||||
<p>The second and third parameters enable you to set a limit and offset clause:</p> |
||||
|
||||
<code>$query = $this->db->get('mytable', 10, 20);<br /> |
||||
<br /> |
||||
// Produces: SELECT * FROM mytable LIMIT 20, 10 (in MySQL. Other databases have slightly different syntax)</code> |
||||
|
||||
<p>You'll notice that the above function is assigned to a variable named <kbd>$query</kbd>, which can be used to show the results:</p> |
||||
|
||||
<code>$query = $this->db->get('mytable');<br /> |
||||
<br /> |
||||
foreach ($query->result() as $row)<br /> |
||||
{<br /> |
||||
echo $row->title;<br /> |
||||
}</code> |
||||
|
||||
<p>Please visit the <a href="results.html">result functions</a> page for a full discussion regarding result generation.</p> |
||||
|
||||
|
||||
<h2>$this->db->get_where();</h2> |
||||
|
||||
<p>Identical to the above function except that it permits you to add a "where" clause in the second parameter, |
||||
instead of using the db->where() function:</p> |
||||
|
||||
<code>$query = $this->db->get_where('mytable', array('id' => $id), $limit, $offset);</code> |
||||
|
||||
<p>Please read the about the where function below for more information.</p> |
||||
<p class="important">Note: get_where() was formerly known as getwhere(), which has been removed</p> |
||||
|
||||
<h2>$this->db->select();</h2> |
||||
<p>Permits you to write the SELECT portion of your query:</p> |
||||
<p><code> |
||||
$this->db->select('title, content, date');<br /> |
||||
<br /> |
||||
$query = $this->db->get('mytable');<br /> |
||||
<br /> |
||||
// Produces: SELECT title, content, date FROM mytable</code></p> |
||||
<p class="important"><strong>Note:</strong> If you are selecting all (*) from a table you do not need to use this function. When omitted, CodeIgniter assumes you wish to SELECT *</p> |
||||
|
||||
<p>$this->db->select() accepts an optional second parameter. If you set it to FALSE, CodeIgniter will not try to protect your field or table names with backticks. This is useful if you need a compound select statement.</p> |
||||
<p><code>$this->db->select('(SELECT SUM(payments.amount) FROM payments WHERE payments.invoice_id=4') AS amount_paid', FALSE); <br /> |
||||
$query = $this->db->get('mytable');<br /> |
||||
</code></p> |
||||
<h2>$this->db->select_max();</h2> |
||||
<p>Writes a "SELECT MAX(field)" portion for your query. You can optionally include a second parameter to rename the resulting field.</p> |
||||
<p><code> |
||||
$this->db->select_max('age');<br /> |
||||
$query = $this->db->get('members');<br /> |
||||
|
||||
// Produces: SELECT MAX(age) as age FROM members<br /> |
||||
<br /> |
||||
$this->db->select_max('age', 'member_age');<br /> |
||||
$query = $this->db->get('members');<br /> |
||||
// Produces: SELECT MAX(age) as member_age FROM members</code></p> |
||||
|
||||
<h2>$this->db->select_min();</h2> |
||||
<p>Writes a "SELECT MIN(field)" portion for your query. As with <dfn>select_max()</dfn>, You can optionally include a second parameter to rename the resulting field.</p> |
||||
<p><code> |
||||
$this->db->select_min('age');<br /> |
||||
$query = $this->db->get('members');<br /> |
||||
// Produces: SELECT MIN(age) as age FROM members</code></p> |
||||
|
||||
<h2>$this->db->select_avg();</h2> |
||||
<p>Writes a "SELECT AVG(field)" portion for your query. As with <dfn>select_max()</dfn>, You can optionally include a second parameter to rename the resulting field.</p> |
||||
<p><code> |
||||
$this->db->select_avg('age');<br /> |
||||
$query = $this->db->get('members');<br /> |
||||
// Produces: SELECT AVG(age) as age FROM members</code></p> |
||||
|
||||
<h2>$this->db->select_sum();</h2> |
||||
<p>Writes a "SELECT SUM(field)" portion for your query. As with <dfn>select_max()</dfn>, You can optionally include a second parameter to rename the resulting field.</p> |
||||
<p><code> |
||||
$this->db->select_sum('age');<br /> |
||||
$query = $this->db->get('members');<br /> |
||||
// Produces: SELECT SUM(age) as age FROM members</code></p> |
||||
|
||||
<h2>$this->db->from();</h2> |
||||
|
||||
<p>Permits you to write the FROM portion of your query:</p> |
||||
|
||||
<code> |
||||
$this->db->select('title, content, date');<br /> |
||||
$this->db->from('mytable');<br /> |
||||
<br /> |
||||
$query = $this->db->get();<br /> |
||||
<br /> |
||||
// Produces: SELECT title, content, date FROM mytable</code> |
||||
|
||||
<p class="important">Note: As shown earlier, the FROM portion of your query can be specified in the <dfn>$this->db->get()</dfn> function, so use whichever method |
||||
you prefer.</p> |
||||
|
||||
<h2>$this->db->join();</h2> |
||||
|
||||
<p>Permits you to write the JOIN portion of your query:</p> |
||||
|
||||
<code> |
||||
$this->db->select('*');<br /> |
||||
$this->db->from('blogs');<br /> |
||||
$this->db->join('comments', 'comments.id = blogs.id');<br /> |
||||
<br /> |
||||
$query = $this->db->get();<br /> |
||||
<br /> |
||||
// Produces: <br /> |
||||
// SELECT * FROM blogs<br /> |
||||
// JOIN comments ON comments.id = blogs.id<br /> |
||||
</code> |
||||
|
||||
<p>Multiple function calls can be made if you need several joins in one query.</p> |
||||
|
||||
<p>If you need a specific type of JOIN you can specify it via the third parameter of the function. |
||||
Options are: left, right, outer, inner, left outer, and right outer.</p> |
||||
|
||||
<code> |
||||
$this->db->join('comments', 'comments.id = blogs.id', <strong>'left'</strong>);<br /> |
||||
<br /> |
||||
// Produces: LEFT JOIN comments ON comments.id = blogs.id</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>$this->db->where();</h2> |
||||
<p>This function enables you to set <strong>WHERE</strong> clauses using one of four methods:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> All values passed to this function are escaped automatically, producing safer queries.</p> |
||||
|
||||
<ol> |
||||
<li><strong>Simple key/value method:</strong> |
||||
|
||||
<code>$this->db->where('name', $name); |
||||
<br /><br />// Produces: WHERE name = 'Joe' </code> |
||||
|
||||
<p>Notice that the equal sign is added for you.</p> |
||||
|
||||
<p>If you use multiple function calls they will be chained together with <var>AND</var> between them:</p> |
||||
|
||||
<code>$this->db->where('name', $name);<br /> |
||||
$this->db->where('title', $title);<br /> |
||||
$this->db->where('status', $status); |
||||
<br /><br />// WHERE name = 'Joe' AND title = 'boss' AND status = 'active' </code> </li> |
||||
|
||||
<li><strong>Custom key/value method:</strong> |
||||
|
||||
<p>You can include an operator in the first parameter in order to control the comparison:</p> |
||||
|
||||
<code>$this->db->where('name !=', $name);<br /> |
||||
$this->db->where('id <', $id); |
||||
<br /><br />// Produces: WHERE name != 'Joe' AND id < 45 </code> </li> |
||||
<li><strong>Associative array method:</strong> |
||||
|
||||
|
||||
<code> |
||||
$array = array('name' => $name, 'title' => $title, 'status' => $status);<br /><br /> |
||||
|
||||
$this->db->where($array); |
||||
<br /><br />// Produces: WHERE name = 'Joe' AND title = 'boss' AND status = 'active' </code> |
||||
|
||||
<p>You can include your own operators using this method as well:</p> |
||||
|
||||
<code> |
||||
$array = array('name !=' => $name, 'id <' => $id, 'date >' => $date);<br /><br /> |
||||
|
||||
$this->db->where($array);</code> </li> |
||||
<li><strong>Custom string:</strong> |
||||
|
||||
<p>You can write your own clauses manually:</p> |
||||
|
||||
<code> |
||||
$where = "name='Joe' AND status='boss' OR status='active'";<br /><br /> |
||||
$this->db->where($where);</code></li> |
||||
</ol> |
||||
|
||||
|
||||
<p>$this->db->where() accepts an optional third parameter. If you set it to FALSE, CodeIgniter will not try to protect your field or table names with backticks.</p> |
||||
<p><code> $this->db->where('MATCH (field) AGAINST ("value")', NULL, FALSE);<br /> |
||||
</code></p> |
||||
<h2>$this->db->or_where();</h2> |
||||
<p>This function is identical to the one above, except that multiple instances are joined by OR:</p> |
||||
|
||||
<code> |
||||
$this->db->where('name !=', $name);<br /> |
||||
$this->db->or_where('id >', $id); |
||||
<br /> |
||||
<br />// Produces: WHERE name != 'Joe' OR id > 50</code> |
||||
|
||||
<p class="important">Note: or_where() was formerly known as orwhere(), which has been removed.</p> |
||||
|
||||
|
||||
<h2>$this->db->where_in();</h2> |
||||
<p>Generates a WHERE field IN ('item', 'item') SQL query joined with AND if appropriate</p> |
||||
<p><code> |
||||
$names = array('Frank', 'Todd', 'James');<br /> |
||||
$this->db->where_in('username', $names);<br /> |
||||
// Produces: WHERE username IN ('Frank', 'Todd', 'James')</code></p> |
||||
|
||||
<h2>$this->db->or_where_in();</h2> |
||||
<p>Generates a WHERE field IN ('item', 'item') SQL query joined with OR if appropriate</p> |
||||
<p><code> |
||||
$names = array('Frank', 'Todd', 'James');<br /> |
||||
$this->db->or_where_in('username', $names);<br /> |
||||
// Produces: OR username IN ('Frank', 'Todd', 'James')</code></p> |
||||
|
||||
<h2>$this->db->where_not_in();</h2> |
||||
<p>Generates a WHERE field NOT IN ('item', 'item') SQL query joined with AND if appropriate</p> |
||||
<p><code> |
||||
$names = array('Frank', 'Todd', 'James');<br /> |
||||
$this->db->where_not_in('username', $names);<br /> |
||||
// Produces: WHERE username NOT IN ('Frank', 'Todd', 'James')</code></p> |
||||
|
||||
<h2>$this->db->or_where_not_in();</h2> |
||||
<p>Generates a WHERE field NOT IN ('item', 'item') SQL query joined with OR if appropriate</p> |
||||
<p><code> |
||||
$names = array('Frank', 'Todd', 'James');<br /> |
||||
$this->db->or_where_not_in('username', $names);<br /> |
||||
// Produces: OR username NOT IN ('Frank', 'Todd', 'James')</code></p> |
||||
|
||||
<h2>$this->db->like();</h2> |
||||
<p>This function enables you to generate <strong>LIKE</strong> clauses, useful for doing searches.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> All values passed to this function are escaped automatically.</p> |
||||
|
||||
|
||||
<ol> |
||||
<li><strong>Simple key/value method:</strong> |
||||
|
||||
<code>$this->db->like('title', 'match'); |
||||
<br /><br />// Produces: WHERE title LIKE '%match%' </code> |
||||
|
||||
<p>If you use multiple function calls they will be chained together with <var>AND</var> between them:</p> |
||||
|
||||
<code>$this->db->like('title', 'match');<br /> |
||||
$this->db->like('body', 'match'); |
||||
<br /><br /> |
||||
// WHERE title LIKE '%match%' AND body LIKE '%match%</code> |
||||
If you want to control where the wildcard (%) is placed, you can use an optional third argument. Your options are 'before', 'after' and 'both' (which is the default). |
||||
<code>$this->db->like('title', 'match', 'before'); |
||||
<br /> |
||||
// Produces: WHERE title LIKE '%match' <br /> |
||||
<br /> |
||||
$this->db->like('title', 'match', 'after'); <br /> |
||||
// Produces: WHERE title LIKE 'match%' <br /> |
||||
<br /> |
||||
$this->db->like('title', 'match', 'both'); <br /> |
||||
// Produces: WHERE title LIKE '%match%' </code> </li> |
||||
|
||||
If you do not want to use the wildcard (%) you can pass to the optional third argument the option 'none'. |
||||
|
||||
<code> |
||||
$this->db->like('title', 'match', 'none'); <br /> |
||||
// Produces: WHERE title LIKE 'match' |
||||
</code> |
||||
|
||||
<li><strong>Associative array method:</strong> |
||||
|
||||
<code> |
||||
$array = array('title' => $match, 'page1' => $match, 'page2' => $match);<br /><br /> |
||||
|
||||
$this->db->like($array); |
||||
<br /><br />// WHERE title LIKE '%match%' AND page1 LIKE '%match%' AND page2 LIKE '%match%'</code></li> |
||||
</ol> |
||||
|
||||
|
||||
<h2>$this->db->or_like();</h2> |
||||
<p>This function is identical to the one above, except that multiple instances are joined by OR:</p> |
||||
|
||||
<code> |
||||
$this->db->like('title', 'match');<br /> |
||||
$this->db->or_like('body', $match); |
||||
<br /> |
||||
<br />// WHERE title LIKE '%match%' OR body LIKE '%match%'</code> |
||||
|
||||
|
||||
|
||||
|
||||
<p class="important">Note: or_like() was formerly known as orlike(), which has been removed.</p> |
||||
<h2>$this->db->not_like();</h2> |
||||
<p>This function is identical to <strong>like()</strong>, except that it generates NOT LIKE statements:</p> |
||||
<code> $this->db->not_like('title', 'match');<br /> |
||||
<br /> |
||||
// WHERE title NOT LIKE '%match%</code> |
||||
<h2>$this->db->or_not_like();</h2> |
||||
<p>This function is identical to <strong>not_like()</strong>, except that multiple instances are joined by OR:</p> |
||||
<code> $this->db->like('title', 'match');<br /> |
||||
$this->db->or_not_like('body', 'match'); <br /> |
||||
<br /> |
||||
// WHERE title LIKE '%match% OR body NOT LIKE '%match%'</code> |
||||
<h2>$this->db->group_by();</h2> |
||||
<p>Permits you to write the GROUP BY portion of your query:</p> |
||||
|
||||
<code>$this->db->group_by("title"); |
||||
<br /><br />// Produces: GROUP BY title |
||||
</code> |
||||
|
||||
<p>You can also pass an array of multiple values as well:</p> |
||||
|
||||
<code>$this->db->group_by(array("title", "date")); |
||||
<br /> |
||||
<br />// Produces: GROUP BY title, date</code> |
||||
|
||||
<p class="important">Note: group_by() was formerly known as groupby(), which has been removed. </p> |
||||
|
||||
<h2> $this->db->distinct();<br /> |
||||
</h2> |
||||
<p>Adds the "DISTINCT" keyword to a query</p> |
||||
<p><code>$this->db->distinct();<br /> |
||||
$this->db->get('table');<br /> |
||||
<br /> |
||||
// Produces: SELECT DISTINCT * FROM table</code></p> |
||||
<h2>$this->db->having();</h2> |
||||
<p>Permits you to write the HAVING portion of your query. There are 2 possible syntaxes, 1 argument or 2:</p> |
||||
|
||||
<code>$this->db->having('user_id = 45'); |
||||
<br /> |
||||
// Produces: HAVING user_id = 45<br /> |
||||
<br /> |
||||
$this->db->having('user_id', 45); <br /> |
||||
// Produces: HAVING user_id = 45<br /> |
||||
<br /> |
||||
</code> |
||||
|
||||
<p>You can also pass an array of multiple values as well:</p> |
||||
|
||||
|
||||
<p><code>$this->db->having(array('title =' => 'My Title', 'id <' => $id)); <br /> |
||||
<br /> |
||||
// Produces: HAVING title = 'My Title', id < 45</code></p> |
||||
<p>If you are using a database that CodeIgniter escapes queries for, you can prevent escaping content by passing an optional third argument, and setting it to FALSE.</p> |
||||
<p><code>$this->db->having('user_id', 45); <br /> |
||||
// Produces: HAVING `user_id` = 45 in some databases such as MySQL |
||||
<br /> |
||||
$this->db->having('user_id', 45, FALSE); <br /> |
||||
// Produces: HAVING user_id = 45</code></p> |
||||
<h2>$this->db->or_having();</h2> |
||||
<p>Identical to having(), only separates multiple clauses with "OR".</p> |
||||
<h2>$this->db->order_by();</h2> |
||||
<p>Lets you set an ORDER BY clause. The first parameter contains the name of the column you would like to order by. |
||||
The second parameter lets you set the direction of the result. Options are <kbd>asc</kbd> or <kbd>desc</kbd>, or <kbd>random</kbd>. </p> |
||||
|
||||
<code>$this->db->order_by("title", "desc"); |
||||
<br /> |
||||
<br />// Produces: ORDER BY title DESC |
||||
</code> |
||||
|
||||
<p>You can also pass your own string in the first parameter:</p> |
||||
|
||||
<code>$this->db->order_by('title desc, name asc'); |
||||
<br /> |
||||
<br />// Produces: ORDER BY title DESC, name ASC |
||||
</code> |
||||
|
||||
<p>Or multiple function calls can be made if you need multiple fields.</p> |
||||
|
||||
<p><code>$this->db->order_by("title", "desc");<br /> |
||||
$this->db->order_by("name", "asc"); <br /> |
||||
<br /> |
||||
// Produces: ORDER BY title DESC, name ASC |
||||
</code></p> |
||||
<p class="important">Note: order_by() was formerly known as orderby(), which has been removed.</p> |
||||
<p class="important">Note: random ordering is not currently supported in Oracle or MSSQL drivers. These will default to 'ASC'.</p> |
||||
<h2>$this->db->limit();</h2> |
||||
<p>Lets you limit the number of rows you would like returned by the query:</p> |
||||
|
||||
<code> |
||||
$this->db->limit(10);<br /> |
||||
<br /> |
||||
// Produces: LIMIT 10</code> |
||||
|
||||
|
||||
<p>The second parameter lets you set a result offset.</p> |
||||
|
||||
<code> |
||||
$this->db->limit(10, 20);<br /> |
||||
<br /> |
||||
// Produces: LIMIT 20, 10 (in MySQL. Other databases have slightly different syntax)</code> |
||||
|
||||
|
||||
<h2>$this->db->count_all_results();</h2> |
||||
|
||||
<p>Permits you to determine the number of rows in a particular Active Record query. Queries will accept Active Record restrictors such as where(), or_where(), like(), or_like(), etc. Example:</p> |
||||
<code>echo $this->db->count_all_results('<var>my_table</var>');<br /> |
||||
|
||||
// Produces an integer, like 25<br /> |
||||
<br /> |
||||
$this->db->like('title', 'match');<br /> |
||||
$this->db->from('<var>my_table</var>');<br /> |
||||
echo $this->db->count_all_results();<br /> |
||||
// Produces an integer, like 17 </code> |
||||
|
||||
<h2>$this->db->count_all();</h2> |
||||
|
||||
<p>Permits you to determine the number of rows in a particular table. Submit the table name in the first parameter. Example:</p> |
||||
|
||||
<code>echo $this->db->count_all('<var>my_table</var>');<br /> |
||||
<br /> |
||||
// Produces an integer, like 25</code> |
||||
|
||||
|
||||
|
||||
<a name="insert"> </a> |
||||
<h1>Inserting Data</h1> |
||||
|
||||
<h2>$this->db->insert();</h2> |
||||
<p>Generates an insert string based on the data you supply, and runs the query. You can either pass an |
||||
<strong>array</strong> or an <strong>object</strong> to the function. Here is an example using an array:</p> |
||||
|
||||
<code> |
||||
$data = array(<br /> |
||||
'title' => 'My title' ,<br /> |
||||
'name' => 'My Name' ,<br /> |
||||
'date' => 'My date'<br /> |
||||
);<br /> |
||||
<br /> |
||||
$this->db->insert('mytable', $data); |
||||
<br /><br /> |
||||
// Produces: INSERT INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date')</code> |
||||
|
||||
<p>The first parameter will contain the table name, the second is an associative array of values.</p> |
||||
|
||||
<p>Here is an example using an object:</p> |
||||
|
||||
<code> |
||||
/*<br /> |
||||
class Myclass {<br /> |
||||
var $title = 'My Title';<br /> |
||||
var $content = 'My Content';<br /> |
||||
var $date = 'My Date';<br /> |
||||
}<br /> |
||||
*/<br /> |
||||
<br /> |
||||
$object = new Myclass;<br /> |
||||
<br /> |
||||
$this->db->insert('mytable', $object); |
||||
<br /><br /> |
||||
// Produces: INSERT INTO mytable (title, content, date) VALUES ('My Title', 'My Content', 'My Date')</code> |
||||
|
||||
<p>The first parameter will contain the table name, the second is an object.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> All values are escaped automatically producing safer queries.</p> |
||||
|
||||
<h2>$this->db->insert_batch();</h2> |
||||
<p>Generates an insert string based on the data you supply, and runs the query. You can either pass an |
||||
<strong>array</strong> or an <strong>object</strong> to the function. Here is an example using an array:</p> |
||||
|
||||
<code> |
||||
$data = array(<br/> |
||||
array(<br /> |
||||
'title' => 'My title' ,<br /> |
||||
'name' => 'My Name' ,<br /> |
||||
'date' => 'My date'<br /> |
||||
),<br /> |
||||
array(<br /> |
||||
'title' => 'Another title' ,<br /> |
||||
'name' => 'Another Name' ,<br /> |
||||
'date' => 'Another date'<br /> |
||||
)<br/> |
||||
);<br /> |
||||
<br /> |
||||
$this->db->insert_batch('mytable', $data); |
||||
<br /><br /> |
||||
// Produces: INSERT INTO mytable (title, name, date) VALUES ('My title', 'My name', 'My date'), ('Another title', 'Another name', 'Another date')</code> |
||||
|
||||
<p>The first parameter will contain the table name, the second is an associative array of values.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> All values are escaped automatically producing safer queries.</p> |
||||
|
||||
|
||||
|
||||
<h2>$this->db->set();</h2> |
||||
<p>This function enables you to set values for <dfn>inserts</dfn> or <dfn>updates</dfn>.</p> |
||||
|
||||
<p><strong>It can be used instead of passing a data array directly to the insert or update functions:</strong> </p> |
||||
|
||||
<code>$this->db->set('name', $name); |
||||
<br /> |
||||
$this->db->insert('mytable'); |
||||
<br /><br /> |
||||
// Produces: INSERT INTO mytable (name) VALUES ('{$name}')</code> |
||||
|
||||
<p>If you use multiple function called they will be assembled properly based on whether you are doing an insert or an update:</p> |
||||
|
||||
<code>$this->db->set('name', $name);<br /> |
||||
$this->db->set('title', $title);<br /> |
||||
$this->db->set('status', $status);<br /> |
||||
$this->db->insert('mytable'); </code> |
||||
<p><strong>set()</strong> will also accept an optional third parameter ($escape), that will prevent data from being escaped if set to FALSE. To illustrate the difference, here is set() used both with and without the escape parameter.</p> |
||||
<p><code>$this->db->set('field', 'field+1', FALSE);<br /> |
||||
$this->db->insert('mytable'); <br /> |
||||
// gives INSERT INTO mytable (field) VALUES (field+1)<br /> |
||||
<br /> |
||||
$this->db->set('field', 'field+1');<br /> |
||||
$this->db->insert('mytable'); <br /> |
||||
// gives INSERT INTO mytable (field) VALUES ('field+1')</code></p> |
||||
<p>You can also pass an associative array to this function:</p> |
||||
<code> |
||||
$array = array('name' => $name, 'title' => $title, 'status' => $status);<br /><br /> |
||||
|
||||
$this->db->set($array);<br /> |
||||
$this->db->insert('mytable'); |
||||
</code> |
||||
|
||||
<p>Or an object:</p> |
||||
|
||||
|
||||
<code> |
||||
/*<br /> |
||||
class Myclass {<br /> |
||||
var $title = 'My Title';<br /> |
||||
var $content = 'My Content';<br /> |
||||
var $date = 'My Date';<br /> |
||||
}<br /> |
||||
*/<br /> |
||||
<br /> |
||||
$object = new Myclass;<br /> |
||||
<br /> |
||||
$this->db->set($object);<br /> |
||||
$this->db->insert('mytable'); |
||||
</code> |
||||
|
||||
|
||||
|
||||
<a name="update"> </a> |
||||
<h1>Updating Data</h1> |
||||
|
||||
<h2>$this->db->update();</h2> |
||||
<p>Generates an update string and runs the query based on the data you supply. You can pass an |
||||
<strong>array</strong> or an <strong>object</strong> to the function. Here is an example using |
||||
an array:</p> |
||||
|
||||
<code> |
||||
$data = array(<br /> |
||||
'title' => $title,<br /> |
||||
'name' => $name,<br /> |
||||
'date' => $date<br /> |
||||
);<br /> |
||||
<br /> |
||||
$this->db->where('id', $id);<br /> |
||||
$this->db->update('mytable', $data); |
||||
<br /><br /> |
||||
// Produces:<br /> |
||||
// UPDATE mytable <br /> |
||||
// SET title = '{$title}', name = '{$name}', date = '{$date}'<br /> |
||||
// WHERE id = $id</code> |
||||
|
||||
<p>Or you can supply an object:</p> |
||||
|
||||
<code> |
||||
/*<br /> |
||||
class Myclass {<br /> |
||||
var $title = 'My Title';<br /> |
||||
var $content = 'My Content';<br /> |
||||
var $date = 'My Date';<br /> |
||||
}<br /> |
||||
*/<br /> |
||||
<br /> |
||||
$object = new Myclass;<br /> |
||||
<br /> |
||||
$this->db->where('id', $id);<br /> |
||||
$this->db->update('mytable', $object); |
||||
<br /> |
||||
<br /> |
||||
// Produces:<br /> |
||||
// UPDATE mytable <br /> |
||||
// SET title = '{$title}', name = '{$name}', date = '{$date}'<br /> |
||||
// WHERE id = $id</code> |
||||
|
||||
|
||||
|
||||
<p class="important"><strong>Note:</strong> All values are escaped automatically producing safer queries.</p> |
||||
|
||||
<p>You'll notice the use of the <dfn>$this->db->where()</dfn> function, enabling you to set the WHERE clause. |
||||
You can optionally pass this information directly into the update function as a string:</p> |
||||
|
||||
<code>$this->db->update('mytable', $data, "id = 4");</code> |
||||
|
||||
<p>Or as an array:</p> |
||||
|
||||
<code>$this->db->update('mytable', $data, array('id' => $id));</code> |
||||
|
||||
<p>You may also use the <dfn>$this->db->set()</dfn> function described above when performing updates.</p> |
||||
|
||||
<h2>$this->db->update_batch();</h2> |
||||
<p>Generates an update string based on the data you supply, and runs the query. You can either pass an |
||||
<strong>array</strong> or an <strong>object</strong> to the function. Here is an example using an array:</p> |
||||
|
||||
<code> |
||||
$data = array(<br/> |
||||
array(<br /> |
||||
'title' => 'My title' ,<br /> |
||||
'name' => 'My Name 2' ,<br /> |
||||
'date' => 'My date 2'<br /> |
||||
),<br /> |
||||
array(<br /> |
||||
'title' => 'Another title' ,<br /> |
||||
'name' => 'Another Name 2' ,<br /> |
||||
'date' => 'Another date 2'<br /> |
||||
)<br/> |
||||
);<br /> |
||||
<br /> |
||||
$this->db->update_batch('mytable', $data, 'title'); |
||||
<br /><br /> |
||||
// Produces: <br /> |
||||
// UPDATE `mytable` SET `name` = CASE<br /> |
||||
// WHEN `title` = 'My title' THEN 'My Name 2'<br /> |
||||
// WHEN `title` = 'Another title' THEN 'Another Name 2'<br /> |
||||
// ELSE `name` END,<br /> |
||||
// `date` = CASE <br /> |
||||
// WHEN `title` = 'My title' THEN 'My date 2'<br /> |
||||
// WHEN `title` = 'Another title' THEN 'Another date 2'<br /> |
||||
// ELSE `date` END<br /> |
||||
// WHERE `title` IN ('My title','Another title')</code> |
||||
|
||||
<p>The first parameter will contain the table name, the second is an associative array of values, the third parameter is the where key.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> All values are escaped automatically producing safer queries.</p> |
||||
|
||||
|
||||
<a name="delete"> </a> |
||||
<h1>Deleting Data</h1> |
||||
|
||||
|
||||
|
||||
<h2>$this->db->delete();</h2> |
||||
<p>Generates a delete SQL string and runs the query.</p> |
||||
|
||||
<code> |
||||
$this->db->delete('mytable', array('id' => $id)); |
||||
<br /><br /> |
||||
// Produces:<br /> |
||||
// DELETE FROM mytable <br /> |
||||
// WHERE id = $id</code> |
||||
|
||||
<p>The first parameter is the table name, the second is the where clause. You can also use the <dfn>where()</dfn> or <dfn>or_where()</dfn> functions instead of passing |
||||
the data to the second parameter of the function:</p> |
||||
|
||||
<p><code> $this->db->where('id', $id);<br /> |
||||
$this->db->delete('mytable'); <br /> |
||||
<br /> |
||||
// Produces:<br /> |
||||
// DELETE FROM mytable <br /> |
||||
// WHERE id = $id</code></p> |
||||
<p>An array of table names can be passed into delete() if you would like to delete data from more than 1 table.</p> |
||||
<p><code>$tables = array('table1', 'table2', 'table3');<br /> |
||||
$this->db->where('id', '5');<br /> |
||||
$this->db->delete($tables);</code></p> |
||||
<p>If you want to delete all data from a table, you can use the <dfn>truncate()</dfn> function, or <dfn>empty_table()</dfn>.</p> |
||||
<h2>$this->db->empty_table();</h2> |
||||
<p>Generates a delete SQL string and runs the query.<code> $this->db->empty_table('mytable'); <br /> |
||||
<br /> |
||||
// Produces<br /> |
||||
// DELETE FROM mytable</code></p> |
||||
<h2>$this->db->truncate();</h2> |
||||
<p>Generates a truncate SQL string and runs the query.</p> |
||||
<code> $this->db->from('mytable'); <br /> |
||||
$this->db->truncate(); <br /> |
||||
// or <br /> |
||||
$this->db->truncate('mytable'); <br /> |
||||
<br /> |
||||
// Produce:<br /> |
||||
// TRUNCATE mytable <br /> |
||||
</code> |
||||
<p class="important"><strong>Note:</strong> If the TRUNCATE command isn't available, truncate() will execute as "DELETE FROM table".</p> |
||||
|
||||
<h1><a name="chaining"> </a>Method Chaining</h1> |
||||
|
||||
<p>Method chaining allows you to simplify your syntax by connecting multiple functions. Consider this example:</p> |
||||
|
||||
<code> |
||||
<dfn>$this->db</dfn><kbd>-></kbd><var>select</var>('title')<kbd>-></kbd><var>from</var>('mytable')<kbd>-></kbd><var>where</var>('id', $id)<kbd>-></kbd><var>limit</var>(10, 20);<br /> |
||||
<br /> |
||||
$query = $this->db->get();</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> Method chaining only works with PHP 5.</p> |
||||
|
||||
<p> </p> |
||||
|
||||
<h1><a name="caching"> </a>Active Record Caching</h1> |
||||
|
||||
<p>While not "true" caching, Active Record enables you to save (or "cache") certain parts of your queries for reuse at a later point in your script's execution. Normally, when an Active Record call is completed, all stored information is reset for the next call. With caching, you can prevent this reset, and reuse information easily.</p> |
||||
|
||||
<p>Cached calls are cumulative. If you make 2 cached select() calls, and then 2 uncached select() calls, this will result in 4 select() calls. There are three Caching functions available:</p> |
||||
|
||||
<h2>$this->db->start_cache()</h2> |
||||
|
||||
<p>This function must be called to begin caching. All Active Record queries of the correct type (see below for supported queries) are stored for later use.</p> |
||||
|
||||
<h2>$this->db->stop_cache()</h2> |
||||
|
||||
<p>This function can be called to stop caching.</p> |
||||
|
||||
<h2>$this->db->flush_cache()</h2> |
||||
|
||||
<p>This function deletes all items from the Active Record cache.</p> |
||||
|
||||
<p>Here's a usage example:</p> |
||||
|
||||
<p><code>$this->db->start_cache();<br /> |
||||
$this->db->select('field1');<br /> |
||||
$this->db->stop_cache();<br /><br /> |
||||
$this->db->get('tablename');<br /> |
||||
<br /> |
||||
//Generates: SELECT `field1` FROM (`tablename`)<br /> |
||||
<br /> |
||||
$this->db->select('field2');<br /> |
||||
$this->db->get('tablename');<br /> |
||||
<br /> |
||||
//Generates: SELECT `field1`, `field2` FROM (`tablename`)<br /> |
||||
<br /> |
||||
$this->db->flush_cache();<br /> |
||||
<br /> |
||||
$this->db->select('field2');<br /> |
||||
$this->db->get('tablename');<br /> |
||||
<br /> |
||||
//Generates: SELECT `field2` FROM (`tablename`)</code></p> |
||||
|
||||
<p class="important"> <strong>Note:</strong> The following statements can be cached: select, from, join, where, like, group_by, having, order_by, set</p> |
||||
<p> </p> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="helpers.html">Query Helper Functions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="transactions.html">Transactions</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,220 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Database Caching Class : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Database Caching Class |
||||
</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>Database Caching Class</h1> |
||||
|
||||
<p>The Database Caching Class permits you to cache your queries as text files for reduced database load.</p> |
||||
|
||||
<p class="important"><strong>Important:</strong> This class is initialized automatically by the database driver |
||||
when caching is enabled. Do NOT load this class manually.<br /><br /> |
||||
|
||||
<strong>Also note:</strong> Not all query result functions are available when you use caching. Please read this page carefully.</p> |
||||
|
||||
<h2>Enabling Caching</h2> |
||||
|
||||
<p>Caching is enabled in three steps:</p> |
||||
|
||||
<ul> |
||||
<li>Create a writable directory on your server where the cache files can be stored.</li> |
||||
<li>Set the path to your cache folder in your <dfn>application/config/database.php</dfn> file.</li> |
||||
<li>Enable the caching feature, either globally by setting the preference in your <dfn>application/config/database.php</dfn> file, or manually as described below.</li> |
||||
</ul> |
||||
|
||||
<p>Once enabled, caching will happen automatically whenever a page is loaded that contains database queries.</p> |
||||
|
||||
|
||||
<h2>How Does Caching Work?</h2> |
||||
|
||||
<p>CodeIgniter's query caching system happens dynamically when your pages are viewed. |
||||
When caching is enabled, the first time a web page is loaded, the query result object will |
||||
be serialized and stored in a text file on your server. The next time the page is loaded the cache file will be used instead of |
||||
accessing your database. Your database usage can effectively be reduced to zero for any pages that have been cached.</p> |
||||
|
||||
<p>Only <dfn>read-type</dfn> (SELECT) queries can be cached, since these are the only type of queries that produce a result. |
||||
<dfn>Write-type</dfn> (INSERT, UPDATE, etc.) queries, since they don't generate a result, will not be cached by the system.</p> |
||||
|
||||
<p>Cache files DO NOT expire. Any queries that have been cached will remain cached until you delete them. The caching system |
||||
permits you clear caches associated with individual pages, or you can delete the entire collection of cache files. |
||||
Typically you'll want to use the housekeeping functions described below to delete cache files after certain |
||||
events take place, like when you've added new information to your database.</p> |
||||
|
||||
<h2>Will Caching Improve Your Site's Performance?</h2> |
||||
|
||||
<p>Getting a performance gain as a result of caching depends on many factors. |
||||
If you have a highly optimized database under very little load, you probably won't see a performance boost. |
||||
If your database is under heavy use you probably will see an improved response, assuming your file-system is not |
||||
overly taxed. Remember that caching simply changes how your information is retrieved, shifting it from being a database |
||||
operation to a file-system one.</p> |
||||
|
||||
<p>In some clustered server environments, for example, caching may be detrimental since file-system operations are so intense. |
||||
On single servers in shared environments, caching will probably be beneficial. Unfortunately there is no |
||||
single answer to the question of whether you should cache your database. It really depends on your situation.</p> |
||||
|
||||
<h2>How are Cache Files Stored?</h2> |
||||
|
||||
<p>CodeIgniter places the result of EACH query into its own cache file. Sets of cache files are further organized into |
||||
sub-folders corresponding to your controller functions. To be precise, the sub-folders are named identically to the |
||||
first two segments of your URI (the controller class name and function name).</p> |
||||
|
||||
<p>For example, let's say you have a controller called <dfn>blog</dfn> with a function called <dfn>comments</dfn> that |
||||
contains three queries. The caching system will create a cache folder |
||||
called <kbd>blog+comments</kbd>, into which it will write three cache files.</p> |
||||
|
||||
<p>If you use dynamic queries that change based on information in your URI (when using pagination, for example), each instance of |
||||
the query will produce its own cache file. It's possible, therefore, to end up with many times more cache files than you have |
||||
queries.</p> |
||||
|
||||
|
||||
<h2>Managing your Cache Files</h2> |
||||
|
||||
<p>Since cache files do not expire, you'll need to build deletion routines into your application. For example, let's say you have a blog |
||||
that allows user commenting. Whenever a new comment is submitted you'll want to delete the cache files associated with the |
||||
controller function that serves up your comments. You'll find two delete functions described below that help you |
||||
clear data.</p> |
||||
|
||||
|
||||
<h2>Not All Database Functions Work with Caching</h2> |
||||
|
||||
<p>Lastly, we need to point out that the result object that is cached is a simplified version of the full result object. For that reason, |
||||
some of the query result functions are not available for use.</p> |
||||
|
||||
<p>The following functions <kbd>ARE NOT</kbd> available when using a cached result object:</p> |
||||
|
||||
<ul> |
||||
<li>num_fields()</li> |
||||
<li>field_names()</li> |
||||
<li>field_data()</li> |
||||
<li>free_result()</li> |
||||
</ul> |
||||
|
||||
<p>Also, the two database resources (result_id and conn_id) are not available when caching, since result resources only |
||||
pertain to run-time operations.</p> |
||||
|
||||
|
||||
<br /> |
||||
|
||||
<h1>Function Reference</h1> |
||||
|
||||
|
||||
|
||||
<h2>$this->db->cache_on() / $this->db->cache_off()</h2> |
||||
|
||||
<p>Manually enables/disables caching. This can be useful if you want to |
||||
keep certain queries from being cached. Example:</p> |
||||
|
||||
<code> |
||||
// Turn caching on<br /> |
||||
$this->db->cache_on();<br /> |
||||
$query = $this->db->query("SELECT * FROM mytable");<br /> |
||||
<br /> |
||||
// Turn caching off for this one query<br /> |
||||
$this->db->cache_off();<br /> |
||||
$query = $this->db->query("SELECT * FROM members WHERE member_id = '$current_user'");<br /> |
||||
<br /> |
||||
// Turn caching back on<br /> |
||||
$this->db->cache_on();<br /> |
||||
$query = $this->db->query("SELECT * FROM another_table"); |
||||
</code> |
||||
|
||||
|
||||
<h2>$this->db->cache_delete()</h2> |
||||
|
||||
<p>Deletes the cache files associated with a particular page. This is useful if you need to clear caching after you update your database.</p> |
||||
|
||||
<p>The caching system saves your cache files to folders that correspond to the URI of the page you are viewing. For example, if you are viewing |
||||
a page at <dfn>example.com/index.php/blog/comments</dfn>, the caching system will put all cache files associated with it in a folder |
||||
called <dfn>blog+comments</dfn>. To delete those particular cache files you will use:</p> |
||||
|
||||
<code>$this->db->cache_delete('blog', 'comments');</code> |
||||
|
||||
<p>If you do not use any parameters the current URI will be used when determining what should be cleared.</p> |
||||
|
||||
|
||||
<h2>$this->db->cache_delete_all()</h2> |
||||
|
||||
<p>Clears all existing cache files. Example:</p> |
||||
|
||||
<code>$this->db->cache_delete_all();</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="call_function.html">Custom Function Calls</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="forge.html">Database manipulation with Database Forge</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,118 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Custom Function Calls : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Custom Function Calls |
||||
</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>Custom Function Calls</h1> |
||||
|
||||
<h2>$this->db->call_function();</h2> |
||||
|
||||
<p>This function enables you to call PHP database functions that are not natively included in CodeIgniter, in a platform independent manner. |
||||
For example, lets say you want to call the <dfn>mysql_get_client_info()</dfn> function, which is <strong>not</strong> natively supported |
||||
by CodeIgniter. You could do so like this: |
||||
</p> |
||||
|
||||
<code>$this->db->call_function('<var>get_client_info</var>');</code> |
||||
|
||||
<p>You must supply the name of the function, <strong>without</strong> the <var>mysql_</var> prefix, in the first parameter. The prefix is added |
||||
automatically based on which database driver is currently being used. This permits you to run the same function on different database platforms. |
||||
Obviously not all function calls are identical between platforms, so there are limits to how useful this function can be in terms of portability.</p> |
||||
|
||||
<p>Any parameters needed by the function you are calling will be added to the second parameter.</p> |
||||
|
||||
<code>$this->db->call_function('<var>some_function</var>', $param1, $param2, etc..);</code> |
||||
|
||||
|
||||
<p>Often, you will either need to supply a database connection ID or a database result ID. The connection ID can be accessed using:</p> |
||||
|
||||
<code>$this->db->conn_id;</code> |
||||
|
||||
<p>The result ID can be accessed from within your result object, like this:</p> |
||||
|
||||
<code>$query = $this->db->query("SOME QUERY");<br /> |
||||
<br /> |
||||
<var>$query->result_id;</var></code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="fields.html">Field MetaData</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="caching.html">Query Caching</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,164 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Database Configuration : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Configuration |
||||
</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>Database Configuration</h1> |
||||
|
||||
<p>CodeIgniter has a config file that lets you store your database connection values (username, password, database name, etc.). |
||||
The config file is located at <samp>application/config/database.php</samp>. You can also set database connection values for specific <a href="../libraries/config.html">environments</a> by placing <strong>database.php</strong> it the respective environment config folder.</p> |
||||
|
||||
<p>The config settings are stored in a multi-dimensional array with this prototype:</p> |
||||
|
||||
<code>$db['default']['hostname'] = "localhost";<br /> |
||||
$db['default']['username'] = "root";<br /> |
||||
$db['default']['password'] = "";<br /> |
||||
$db['default']['database'] = "database_name";<br /> |
||||
$db['default']['dbdriver'] = "mysql";<br /> |
||||
$db['default']['dbprefix'] = "";<br /> |
||||
$db['default']['pconnect'] = TRUE;<br /> |
||||
$db['default']['db_debug'] = FALSE;<br /> |
||||
$db['default']['cache_on'] = FALSE;<br /> |
||||
$db['default']['cachedir'] = "";<br /> |
||||
$db['default']['char_set'] = "utf8";<br /> |
||||
$db['default']['dbcollat'] = "utf8_general_ci";<br /> |
||||
$db['default']['swap_pre'] = "";<br /> |
||||
$db['default']['autoinit'] = TRUE;<br /> |
||||
$db['default']['stricton'] = FALSE;</code> |
||||
|
||||
<p>The reason we use a multi-dimensional array rather than a more simple one is to permit you to optionally store |
||||
multiple sets of connection values. If, for example, you run multiple environments (development, production, test, etc.) |
||||
under a single installation, you can set up a connection group for each, then switch between groups as needed. |
||||
For example, to set up a "test" environment you would do this:</p> |
||||
|
||||
<code>$db['test']['hostname'] = "localhost";<br /> |
||||
$db['test']['username'] = "root";<br /> |
||||
$db['test']['password'] = "";<br /> |
||||
$db['test']['database'] = "database_name";<br /> |
||||
$db['test']['dbdriver'] = "mysql";<br /> |
||||
$db['test']['dbprefix'] = "";<br /> |
||||
$db['test']['pconnect'] = TRUE;<br /> |
||||
$db['test']['db_debug'] = FALSE;<br /> |
||||
$db['test']['cache_on'] = FALSE;<br /> |
||||
$db['test']['cachedir'] = "";<br /> |
||||
$db['test']['char_set'] = "utf8";<br /> |
||||
$db['test']['dbcollat'] = "utf8_general_ci";<br /> |
||||
$db['test']['swap_pre'] = "";<br /> |
||||
$db['test']['autoinit'] = TRUE;<br /> |
||||
$db['test']['stricton'] = FALSE;</code> |
||||
|
||||
|
||||
<p>Then, to globally tell the system to use that group you would set this variable located in the config file:</p> |
||||
|
||||
<code>$active_group = "test";</code> |
||||
|
||||
<p>Note: The name "test" is arbitrary. It can be anything you want. By default we've used the word "default" |
||||
for the primary connection, but it too can be renamed to something more relevant to your project.</p> |
||||
|
||||
<h3>Active Record</h3> |
||||
|
||||
<p>The <a href="active_record.html">Active Record Class</a> is globally enabled or disabled by setting the $active_record variable in the database configuration file to TRUE/FALSE (boolean). If you are not using the active record class, setting it to FALSE will utilize fewer resources when the database classes are initialized.</p> |
||||
|
||||
<code>$active_record = TRUE;</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> that some CodeIgniter classes such as Sessions require Active Records be enabled to access certain functionality.</p> |
||||
|
||||
<h3>Explanation of Values:</h3> |
||||
|
||||
<ul> |
||||
<li><strong>hostname</strong> - The hostname of your database server. Often this is "localhost".</li> |
||||
<li><strong>username</strong> - The username used to connect to the database.</li> |
||||
<li><strong>password</strong> - The password used to connect to the database.</li> |
||||
<li><strong>database</strong> - The name of the database you want to connect to.</li> |
||||
<li><strong>dbdriver</strong> - The database type. ie: mysql, postgres, odbc, etc. Must be specified in lower case.</li> |
||||
<li><strong>dbprefix</strong> - An optional table prefix which will added to the table name when running <a href="active_record.html">Active Record</a> queries. This permits multiple CodeIgniter installations to share one database.</li> |
||||
<li><strong>pconnect</strong> - TRUE/FALSE (boolean) - Whether to use a persistent connection.</li> |
||||
<li><strong>db_debug</strong> - TRUE/FALSE (boolean) - Whether database errors should be displayed.</li> |
||||
<li><strong>cache_on</strong> - TRUE/FALSE (boolean) - Whether database query caching is enabled, see also <a href="caching.html">Database Caching Class</a>.</li> |
||||
<li><strong>cachedir</strong> - The absolute server path to your database query cache directory.</li> |
||||
<li><strong>char_set</strong> - The character set used in communicating with the database.</li> |
||||
<li><strong>dbcollat</strong> - The character collation used in communicating with the database. <p class="important"><strong>Note:</strong> For MySQL and MySQLi databases, this setting is only used as a backup if your server is running PHP < 5.2.3 or MySQL < 5.0.7 (and in table creation queries made with DB Forge). There is an incompatibility in PHP with mysql_real_escape_string() which can make your site vulnerable to SQL injection if you are using a multi-byte character set and are running versions lower than these. Sites using Latin-1 or UTF-8 database character set and collation are unaffected.</p></li> |
||||
<li><strong>swap_pre</strong> - A default table prefix that should be swapped with <var>dbprefix</var>. This is useful for distributed applications where you might run manually written queries, and need the prefix to still be customizable by the end user.</li> |
||||
<li><strong>autoinit</strong> - Whether or not to automatically connect to the database when the library loads. If set to false, the connection will take place prior to executing the first query.</li> |
||||
<li><strong>stricton</strong> - TRUE/FALSE (boolean) - Whether to force "Strict Mode" connections, good for ensuring strict SQL while developing an application.</li> |
||||
<li><strong>port</strong> - The database port number. To use this value you have to add a line to the database config array.<code>$db['default']['port'] = 5432;</code> |
||||
</ul> |
||||
|
||||
<p class="important"><strong>Note:</strong> Depending on what database platform you are using (MySQL, Postgres, etc.) |
||||
not all values will be needed. For example, when using SQLite you will not need to supply a username or password, and |
||||
the database name will be the path to your database file. The information above assumes you are using MySQL.</p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="examples.html">Quick Start: Usage Examples</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="connecting.html">Connecting to your Database</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,188 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Connecting to your Database : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Connecting |
||||
</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>Connecting to your Database</h1> |
||||
|
||||
<p>There are two ways to connect to a database:</p> |
||||
|
||||
<h2>Automatically Connecting</h2> |
||||
|
||||
<p>The "auto connect" feature will load and instantiate the database class with every page load. |
||||
To enable "auto connecting", add the word <var>database</var> to the library array, as indicated in the following file:</p> |
||||
|
||||
<p><kbd>application/config/autoload.php</kbd></p> |
||||
|
||||
<h2>Manually Connecting</h2> |
||||
|
||||
<p>If only some of your pages require database connectivity you can manually connect to your database by adding this |
||||
line of code in any function where it is needed, or in your class constructor to make the database |
||||
available globally in that class.</p> |
||||
|
||||
<code>$this->load->database();</code> |
||||
|
||||
<p class="important">If the above function does <strong>not</strong> contain any information in the first parameter it will connect |
||||
to the group specified in your database config file. For most people, this is the preferred method of use.</p> |
||||
|
||||
<h3>Available Parameters</h3> |
||||
|
||||
<ol> |
||||
<li>The database connection values, passed either as an array or a DSN string.</li> |
||||
<li>TRUE/FALSE (boolean). Whether to return the connection ID (see Connecting to Multiple Databases below).</li> |
||||
<li>TRUE/FALSE (boolean). Whether to enable the Active Record class. Set to TRUE by default.</li> |
||||
</ol> |
||||
|
||||
|
||||
<h3>Manually Connecting to a Database</h3> |
||||
|
||||
<p>The first parameter of this function can <strong>optionally</strong> be used to specify a particular database group |
||||
from your config file, or you can even submit connection values for a database that is not specified in your config file. |
||||
Examples:</p> |
||||
|
||||
<p>To choose a specific group from your config file you can do this:</p> |
||||
|
||||
<code>$this->load->database('<samp>group_name</samp>');</code> |
||||
|
||||
<p>Where <samp>group_name</samp> is the name of the connection group from your config file.</p> |
||||
|
||||
|
||||
<p>To connect manually to a desired database you can pass an array of values:</p> |
||||
|
||||
<code>$config['hostname'] = "localhost";<br /> |
||||
$config['username'] = "myusername";<br /> |
||||
$config['password'] = "mypassword";<br /> |
||||
$config['database'] = "mydatabase";<br /> |
||||
$config['dbdriver'] = "mysql";<br /> |
||||
$config['dbprefix'] = "";<br /> |
||||
$config['pconnect'] = FALSE;<br /> |
||||
$config['db_debug'] = TRUE;<br /> |
||||
$config['cache_on'] = FALSE;<br /> |
||||
$config['cachedir'] = "";<br /> |
||||
$config['char_set'] = "utf8";<br /> |
||||
$config['dbcollat'] = "utf8_general_ci";<br /> |
||||
<br /> |
||||
$this->load->database(<samp>$config</samp>);</code> |
||||
|
||||
<p>For information on each of these values please see the <a href="configuration.html">configuration page</a>.</p> |
||||
|
||||
<p>Or you can submit your database values as a Data Source Name. DSNs must have this prototype:</p> |
||||
|
||||
<code>$dsn = 'dbdriver://username:password@hostname/database';<br /> |
||||
<br /> |
||||
$this->load->database(<samp>$dsn</samp>);</code> |
||||
|
||||
<p>To override default config values when connecting with a DSN string, add the config variables as a query string.</p> |
||||
|
||||
<code>$dsn = 'dbdriver://username:password@hostname/database?char_set=utf8&dbcollat=utf8_general_ci&cache_on=true&cachedir=/path/to/cache';<br /> |
||||
<br /> |
||||
$this->load->database(<samp>$dsn</samp>);</code> |
||||
|
||||
<h2>Connecting to Multiple Databases</h2> |
||||
|
||||
<p>If you need to connect to more than one database simultaneously you can do so as follows:</p> |
||||
|
||||
|
||||
<code>$DB1 = $this->load->database('group_one', TRUE);<br /> |
||||
$DB2 = $this->load->database('group_two', TRUE); |
||||
</code> |
||||
|
||||
<p>Note: Change the words "group_one" and "group_two" to the specific group names you are connecting to (or |
||||
you can pass the connection values as indicated above).</p> |
||||
|
||||
<p>By setting the second parameter to TRUE (boolean) the function will return the database object.</p> |
||||
|
||||
<div class="important"> |
||||
<p>When you connect this way, you will use your object name to issue commands rather than the syntax used throughout this guide. In other words, rather than issuing commands with:</p> |
||||
|
||||
<p>$this->db->query();<br />$this->db->result();<br /> etc...</p> |
||||
|
||||
<p>You will instead use:</p> |
||||
|
||||
<p>$DB1->query();<br />$DB1->result();<br /> etc...</p> |
||||
|
||||
</div> |
||||
|
||||
<h2>Reconnecting / Keeping the Connection Alive</h2> |
||||
|
||||
<p>If the database server's idle timeout is exceeded while you're doing some heavy PHP lifting (processing an image, for instance), you should consider pinging the server by using the <dfn>reconnect()</dfn> method before sending further queries, which can gracefully keep the connection alive or re-establish it.</p> |
||||
|
||||
<code>$this->db->reconnect();</code> |
||||
|
||||
<h2>Manually closing the Connection</h2> |
||||
|
||||
<p>While CodeIgniter intelligently takes care of closing your database connections, you can explicitly close the connection.</p> |
||||
|
||||
<code>$this->db->close();</code> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="configuration.html">Database Configuration</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="queries.html">Queries</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,217 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Database Quick Start : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Database Example Code |
||||
</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>Database Quick Start: Example Code</h1> |
||||
|
||||
<p>The following page contains example code showing how the database class is used. For complete details please |
||||
read the individual pages describing each function.</p> |
||||
|
||||
|
||||
<h2>Initializing the Database Class</h2> |
||||
|
||||
<p>The following code loads and initializes the database class based on your <a href="configuration.html">configuration</a> settings:</p> |
||||
|
||||
<code>$this->load->database();</code> |
||||
|
||||
<p>Once loaded the class is ready to be used as described below.</p> |
||||
|
||||
<p>Note: If all your pages require database access you can connect automatically. See the <a href="connecting.html">connecting</a> page for details.</p> |
||||
|
||||
|
||||
<h2>Standard Query With Multiple Results (Object Version)</h2> |
||||
|
||||
<code>$query = $this->db->query('SELECT name, title, email FROM my_table');<br /> |
||||
<br /> |
||||
foreach ($query->result() as $row)<br /> |
||||
{<br /> |
||||
echo $row->title;<br /> |
||||
echo $row->name;<br /> |
||||
echo $row->email;<br /> |
||||
}<br /> |
||||
<br /> |
||||
echo 'Total Results: ' . $query->num_rows(); |
||||
</code> |
||||
|
||||
<p>The above <dfn>result()</dfn> function returns an array of <strong>objects</strong>. Example: $row->title</p> |
||||
|
||||
|
||||
<h2>Standard Query With Multiple Results (Array Version)</h2> |
||||
|
||||
<code>$query = $this->db->query('SELECT name, title, email FROM my_table');<br /> |
||||
<br /> |
||||
foreach ($query->result_array() as $row)<br /> |
||||
{<br /> |
||||
echo $row['title'];<br /> |
||||
echo $row['name'];<br /> |
||||
echo $row['email'];<br /> |
||||
}</code> |
||||
|
||||
<p>The above <dfn>result_array()</dfn> function returns an array of standard array indexes. Example: $row['title']</p> |
||||
|
||||
|
||||
<h2>Testing for Results</h2> |
||||
|
||||
<p>If you run queries that might <strong>not</strong> produce a result, you are encouraged to test for a result first |
||||
using the <dfn>num_rows()</dfn> function:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query("YOUR QUERY");<br /> |
||||
<br /> |
||||
if ($query->num_rows() > 0)<br /> |
||||
{<br /> |
||||
foreach ($query->result() as $row)<br /> |
||||
{<br /> |
||||
echo $row->title;<br /> |
||||
echo $row->name;<br /> |
||||
echo $row->body;<br /> |
||||
}<br /> |
||||
} |
||||
</code> |
||||
|
||||
|
||||
|
||||
|
||||
<h2>Standard Query With Single Result</h2> |
||||
|
||||
<code>$query = $this->db->query('SELECT name FROM my_table LIMIT 1');<br /> |
||||
<br /> |
||||
$row = $query->row();<br /> |
||||
echo $row->name;<br /> |
||||
</code> |
||||
|
||||
<p>The above <dfn>row()</dfn> function returns an <strong>object</strong>. Example: $row->name</p> |
||||
|
||||
|
||||
<h2>Standard Query With Single Result (Array version)</h2> |
||||
|
||||
<code>$query = $this->db->query('SELECT name FROM my_table LIMIT 1');<br /> |
||||
<br /> |
||||
$row = $query->row_array();<br /> |
||||
echo $row['name'];<br /> |
||||
</code> |
||||
|
||||
<p>The above <dfn>row_array()</dfn> function returns an <strong>array</strong>. Example: $row['name']</p> |
||||
|
||||
|
||||
<h2>Standard Insert</h2> |
||||
|
||||
<code> |
||||
$sql = "INSERT INTO mytable (title, name) <br /> |
||||
VALUES (".$this->db->escape($title).", ".$this->db->escape($name).")";<br /> |
||||
<br /> |
||||
$this->db->query($sql);<br /> |
||||
<br /> |
||||
echo $this->db->affected_rows(); |
||||
</code> |
||||
|
||||
|
||||
|
||||
|
||||
<h2>Active Record Query</h2> |
||||
|
||||
<p>The <a href="active_record.html">Active Record Pattern</a> gives you a simplified means of retrieving data:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->get('table_name');<br /> |
||||
<br /> |
||||
foreach ($query->result() as $row)<br /> |
||||
{<br /> |
||||
echo $row->title;<br /> |
||||
}</code> |
||||
|
||||
<p>The above <dfn>get()</dfn> function retrieves all the results from the supplied table. |
||||
The <a href="active_record.html">Active Record</a> class contains a full compliment of functions |
||||
for working with data.</p> |
||||
|
||||
|
||||
<h2>Active Record Insert</h2> |
||||
|
||||
<code> |
||||
$data = array(<br /> |
||||
'title' => $title,<br /> |
||||
'name' => $name,<br /> |
||||
'date' => $date<br /> |
||||
);<br /> |
||||
<br /> |
||||
$this->db->insert('mytable', $data); |
||||
<br /><br /> |
||||
// Produces: INSERT INTO mytable (title, name, date) VALUES ('{$title}', '{$name}', '{$date}')</code> |
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Database Class</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="configuration.html">Database Configuration</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,163 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Field Data : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Field Names |
||||
</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>Field Data</h1> |
||||
|
||||
|
||||
<h2>$this->db->list_fields()</h2> |
||||
<p>Returns an array containing the field names. This query can be called two ways:</p> |
||||
|
||||
|
||||
<p>1. You can supply the table name and call it from the <dfn>$this->db-></dfn> object:</p> |
||||
|
||||
<code> |
||||
$fields = $this->db->list_fields('table_name');<br /><br /> |
||||
|
||||
foreach ($fields as $field)<br /> |
||||
{<br /> |
||||
echo $field;<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p>2. You can gather the field names associated with any query you run by calling the function |
||||
from your query result object:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query('SELECT * FROM some_table'); |
||||
<br /><br /> |
||||
|
||||
foreach ($query->list_fields() as $field)<br /> |
||||
{<br /> |
||||
echo $field;<br /> |
||||
} |
||||
</code> |
||||
|
||||
|
||||
<h2>$this->db->field_exists()</h2> |
||||
|
||||
<p>Sometimes it's helpful to know whether a particular field exists before performing an action. |
||||
Returns a boolean TRUE/FALSE. Usage example:</p> |
||||
|
||||
<code> |
||||
if ($this->db->field_exists('field_name', 'table_name'))<br /> |
||||
{<br /> |
||||
// some code...<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p>Note: Replace <em>field_name</em> with the name of the column you are looking for, and replace |
||||
<em>table_name</em> with the name of the table you are looking for.</p> |
||||
|
||||
|
||||
<h2>$this->db->field_data()</h2> |
||||
<p>Returns an array of objects containing field information.</p> |
||||
<p>Sometimes it's helpful to gather the field names or other metadata, like the column type, max length, etc.</p> |
||||
|
||||
|
||||
<p class="important">Note: Not all databases provide meta-data.</p> |
||||
|
||||
<p>Usage example:</p> |
||||
|
||||
<code> |
||||
$fields = $this->db->field_data('table_name');<br /><br /> |
||||
|
||||
foreach ($fields as $field)<br /> |
||||
{<br /> |
||||
echo $field->name;<br /> |
||||
echo $field->type;<br /> |
||||
echo $field->max_length;<br /> |
||||
echo $field->primary_key;<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p>If you have run a query already you can use the result object instead of supplying the table name:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query("YOUR QUERY");<br /> |
||||
$fields = $query->field_data(); |
||||
</code> |
||||
|
||||
|
||||
<p>The following data is available from this function if supported by your database:</p> |
||||
|
||||
<ul> |
||||
<li>name - column name</li> |
||||
<li>max_length - maximum length of the column</li> |
||||
<li>primary_key - 1 if the column is a primary key</li> |
||||
<li>type - the type of the column</li> |
||||
</ul> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="table_data.html"> Table Data</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="call_function.html">Custom Function Calls</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,234 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Database Forge Class : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Database Forge Class |
||||
</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>Database Forge Class</h1> |
||||
|
||||
<p>The Database Forge Class contains functions that help you manage your database.</p> |
||||
|
||||
<h3>Table of Contents</h3> |
||||
|
||||
<ul> |
||||
<li><a href="#init">Initializing the Forge Class</a></li> |
||||
<li><a href="#create">Creating a Database</a></li> |
||||
<li><a href="#drop">Dropping a Database</a></li> |
||||
<li><a href="#add_field">Adding Fields</a></li> |
||||
<li><a href="#add_key">Adding Keys</a></li> |
||||
<li><a href="#create_table">Creating a Table</a></li> |
||||
<li><a href="#drop_table">Dropping a Table</a></li> |
||||
<li><a href="#rename_table">Renaming a Table</a></li> |
||||
<li><a href="#modifying_tables">Modifying a Table</a></li> |
||||
</ul> |
||||
|
||||
|
||||
<h2><a name="init"></a>Initializing the Forge Class</h2> |
||||
|
||||
<p class="important"><strong>Important:</strong> In order to initialize the Forge class, your database driver must |
||||
already be running, since the forge class relies on it.</p> |
||||
|
||||
<p>Load the Forge Class as follows:</p> |
||||
|
||||
<code>$this->load->dbforge()</code> |
||||
|
||||
<p>Once initialized you will access the functions using the <dfn>$this->dbforge</dfn> object:</p> |
||||
|
||||
<code>$this->dbforge->some_function()</code> |
||||
<h2><a name="create"></a>$this->dbforge->create_database('db_name')</h2> |
||||
|
||||
<p>Permits you to create the database specified in the first parameter. Returns TRUE/FALSE based on success or failure:</p> |
||||
|
||||
<code>if ($this->dbforge->create_database('my_db'))<br /> |
||||
{<br /> |
||||
echo 'Database created!';<br /> |
||||
}</code> |
||||
|
||||
|
||||
|
||||
|
||||
<h2><a name="drop"></a>$this->dbforge->drop_database('db_name')</h2> |
||||
|
||||
<p>Permits you to drop the database specified in the first parameter. Returns TRUE/FALSE based on success or failure:</p> |
||||
|
||||
<code>if ($this->dbforge->drop_database('my_db'))<br /> |
||||
{<br /> |
||||
echo 'Database deleted!';<br /> |
||||
}</code> |
||||
|
||||
|
||||
<h1>Creating and Dropping Tables</h1> |
||||
<p>There are several things you may wish to do when creating tables. Add fields, add keys to the table, alter columns. CodeIgniter provides a mechanism for this.</p> |
||||
<h2><a name="add_field" id="add_field"></a>Adding fields</h2> |
||||
<p>Fields are created via an associative array. Within the array you must include a 'type' key that relates to the datatype of the field. For example, INT, VARCHAR, TEXT, etc. Many datatypes (for example VARCHAR) also require a 'constraint' key.</p> |
||||
<p><code>$fields = array(<br /> |
||||
'users' => array(<br /> |
||||
'type' => 'VARCHAR',<br /> |
||||
'constraint' => '100',<br /> |
||||
),<br /> |
||||
);<br /> |
||||
<br /> |
||||
// will translate to "users VARCHAR(100)" when the field is added.</code></p> |
||||
<p>Additionally, the following key/values can be used:</p> |
||||
<ul> |
||||
<li>unsigned/true : to generate "UNSIGNED" in the field definition.</li> |
||||
<li>default/value : to generate a default value in the field definition.</li> |
||||
<li>null/true : to generate "NULL" in the field definition. Without this, the field will default to "NOT NULL".</li> |
||||
<li>auto_increment/true : generates an auto_increment flag on the field. Note that the field type must be a type that supports this, such as integer.</li> |
||||
</ul> |
||||
<p><code>$fields = array(<br /> |
||||
'blog_id' => array(<br /> |
||||
'type' => 'INT',<br /> |
||||
'constraint' => 5, <br /> |
||||
'unsigned' => TRUE,<br /> |
||||
'auto_increment' => TRUE<br /> |
||||
),<br /> |
||||
'blog_title' => array(<br /> |
||||
'type' => 'VARCHAR',<br /> |
||||
'constraint' => '100',<br /> |
||||
),<br /> |
||||
'blog_author' => array(<br /> |
||||
'type' =>'VARCHAR',<br /> |
||||
'constraint' => '100',<br /> |
||||
'default' => 'King of Town',<br /> |
||||
),<br /> |
||||
'blog_description' => array(<br /> |
||||
'type' => 'TEXT',<br /> |
||||
'null' => TRUE,<br /> |
||||
),<br /> |
||||
);<br /> |
||||
</code></p> |
||||
<p>After the fields have been defined, they can be added using <dfn>$this->dbforge->add_field($fields);</dfn> followed by a call to the <dfn>create_table()</dfn> function.</p> |
||||
<h3>$this->dbforge->add_field()</h3> |
||||
<p>The add fields function will accept the above array.</p> |
||||
<h3>Passing strings as fields</h3> |
||||
<p>If you know exactly how you want a field to be created, you can pass the string into the field definitions with add_field()</p> |
||||
<p><code>$this->dbforge->add_field("label varchar(100) NOT NULL DEFAULT 'default label'");</code></p> |
||||
<p class="important">Note: Multiple calls to <dfn>add_field()</dfn> are cumulative.</p> |
||||
<h3>Creating an id field</h3> |
||||
<p>There is a special exception for creating id fields. A field with type id will automatically be assinged as an INT(9) auto_incrementing Primary Key.</p> |
||||
<p><code>$this->dbforge->add_field('id');<br /> |
||||
// gives id INT(9) NOT NULL AUTO_INCREMENT</code></p> |
||||
<h2><a name="add_key" id="add_key"></a>Adding Keys</h2> |
||||
<p>Generally speaking, you'll want your table to have Keys. This is accomplished with <dfn>$this->dbforge->add_key('field')</dfn>. An optional second parameter set to TRUE will make it a primary key. Note that <dfn>add_key()</dfn> must be followed by a call to <dfn>create_table()</dfn>.</p> |
||||
<p>Multiple column non-primary keys must be sent as an array. Sample output below is for MySQL.</p> |
||||
<p><code>$this->dbforge->add_key('blog_id', TRUE);<br /> |
||||
// gives PRIMARY KEY `blog_id` (`blog_id`)<br /> |
||||
<br /> |
||||
$this->dbforge->add_key('blog_id', TRUE);<br /> |
||||
$this->dbforge->add_key('site_id', TRUE);<br /> |
||||
// gives PRIMARY KEY `blog_id_site_id` (`blog_id`, `site_id`)<br /> |
||||
<br /> |
||||
$this->dbforge->add_key('blog_name');<br /> |
||||
// gives KEY `blog_name` (`blog_name`)<br /> |
||||
<br /> |
||||
$this->dbforge->add_key(array('blog_name', 'blog_label'));<br /> |
||||
// gives KEY `blog_name_blog_label` (`blog_name`, `blog_label`)</code></p> |
||||
<h2><a name="create_table" id="create_table"></a>Creating a table</h2> |
||||
<p>After fields and keys have been declared, you can create a new table with</p> |
||||
<p><code>$this->dbforge->create_table('table_name');<br /> |
||||
// gives CREATE TABLE table_name</code></p> |
||||
<p>An optional second parameter set to TRUE adds an "IF NOT EXISTS" clause into the definition</p> |
||||
<p><code>$this->dbforge->create_table('table_name', TRUE);<br /> |
||||
// gives CREATE TABLE IF NOT EXISTS table_name</code></p> |
||||
<h2><a name="drop_table" id="drop_table"></a>Dropping a table</h2> |
||||
<p>Executes a DROP TABLE sql</p> |
||||
<p><code>$this->dbforge->drop_table('table_name');<br /> |
||||
// gives DROP TABLE IF EXISTS table_name</code></p> |
||||
<h2><a name="rename_table" id="rename_table"></a>Renaming a table</h2> |
||||
<p>Executes a TABLE rename</p> |
||||
<p><code>$this->dbforge->rename_table('old_table_name', 'new_table_name');<br /> |
||||
// gives ALTER TABLE old_table_name RENAME TO new_table_name</code></p> |
||||
<h1><a name="modifying_tables" id="modifying_tables"></a>Modifying Tables</h1> |
||||
<h2>$this->dbforge->add_column()</h2> |
||||
<p>The add_column() function is used to modify an existing table. It accepts the same field array as above, and can be used for an unlimited number of additional fields.</p> |
||||
<p><code>$fields = array(<br /> |
||||
'preferences' => array('type' => 'TEXT')<br /> |
||||
);<br /> |
||||
$this->dbforge->add_column('table_name', $fields);<br /> |
||||
<br /> |
||||
// gives ALTER TABLE table_name ADD preferences TEXT</code></p> |
||||
<h2>$this->dbforge->drop_column()</h2> |
||||
<p>Used to remove a column from a table. </p> |
||||
<p><code>$this->dbforge->drop_column('table_name', 'column_to_drop');</code></p> |
||||
<h2>$this->dbforge->modify_column()</h2> |
||||
<p>The usage of this function is identical to add_column(), except it alters an existing column rather than adding a new one. In order to change the name you can add a "name" key into the field defining array.</p> |
||||
<p><code>$fields = array(<br /> |
||||
'old_name' => array(<br /> |
||||
'name' => 'new_name',<br /> |
||||
'type' => 'TEXT',<br /> |
||||
),<br /> |
||||
);<br /> |
||||
$this->dbforge->modify_column('table_name', $fields);<br /> |
||||
<br /> |
||||
// gives ALTER TABLE table_name CHANGE old_name new_name TEXT </code></p> |
||||
<p> </p> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="caching.html">DB Caching Class</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="utilities.html">Database Utilities Class</a><a href="../libraries/email.html"></a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,151 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Query Helper 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Query Helpers |
||||
</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>Query Helper Functions</h1> |
||||
|
||||
|
||||
<h2>$this->db->insert_id()</h2> |
||||
<p>The insert ID number when performing database inserts.</p> |
||||
|
||||
<h2>$this->db->affected_rows()</h2> |
||||
<p>Displays the number of affected rows, when doing "write" type queries (insert, update, etc.).</p> |
||||
<p>Note: In MySQL "DELETE FROM TABLE" returns 0 affected rows. The database class has a small hack that allows it to return the |
||||
correct number of affected rows. By default this hack is enabled but it can be turned off in the database driver file.</p> |
||||
|
||||
|
||||
<h2>$this->db->count_all();</h2> |
||||
<p>Permits you to determine the number of rows in a particular table. Submit the table name in the first parameter. Example:</p> |
||||
<code>echo $this->db->count_all('<var>my_table</var>');<br /> |
||||
<br /> |
||||
// Produces an integer, like 25 |
||||
</code> |
||||
|
||||
|
||||
<h2>$this->db->platform()</h2> |
||||
<p>Outputs the database platform you are running (MySQL, MS SQL, Postgres, etc...):</p> |
||||
<code>echo $this->db->platform();</code> |
||||
|
||||
|
||||
<h2>$this->db->version()</h2> |
||||
<p>Outputs the database version you are running:</p> |
||||
<code>echo $this->db->version();</code> |
||||
|
||||
|
||||
<h2>$this->db->last_query();</h2> |
||||
<p>Returns the last query that was run (the query string, not the result). Example:</p> |
||||
|
||||
<code>$str = $this->db->last_query();<br /> |
||||
<br /> |
||||
// Produces: SELECT * FROM sometable.... |
||||
</code> |
||||
|
||||
|
||||
<p>The following two functions help simplify the process of writing database INSERTs and UPDATEs.</p> |
||||
|
||||
|
||||
<h2>$this->db->insert_string(); </h2> |
||||
<p>This function simplifies the process of writing database inserts. It returns a correctly formatted SQL insert string. Example:</p> |
||||
|
||||
<code>$data = array('name' => $name, 'email' => $email, 'url' => $url);<br /> |
||||
<br /> |
||||
$str = $this->db->insert_string('table_name', $data); |
||||
</code> |
||||
|
||||
<p>The first parameter is the table name, the second is an associative array with the data to be inserted. The above example produces:</p> |
||||
<code>INSERT INTO table_name (name, email, url) VALUES ('Rick', '[email protected]', 'example.com')</code> |
||||
|
||||
<p class="important">Note: Values are automatically escaped, producing safer queries.</p> |
||||
|
||||
|
||||
|
||||
<h2>$this->db->update_string(); </h2> |
||||
<p>This function simplifies the process of writing database updates. It returns a correctly formatted SQL update string. Example:</p> |
||||
|
||||
<code>$data = array('name' => $name, 'email' => $email, 'url' => $url);<br /> |
||||
<br /> |
||||
$where = "author_id = 1 AND status = 'active'"; |
||||
<br /><br /> |
||||
$str = $this->db->update_string('table_name', $data, $where); |
||||
</code> |
||||
|
||||
<p>The first parameter is the table name, the second is an associative array with the data to be updated, and the third parameter is the "where" clause. The above example produces:</p> |
||||
<code> UPDATE table_name SET name = 'Rick', email = '[email protected]', url = 'example.com' WHERE author_id = 1 AND status = 'active'</code> |
||||
|
||||
<p class="important">Note: Values are automatically escaped, producing safer queries.</p> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="results.html">Query Results</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="active_record.html">Active Record Pattern</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,99 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>The Database Class : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Database Library |
||||
</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>The Database Class</h1> |
||||
|
||||
<p>CodeIgniter comes with a full-featured and very fast abstracted database class that supports both traditional |
||||
structures and Active Record patterns. The database functions offer clear, simple syntax.</p> |
||||
|
||||
<ul> |
||||
<li><a href="examples.html">Quick Start: Usage Examples</a></li> |
||||
<li><a href="configuration.html">Database Configuration</a></li> |
||||
<li><a href="connecting.html">Connecting to a Database</a></li> |
||||
<li><a href="queries.html">Running Queries</a></li> |
||||
<li><a href="results.html">Generating Query Results</a></li> |
||||
<li><a href="helpers.html">Query Helper Functions</a></li> |
||||
<li><a href="active_record.html">Active Record Class</a></li> |
||||
<li><a href="transactions.html">Transactions</a></li> |
||||
<li><a href="table_data.html">Table MetaData</a></li> |
||||
<li><a href="fields.html">Field MetaData</a></li> |
||||
<li><a href="call_function.html">Custom Function Calls</a></li> |
||||
<li><a href="caching.html">Query Caching</a></li> |
||||
<li><a href="forge.html">Database manipulation with Database Forge</a></li> |
||||
<li><a href="utilities.html">Database Utilities Class</a></li> |
||||
</ul> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="../libraries/caching.html">Caching Class</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="examples.html">Quick Start: Usage Examples</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,158 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Queries : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Queries |
||||
</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>Queries</h1> |
||||
|
||||
<h2>$this->db->query();</h2> |
||||
|
||||
<p>To submit a query, use the following function:</p> |
||||
|
||||
<code>$this->db->query('YOUR QUERY HERE');</code> |
||||
|
||||
<p>The <dfn>query()</dfn> function returns a database result <strong>object</strong> when "read" type queries are run, |
||||
which you can use to <a href="results.html">show your results</a>. When "write" type queries are run it simply returns TRUE or FALSE |
||||
depending on success or failure. When retrieving data you will typically assign the query to your own variable, like this:</p> |
||||
|
||||
<code><var>$query</var> = $this->db->query('YOUR QUERY HERE');</code> |
||||
|
||||
<h2>$this->db->simple_query();</h2> |
||||
|
||||
<p>This is a simplified version of the <dfn>$this->db->query()</dfn> function. It ONLY returns TRUE/FALSE on success or failure. |
||||
It DOES NOT return a database result set, nor does it set the query timer, or compile bind data, or store your query for debugging. |
||||
It simply lets you submit a query. Most users will rarely use this function.</p> |
||||
|
||||
|
||||
<h1>Working with Database prefixes manually</h1> |
||||
<p>If you have configured a database prefix and would like to prepend it to a table name for use in a native SQL query for example, then you can use the following:</p> |
||||
<p><code>$this->db->dbprefix('tablename');<br /> |
||||
// outputs prefix_tablename</code></p> |
||||
|
||||
<p>If for any reason you would like to change the prefix programatically without needing to create a new connection, you can use this method:</p> |
||||
<p><code>$this->db->set_dbprefix('newprefix');<br /><br /> |
||||
$this->db->dbprefix('tablename');<br /> |
||||
// outputs newprefix_tablename</code></p> |
||||
|
||||
|
||||
<h1>Protecting identifiers</h1> |
||||
<p>In many databases it is advisable to protect table and field names - for example with backticks in MySQL. <strong>Active Record queries are automatically protected</strong>, however if you need to manually protect an identifier you can use:</p> |
||||
<p><code>$this->db->protect_identifiers('table_name');</code></p> |
||||
|
||||
<p>This function will also add a table prefix to your table, assuming you have a prefix specified in your database config file. To enable the prefixing set <kbd>TRUE</kbd> (boolen) via the second parameter:</p> |
||||
<p><code>$this->db->protect_identifiers('table_name', <kbd>TRUE</kbd>);</code></p> |
||||
|
||||
|
||||
<h1>Escaping Queries</h1> |
||||
<p>It's a very good security practice to escape your data before submitting it into your database. |
||||
CodeIgniter has three methods that help you do this:</p> |
||||
|
||||
<ol> |
||||
<li><strong>$this->db->escape()</strong> This function determines the data type so that it |
||||
can escape only string data. It also automatically adds single quotes around the data so you don't have to: |
||||
|
||||
<code>$sql = "INSERT INTO table (title) VALUES(".$this->db->escape($title).")";</code></li> |
||||
|
||||
<li><strong>$this->db->escape_str()</strong> This function escapes the data passed to it, regardless of type. |
||||
Most of the time you'll use the above function rather than this one. Use the function like this: |
||||
|
||||
<code>$sql = "INSERT INTO table (title) VALUES('".$this->db->escape_str($title)."')";</code></li> |
||||
|
||||
<li><strong>$this->db->escape_like_str()</strong> This method should be used when strings are to be used in LIKE |
||||
conditions so that LIKE wildcards ('%', '_') in the string are also properly escaped. |
||||
|
||||
<code>$search = '20% raise';<br /> |
||||
$sql = "SELECT id FROM table WHERE column LIKE '%".$this->db->escape_like_str($search)."%'";</code></li> |
||||
|
||||
</ol> |
||||
|
||||
|
||||
<h1>Query Bindings</h1> |
||||
|
||||
|
||||
<p>Bindings enable you to simplify your query syntax by letting the system put the queries together for you. Consider the following example:</p> |
||||
|
||||
<code> |
||||
$sql = "SELECT * FROM some_table WHERE id = <var>?</var> AND status = <var>?</var> AND author = <var>?</var>"; |
||||
<br /><br /> |
||||
$this->db->query($sql, array(3, 'live', 'Rick')); |
||||
</code> |
||||
|
||||
<p>The question marks in the query are automatically replaced with the values in the array in the second parameter of the query function.</p> |
||||
<p class="important">The secondary benefit of using binds is that the values are automatically escaped, producing safer queries. You don't have to remember to manually escape data; the engine does it automatically for you.</p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="connecting.html">Connecting to your Database</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="results.html">Query Results</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,259 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Generating Query Results : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Query Results |
||||
</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>Generating Query Results</h1> |
||||
|
||||
|
||||
<p>There are several ways to generate query results:</p> |
||||
|
||||
<h2>result()</h2> |
||||
|
||||
<p>This function returns the query result as an array of <strong>objects</strong>, or <strong>an empty array</strong> on failure. |
||||
|
||||
Typically you'll use this in a foreach loop, like this:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query("YOUR QUERY");<br /> |
||||
<br /> |
||||
foreach ($query->result() as $row)<br /> |
||||
{<br /> |
||||
echo $row->title;<br /> |
||||
echo $row->name;<br /> |
||||
echo $row->body;<br /> |
||||
}</code> |
||||
|
||||
<p>The above <dfn>function</dfn> is an alias of <dfn>result_object()</dfn>.</p> |
||||
|
||||
<p>If you run queries that might <strong>not</strong> produce a result, you are encouraged to test the result first:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query("YOUR QUERY");<br /> |
||||
<br /> |
||||
if ($query->num_rows() > 0)<br /> |
||||
{<br /> |
||||
foreach ($query->result() as $row)<br /> |
||||
{<br /> |
||||
echo $row->title;<br /> |
||||
echo $row->name;<br /> |
||||
echo $row->body;<br /> |
||||
}<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p>You can also pass a string to result() which represents a class to instantiate for each result object (note: this class must be loaded)</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query("SELECT * FROM users;");<br /> |
||||
<br /> |
||||
foreach ($query->result('User') as $row)<br /> |
||||
{<br /> |
||||
echo $row->name; // call attributes<br /> |
||||
echo $row->reverse_name(); // or methods defined on the 'User' class<br /> |
||||
} |
||||
</code> |
||||
|
||||
<h2>result_array()</h2> |
||||
|
||||
<p>This function returns the query result as a pure array, or an empty array when no result is produced. Typically you'll use this in a foreach loop, like this:</p> |
||||
<code> |
||||
$query = $this->db->query("YOUR QUERY");<br /> |
||||
<br /> |
||||
foreach ($query->result_array() as $row)<br /> |
||||
{<br /> |
||||
echo $row['title'];<br /> |
||||
echo $row['name'];<br /> |
||||
echo $row['body'];<br /> |
||||
}</code> |
||||
|
||||
|
||||
<h2>row()</h2> |
||||
|
||||
<p>This function returns a single result row. If your query has more than one row, it returns only the first row. |
||||
The result is returned as an <strong>object</strong>. Here's a usage example:</p> |
||||
<code> |
||||
$query = $this->db->query("YOUR QUERY");<br /> |
||||
<br /> |
||||
if ($query->num_rows() > 0)<br /> |
||||
{<br /> |
||||
$row = $query->row(); |
||||
<br /><br /> |
||||
echo $row->title;<br /> |
||||
echo $row->name;<br /> |
||||
echo $row->body;<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p>If you want a specific row returned you can submit the row number as a digit in the first parameter:</p> |
||||
|
||||
<code>$row = $query->row(<dfn>5</dfn>);</code> |
||||
|
||||
<p>You can also add a second String parameter, which is the name of a class to instantiate the row with:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query("SELECT * FROM users LIMIT 1;");<br /> |
||||
<br /> |
||||
$query->row(0, 'User')<br /> |
||||
echo $row->name; // call attributes<br /> |
||||
echo $row->reverse_name(); // or methods defined on the 'User' class<br /> |
||||
</code> |
||||
|
||||
<h2>row_array()</h2> |
||||
|
||||
<p>Identical to the above <var>row()</var> function, except it returns an array. Example:</p> |
||||
|
||||
<code> |
||||
$query = $this->db->query("YOUR QUERY");<br /> |
||||
<br /> |
||||
if ($query->num_rows() > 0)<br /> |
||||
{<br /> |
||||
$row = $query->row_array(); |
||||
<br /><br /> |
||||
echo $row['title'];<br /> |
||||
echo $row['name'];<br /> |
||||
echo $row['body'];<br /> |
||||
} |
||||
</code> |
||||
|
||||
|
||||
<p>If you want a specific row returned you can submit the row number as a digit in the first parameter:</p> |
||||
|
||||
<code>$row = $query->row_array(<dfn>5</dfn>);</code> |
||||
|
||||
|
||||
<p>In addition, you can walk forward/backwards/first/last through your results using these variations:</p> |
||||
|
||||
<p> |
||||
<strong>$row = $query->first_row()</strong><br /> |
||||
<strong>$row = $query->last_row()</strong><br /> |
||||
<strong>$row = $query->next_row()</strong><br /> |
||||
<strong>$row = $query->previous_row()</strong> |
||||
</p> |
||||
|
||||
<p>By default they return an object unless you put the word "array" in the parameter:</p> |
||||
|
||||
<p> |
||||
<strong>$row = $query->first_row('array')</strong><br /> |
||||
<strong>$row = $query->last_row('array')</strong><br /> |
||||
<strong>$row = $query->next_row('array')</strong><br /> |
||||
<strong>$row = $query->previous_row('array')</strong> |
||||
</p> |
||||
|
||||
|
||||
|
||||
<h1>Result Helper Functions</h1> |
||||
|
||||
|
||||
<h2>$query->num_rows()</h2> |
||||
<p>The number of rows returned by the query. Note: In this example, <dfn>$query</dfn> is the variable that the query result object is assigned to:</p> |
||||
|
||||
<code>$query = $this->db->query('SELECT * FROM my_table');<br /><br /> |
||||
echo $query->num_rows(); |
||||
</code> |
||||
|
||||
<h2>$query->num_fields()</h2> |
||||
<p>The number of FIELDS (columns) returned by the query. Make sure to call the function using your query result object:</p> |
||||
|
||||
<code>$query = $this->db->query('SELECT * FROM my_table');<br /><br /> |
||||
echo $query->num_fields(); |
||||
</code> |
||||
|
||||
|
||||
|
||||
<h2>$query->free_result()</h2> |
||||
<p>It frees the memory associated with the result and deletes the result resource ID. Normally PHP frees its memory automatically at the end of script |
||||
execution. However, if you are running a lot of queries in a particular script you might want to free the result after each query result has been |
||||
generated in order to cut down on memory consumptions. Example: |
||||
</p> |
||||
|
||||
<code>$query = $this->db->query('SELECT title FROM my_table');<br /><br /> |
||||
foreach ($query->result() as $row)<br /> |
||||
{<br /> |
||||
echo $row->title;<br /> |
||||
}<br /> |
||||
$query->free_result(); // The $query result object will no longer be available<br /> |
||||
<br /> |
||||
$query2 = $this->db->query('SELECT name FROM some_table');<br /><br /> |
||||
$row = $query2->row();<br /> |
||||
echo $row->name;<br /> |
||||
$query2->free_result(); // The $query2 result object will no longer be available |
||||
</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="queries.html">Queries</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="helpers.html">Query Helper Functions</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,113 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Table Data : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Table Data |
||||
</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>Table Data</h1> |
||||
|
||||
<p>These functions let you fetch table information.</p> |
||||
|
||||
<h2>$this->db->list_tables();</h2> |
||||
|
||||
<p>Returns an array containing the names of all the tables in the database you are currently connected to. Example:</p> |
||||
|
||||
<code>$tables = $this->db->list_tables();<br /> |
||||
<br /> |
||||
foreach ($tables as $table)<br /> |
||||
{<br /> |
||||
echo $table;<br /> |
||||
} |
||||
</code> |
||||
|
||||
|
||||
<h2>$this->db->table_exists();</h2> |
||||
|
||||
<p>Sometimes it's helpful to know whether a particular table exists before running an operation on it. |
||||
Returns a boolean TRUE/FALSE. Usage example:</p> |
||||
|
||||
<code> |
||||
if ($this->db->table_exists('table_name'))<br /> |
||||
{<br /> |
||||
// some code...<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p>Note: Replace <em>table_name</em> with the name of the table you are looking for.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="transactions.html"> Transactions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="fields.html"> Field Metadata</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,200 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Transactions : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Transactions |
||||
</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>Transactions</h1> |
||||
|
||||
<p>CodeIgniter's database abstraction allows you to use <dfn>transactions</dfn> with databases that support transaction-safe table types. In MySQL, you'll need |
||||
to be running InnoDB or BDB table types rather than the more common MyISAM. Most other database platforms support transactions natively.</p> |
||||
|
||||
<p>If you are not familiar with |
||||
transactions we recommend you find a good online resource to learn about them for your particular database. The information below assumes you |
||||
have a basic understanding of transactions. |
||||
</p> |
||||
|
||||
<h2>CodeIgniter's Approach to Transactions</h2> |
||||
|
||||
<p>CodeIgniter utilizes an approach to transactions that is very similar to the process used by the popular database class ADODB. We've chosen that approach |
||||
because it greatly simplifies the process of running transactions. In most cases all that is required are two lines of code.</p> |
||||
|
||||
<p>Traditionally, transactions have required a fair amount of work to implement since they demand that you to keep track of your queries |
||||
and determine whether to <dfn>commit</dfn> or <dfn>rollback</dfn> based on the success or failure of your queries. This is particularly cumbersome with |
||||
nested queries. In contrast, |
||||
we've implemented a smart transaction system that does all this for you automatically (you can also manage your transactions manually if you choose to, |
||||
but there's really no benefit).</p> |
||||
|
||||
<h2>Running Transactions</h2> |
||||
|
||||
<p>To run your queries using transactions you will use the <dfn>$this->db->trans_start()</dfn> and <dfn>$this->db->trans_complete()</dfn> functions as follows:</p> |
||||
|
||||
<code> |
||||
<kbd>$this->db->trans_start();</kbd><br /> |
||||
$this->db->query('AN SQL QUERY...');<br /> |
||||
$this->db->query('ANOTHER QUERY...');<br /> |
||||
$this->db->query('AND YET ANOTHER QUERY...');<br /> |
||||
<kbd>$this->db->trans_complete();</kbd> |
||||
</code> |
||||
|
||||
<p>You can run as many queries as you want between the start/complete functions and they will all be committed or rolled back based on success or failure |
||||
of any given query.</p> |
||||
|
||||
|
||||
<h2>Strict Mode</h2> |
||||
|
||||
<p>By default CodeIgniter runs all transactions in <dfn>Strict Mode</dfn>. When strict mode is enabled, if you are running multiple groups of |
||||
transactions, if one group fails all groups will be rolled back. If strict mode is disabled, each group is treated independently, meaning |
||||
a failure of one group will not affect any others.</p> |
||||
|
||||
<p>Strict Mode can be disabled as follows:</p> |
||||
|
||||
<code>$this->db->trans_strict(FALSE);</code> |
||||
|
||||
|
||||
<h2>Managing Errors</h2> |
||||
|
||||
<p>If you have error reporting enabled in your <dfn>config/database.php</dfn> file you'll see a standard error message if the commit was unsuccessful. If debugging is turned off, you can |
||||
manage your own errors like this:</p> |
||||
|
||||
<code> |
||||
$this->db->trans_start();<br /> |
||||
$this->db->query('AN SQL QUERY...');<br /> |
||||
$this->db->query('ANOTHER QUERY...');<br /> |
||||
$this->db->trans_complete();<br /> |
||||
<br /> |
||||
if (<kbd>$this->db->trans_status()</kbd> === FALSE)<br /> |
||||
{<br /> |
||||
// generate an error... or use the log_message() function to log your error<br /> |
||||
} |
||||
</code> |
||||
|
||||
|
||||
<h2>Enabling Transactions</h2> |
||||
|
||||
<p>Transactions are enabled automatically the moment you use <dfn>$this->db->trans_start()</dfn>. If you would like to disable transactions you |
||||
can do so using <dfn>$this->db->trans_off()</dfn>:</p> |
||||
|
||||
<code> |
||||
<kbd>$this->db->trans_off()</kbd><br /><br /> |
||||
|
||||
$this->db->trans_start();<br /> |
||||
$this->db->query('AN SQL QUERY...');<br /> |
||||
$this->db->trans_complete(); |
||||
</code> |
||||
|
||||
<p class="important">When transactions are disabled, your queries will be auto-commited, just as they are when running queries without transactions.</p> |
||||
|
||||
|
||||
<h2>Test Mode</h2> |
||||
|
||||
<p>You can optionally put the transaction system into "test mode", which will cause your queries to be rolled back -- even if the queries produce a valid result. |
||||
To use test mode simply set the first parameter in the <dfn>$this->db->trans_start()</dfn> function to <samp>TRUE</samp>:</p> |
||||
|
||||
<code> |
||||
$this->db->trans_start(<samp>TRUE</samp>); // Query will be rolled back<br /> |
||||
$this->db->query('AN SQL QUERY...');<br /> |
||||
$this->db->trans_complete(); |
||||
</code> |
||||
|
||||
|
||||
<h2>Running Transactions Manually</h2> |
||||
|
||||
<p>If you would like to run transactions manually you can do so as follows:</p> |
||||
|
||||
<code> |
||||
$this->db->trans_begin();<br /><br /> |
||||
|
||||
$this->db->query('AN SQL QUERY...');<br /> |
||||
$this->db->query('ANOTHER QUERY...');<br /> |
||||
$this->db->query('AND YET ANOTHER QUERY...');<br /> |
||||
|
||||
<br /> |
||||
|
||||
if ($this->db->trans_status() === FALSE)<br /> |
||||
{<br /> |
||||
$this->db->trans_rollback();<br /> |
||||
}<br /> |
||||
else<br /> |
||||
{<br /> |
||||
$this->db->trans_commit();<br /> |
||||
}<br /> |
||||
</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> Make sure to use <kbd>$this->db->trans_begin()</kbd> when running manual transactions, <strong>NOT</strong> |
||||
<dfn>$this->db->trans_start()</dfn>.</p> |
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="fields.html">Field MetaData</a> · |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="table_data.html">Table Metadata</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,314 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Database Utility Class : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
<a href="index.html">Database Library</a> › |
||||
Database Utility Class |
||||
</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>Database Utility Class</h1> |
||||
|
||||
<p>The Database Utility Class contains functions that help you manage your database.</p> |
||||
|
||||
<h3>Table of Contents</h3> |
||||
|
||||
<ul> |
||||
<li><a href="#init">Initializing the Utility Class</a></li> |
||||
<li><a href="#list">Listing your Databases</a></li> |
||||
<li><a href="#exists">Checking for a specific Database</a></li> |
||||
<li><a href="#opttb">Optimizing your Tables</a></li> |
||||
<li><a href="#repair">Repairing your Databases</a></li> |
||||
<li><a href="#optdb">Optimizing your Database</a></li> |
||||
<li><a href="#csv">CSV Files from a Database Result</a></li> |
||||
<li><a href="#xml">XML Files from a Database Result</a></li> |
||||
<li><a href="#backup">Backing up your Database</a></li> |
||||
</ul> |
||||
|
||||
|
||||
|
||||
<h2><a name="init"></a>Initializing the Utility Class</h2> |
||||
|
||||
<p class="important"><strong>Important:</strong> In order to initialize the Utility class, your database driver must |
||||
already be running, since the utilities class relies on it.</p> |
||||
|
||||
<p>Load the Utility Class as follows:</p> |
||||
|
||||
<code>$this->load->dbutil()</code> |
||||
|
||||
<p>Once initialized you will access the functions using the <dfn>$this->dbutil</dfn> object:</p> |
||||
|
||||
<code>$this->dbutil->some_function()</code> |
||||
|
||||
<h2><a name="list"></a>$this->dbutil->list_databases()</h2> |
||||
<p>Returns an array of database names:</p> |
||||
|
||||
<code> |
||||
$dbs = $this->dbutil->list_databases();<br /> |
||||
<br /> |
||||
foreach ($dbs as $db)<br /> |
||||
{<br /> |
||||
echo $db;<br /> |
||||
}</code> |
||||
|
||||
|
||||
<h2><a name="exists"></a>$this->dbutil->database_exists();</h2> |
||||
|
||||
<p>Sometimes it's helpful to know whether a particular database exists. |
||||
Returns a boolean TRUE/FALSE. Usage example:</p> |
||||
|
||||
<code> |
||||
if ($this->dbutil->database_exists('database_name'))<br /> |
||||
{<br /> |
||||
// some code...<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p>Note: Replace <em>database_name</em> with the name of the table you are looking for. This function is case sensitive.</p> |
||||
|
||||
|
||||
|
||||
<h2><a name="opttb"></a>$this->dbutil->optimize_table('table_name');</h2> |
||||
|
||||
<p class="important"><strong>Note:</strong> This features is only available for MySQL/MySQLi databases.</p> |
||||
|
||||
|
||||
<p>Permits you to optimize a table using the table name specified in the first parameter. Returns TRUE/FALSE based on success or failure:</p> |
||||
|
||||
<code> |
||||
if ($this->dbutil->optimize_table('table_name'))<br /> |
||||
{<br /> |
||||
echo 'Success!';<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p><strong>Note:</strong> Not all database platforms support table optimization.</p> |
||||
|
||||
|
||||
<h2><a name="repair"></a>$this->dbutil->repair_table('table_name');</h2> |
||||
|
||||
<p class="important"><strong>Note:</strong> This features is only available for MySQL/MySQLi databases.</p> |
||||
|
||||
|
||||
<p>Permits you to repair a table using the table name specified in the first parameter. Returns TRUE/FALSE based on success or failure:</p> |
||||
|
||||
<code> |
||||
if ($this->dbutil->repair_table('table_name'))<br /> |
||||
{<br /> |
||||
echo 'Success!';<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p><strong>Note:</strong> Not all database platforms support table repairs.</p> |
||||
|
||||
|
||||
<h2><a name="optdb"></a>$this->dbutil->optimize_database();</h2> |
||||
|
||||
<p class="important"><strong>Note:</strong> This features is only available for MySQL/MySQLi databases.</p> |
||||
|
||||
<p>Permits you to optimize the database your DB class is currently connected to. Returns an array containing the DB status messages or FALSE on failure.</p> |
||||
|
||||
<code> |
||||
$result = $this->dbutil->optimize_database();<br /> |
||||
<br /> |
||||
if ($result !== FALSE)<br /> |
||||
{<br /> |
||||
print_r($result);<br /> |
||||
} |
||||
</code> |
||||
|
||||
<p><strong>Note:</strong> Not all database platforms support table optimization.</p> |
||||
|
||||
|
||||
<h2><a name="csv"></a>$this->dbutil->csv_from_result($db_result)</h2> |
||||
|
||||
<p>Permits you to generate a CSV file from a query result. The first parameter of the function must contain the result object from your query. |
||||
Example:</p> |
||||
|
||||
<code> |
||||
$this->load->dbutil();<br /> |
||||
<br /> |
||||
$query = $this->db->query("SELECT * FROM mytable");<br /> |
||||
<br /> |
||||
echo $this->dbutil->csv_from_result($query); |
||||
</code> |
||||
|
||||
<p>The second and third parameters allows you to |
||||
set the delimiter and newline character. By default tabs are used as the delimiter and "\n" is used as a new line. Example:</p> |
||||
|
||||
<code> |
||||
$delimiter = ",";<br /> |
||||
$newline = "\r\n";<br /> |
||||
<br /> |
||||
echo $this->dbutil->csv_from_result($query, $delimiter, $newline); |
||||
</code> |
||||
|
||||
<p><strong>Important:</strong> This function will NOT write the CSV file for you. It simply creates the CSV layout. |
||||
If you need to write the file use the <a href="../helpers/file_helper.html">File Helper</a>.</p> |
||||
|
||||
|
||||
<h2><a name="xml"></a>$this->dbutil->xml_from_result($db_result)</h2> |
||||
|
||||
<p>Permits you to generate an XML file from a query result. The first parameter expects a query result object, the second |
||||
may contain an optional array of config parameters. Example:</p> |
||||
|
||||
<code> |
||||
$this->load->dbutil();<br /> |
||||
<br /> |
||||
$query = $this->db->query("SELECT * FROM mytable");<br /> |
||||
<br /> |
||||
$config = array (<br /> |
||||
'root' => 'root',<br /> |
||||
'element' => 'element', <br /> |
||||
'newline' => "\n", <br /> |
||||
'tab' => "\t"<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo $this->dbutil->xml_from_result($query, $config); |
||||
</code> |
||||
|
||||
<p><strong>Important:</strong> This function will NOT write the XML file for you. It simply creates the XML layout. |
||||
If you need to write the file use the <a href="../helpers/file_helper.html">File Helper</a>.</p> |
||||
|
||||
|
||||
<h2><a name="backup"></a>$this->dbutil->backup()</h2> |
||||
|
||||
<p>Permits you to backup your full database or individual tables. The backup data can be compressed in either Zip or Gzip format.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> This features is only available for MySQL databases.</p> |
||||
|
||||
<p>Note: Due to the limited execution time and memory available to PHP, backing up very large |
||||
databases may not be possible. If your database is very large you might need to backup directly from your SQL server |
||||
via the command line, or have your server admin do it for you if you do not have root privileges.</p> |
||||
|
||||
<h3>Usage Example</h3> |
||||
|
||||
<code> |
||||
<dfn>// Load the DB utility class</dfn><br /> |
||||
$this->load->dbutil();<br /><br /> |
||||
|
||||
<dfn>// Backup your entire database and assign it to a variable</dfn><br /> |
||||
$backup =& $this->dbutil->backup(); |
||||
|
||||
<br /><br /> |
||||
<dfn>// Load the file helper and write the file to your server</dfn><br /> |
||||
$this->load->helper('file');<br /> |
||||
write_file('/path/to/mybackup.gz', $backup); |
||||
|
||||
<br /><br /> |
||||
<dfn>// Load the download helper and send the file to your desktop</dfn><br /> |
||||
$this->load->helper('download');<br /> |
||||
force_download('mybackup.gz', $backup); |
||||
</code> |
||||
|
||||
<h3>Setting Backup Preferences</h3> |
||||
|
||||
<p>Backup preferences are set by submitting an array of values to the first parameter of the backup function. Example:</p> |
||||
|
||||
<code>$prefs = array(<br /> |
||||
'tables' => array('table1', 'table2'), // Array of tables to backup.<br /> |
||||
'ignore' => array(), // List of tables to omit from the backup<br /> |
||||
'format' => 'txt', // gzip, zip, txt<br /> |
||||
'filename' => 'mybackup.sql', // File name - NEEDED ONLY WITH ZIP FILES<br /> |
||||
'add_drop' => TRUE, // Whether to add DROP TABLE statements to backup file<br /> |
||||
'add_insert' => TRUE, // Whether to add INSERT data to backup file<br /> |
||||
'newline' => "\n" // Newline character used in backup file<br /> |
||||
);<br /> |
||||
<br /> |
||||
$this->dbutil->backup($prefs); |
||||
</code> |
||||
|
||||
|
||||
<h3>Description of Backup Preferences</h3> |
||||
|
||||
<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder"> |
||||
<tr> |
||||
<th>Preference</th> |
||||
<th>Default Value</th> |
||||
<th>Options</th> |
||||
<th>Description</th> |
||||
</tr><tr> |
||||
<td class="td"><strong>tables</strong></td><td class="td">empty array</td><td class="td">None</td><td class="td">An array of tables you want backed up. If left blank all tables will be exported.</td> |
||||
</tr><tr> |
||||
<td class="td"><strong>ignore</strong></td><td class="td">empty array</td><td class="td">None</td><td class="td">An array of tables you want the backup routine to ignore.</td> |
||||
</tr><tr> |
||||
<td class="td"><strong>format</strong></td><td class="td">gzip</td><td class="td">gzip, zip, txt</td><td class="td">The file format of the export file.</td> |
||||
</tr><tr> |
||||
<td class="td"><strong>filename</strong></td><td class="td">the current date/time</td><td class="td">None</td><td class="td">The name of the backed-up file. The name is needed only if you are using zip compression.</td> |
||||
</tr><tr> |
||||
<td class="td"><strong>add_drop</strong></td><td class="td">TRUE</td><td class="td">TRUE/FALSE</td><td class="td">Whether to include DROP TABLE statements in your SQL export file.</td> |
||||
</tr><tr> |
||||
<td class="td"><strong>add_insert</strong></td><td class="td">TRUE</td><td class="td">TRUE/FALSE</td><td class="td">Whether to include INSERT statements in your SQL export file.</td> |
||||
</tr><tr> |
||||
<td class="td"><strong>newline</strong></td><td class="td">"\n"</td><td class="td">"\n", "\r", "\r\n"</td><td class="td">Type of newline to use in your SQL export file.</td> |
||||
|
||||
</tr> |
||||
</table> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="forge.html">DB Forge Class</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="../libraries/javascript.html">Javascript Class</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,87 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Writing Documentation : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Writing Documentation |
||||
</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>Writing Documentation</h1> |
||||
|
||||
<p>To help facilitate a consistent, easy-to-read documentation style for CodeIgniter projects, EllisLab is making the markup and CSS from the CodeIgniter user guide freely available to the community for their use. For your convenience, a template file has been created that includes the primary blocks of markup used with brief samples.</p> |
||||
|
||||
<h2>Files</h2> |
||||
|
||||
<ul> |
||||
<li><a href="../userguide.css">Stylesheet</a></li> |
||||
<li><a href="./template.html">Page Template</a></li> |
||||
</ul> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="../general/styleguide.html">PHP Style Guide</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="../libraries/benchmark.html">Benchmarking Class</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,128 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>CodeIgniter Project Documentation Template</title> |
||||
|
||||
<style type='text/css' media='all'>@import url('./userguide.css');</style> |
||||
<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' /> |
||||
|
||||
<meta http-equiv='expires' content='-1' /> |
||||
<meta http-equiv= 'pragma' content='no-cache' /> |
||||
<meta name='robots' content='all' /> |
||||
|
||||
</head> |
||||
<body> |
||||
|
||||
<!-- START NAVIGATION --> |
||||
<div id="nav"><div id="nav_inner"></div></div> |
||||
<div id="nav2"><a name="top"> </a></div> |
||||
<div id="masthead"> |
||||
<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> |
||||
<tr> |
||||
<td><h1>Project Title</h1></td> |
||||
<td id="breadcrumb_right"><a href="#">Right Breadcrumb</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://example.com/">Project Home</a> › |
||||
<a href="#">User Guide Home</a> › |
||||
Foo Class |
||||
</td> |
||||
<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="example.com/user_guide/" />Search Project 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>Foo Class</h1> |
||||
|
||||
<p>Brief description of Foo Class. If it extends a native CodeIgniter class, please link to the class in the CodeIgniter documents here.</p> |
||||
|
||||
<p class="important"><strong>Important:</strong> This is an important note with <kbd>EMPHASIS</kbd>.</p> |
||||
|
||||
<p>Features:</p> |
||||
|
||||
<ul> |
||||
<li>Foo</li> |
||||
<li>Bar</li> |
||||
</ul> |
||||
|
||||
<h2>Usage Heading</h2> |
||||
|
||||
<p>Within a text string, <var>highlight variables</var> using <var><var></var></var> tags, and <dfn>highlight code</dfn> using the <dfn><dfn></dfn></dfn> tags.</p> |
||||
|
||||
<h3>Sub-heading</h3> |
||||
|
||||
<p>Put code examples within <dfn><code></code></dfn> tags:</p> |
||||
|
||||
<code> |
||||
$this->load->library('foo');<br /> |
||||
<br /> |
||||
$this->foo->bar('bat'); |
||||
</code> |
||||
|
||||
|
||||
<h2>Table Preferences</h2> |
||||
|
||||
<p>Use tables where appropriate for long lists of preferences.</p> |
||||
|
||||
|
||||
<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder"> |
||||
<tr> |
||||
<th>Preference</th> |
||||
<th>Default Value</th> |
||||
<th>Options</th> |
||||
<th>Description</th> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>foo</strong></td> |
||||
<td class="td">Foo</td> |
||||
<td class="td">None</td> |
||||
<td class="td">Description of foo.</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>bar</strong></td> |
||||
<td class="td">Bar</td> |
||||
<td class="td">bat, bag, or bak</td> |
||||
<td class="td">Description of bar.</td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<h2>Foo Function Reference</h2> |
||||
|
||||
<h3>$this->foo->bar()</h3> |
||||
<p>Description</p> |
||||
<code>$this->foo->bar('<var>baz</var>')</code> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="#">Previous Class</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="#">User Guide Home</a> · |
||||
Next Topic: <a href="#">Next Class</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,147 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Alternate PHP Syntax for View Files : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Alternate PHP Syntax |
||||
</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>Alternate PHP Syntax for View Files</h1> |
||||
|
||||
<p>If you do not utilize CodeIgniter's <a href="../libraries/parser.html">template engine</a>, you'll be using pure PHP |
||||
in your View files. To minimize the PHP code in these files, and to make it easier to identify the code blocks it is recommended that you use |
||||
PHPs alternative syntax for control structures and short tag echo statements. If you are not familiar with this syntax, it allows you to eliminate the braces from your code, |
||||
and eliminate "echo" statements.</p> |
||||
|
||||
<h2>Automatic Short Tag Support</h2> |
||||
|
||||
<p><strong>Note:</strong> If you find that the syntax described in this page does not work on your server it might |
||||
be that "short tags" are disabled in your PHP ini file. CodeIgniter will optionally rewrite short tags on-the-fly, |
||||
allowing you to use that syntax even if your server doesn't support it. This feature can be enabled in your |
||||
<dfn>config/config.php</dfn> file.</p> |
||||
|
||||
<p class="important">Please note that if you do use this feature, if PHP errors are encountered |
||||
in your <strong>view files</strong>, the error message and line number will not be accurately shown. Instead, all errors |
||||
will be shown as <kbd>eval()</kbd> errors.</p> |
||||
|
||||
|
||||
<h2>Alternative Echos</h2> |
||||
|
||||
<p>Normally to echo, or print out a variable you would do this:</p> |
||||
|
||||
<code><?php echo $variable; ?></code> |
||||
|
||||
<p>With the alternative syntax you can instead do it this way:</p> |
||||
|
||||
<code><?=$variable?></code> |
||||
|
||||
|
||||
|
||||
<h2>Alternative Control Structures</h2> |
||||
|
||||
<p>Controls structures, like <var>if</var>, <var>for</var>, <var>foreach</var>, and <var>while</var> can be |
||||
written in a simplified format as well. Here is an example using foreach:</p> |
||||
|
||||
<code> |
||||
<ul><br /> |
||||
<br /> |
||||
<var><?php foreach ($todo as $item): ?></var><br /> |
||||
<br /> |
||||
<li><var><?=$item?></var></li><br /> |
||||
<br /> |
||||
<var><?php endforeach; ?></var><br /> |
||||
<br /> |
||||
</ul></code> |
||||
|
||||
<p>Notice that there are no braces. Instead, the end brace is replaced with <var>endforeach</var>. |
||||
Each of the control structures listed above has a similar closing syntax: |
||||
<var>endif</var>, <var>endfor</var>, <var>endforeach</var>, and <var>endwhile</var></p> |
||||
|
||||
<p>Also notice that instead of using a semicolon after each structure (except the last one), there is a colon. This is |
||||
important!</p> |
||||
|
||||
<p>Here is another example, using if/elseif/else. Notice the colons:</p> |
||||
|
||||
|
||||
<code><var><?php if ($username == 'sally'): ?></var><br /> |
||||
<br /> |
||||
<h3>Hi Sally</h3><br /> |
||||
<br /> |
||||
<var><?php elseif ($username == 'joe'): ?></var><br /> |
||||
<br /> |
||||
<h3>Hi Joe</h3><br /> |
||||
<br /> |
||||
<var><?php else: ?></var><br /> |
||||
<br /> |
||||
<h3>Hi unknown user</h3><br /> |
||||
<br /> |
||||
<var><?php endif; ?></var></code> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="managing_apps.html">Managing Applications</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="security.html">Security</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,117 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Creating Ancillary Classes : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Creating Ancillary Classes |
||||
</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>Creating Ancillary Classes</h1> |
||||
|
||||
<p>In some cases you may want to develop classes that exist apart from your controllers but have the ability to |
||||
utilize all of CodeIgniter's resources. This is easily possible as you'll see.</p> |
||||
|
||||
<h2>get_instance()</h2> |
||||
|
||||
|
||||
<p><strong>Any class that you instantiate within your controller functions can access CodeIgniter's native resources</strong> simply by using the <kbd>get_instance()</kbd> function. |
||||
This function returns the main CodeIgniter object.</p> |
||||
|
||||
<p>Normally, to call any of the available CodeIgniter functions requires you to use the <kbd>$this</kbd> construct:</p> |
||||
|
||||
<code> |
||||
<strong>$this</strong>->load->helper('url');<br /> |
||||
<strong>$this</strong>->load->library('session');<br /> |
||||
<strong>$this</strong>->config->item('base_url');<br /> |
||||
etc. |
||||
</code> |
||||
|
||||
<p><kbd>$this</kbd>, however, only works within your controllers, your models, or your views. |
||||
If you would like to use CodeIgniter's classes from within your own custom classes you can do so as follows:</p> |
||||
|
||||
|
||||
<p>First, assign the CodeIgniter object to a variable:</p> |
||||
|
||||
<code>$CI =& get_instance();</code> |
||||
|
||||
<p>Once you've assigned the object to a variable, you'll use that variable <em>instead</em> of <kbd>$this</kbd>:</p> |
||||
|
||||
<code> |
||||
$CI =& get_instance();<br /><br /> |
||||
$CI->load->helper('url');<br /> |
||||
$CI->load->library('session');<br /> |
||||
$CI->config->item('base_url');<br /> |
||||
etc. |
||||
</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> You'll notice that the above get_instance() function is being passed by reference: |
||||
<br /><br /> |
||||
<var>$CI =& get_instance();</var> |
||||
<br /><br /> |
||||
This is very important. Assigning by reference allows you to use the original CodeIgniter object rather than creating a copy of it.</p> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="creating_libraries.html">Creating Core Libraries</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="autoloader.html">Auto-loading Resources</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,100 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Auto-loading Resources : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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>Auto-loading Resources</h1> |
||||
|
||||
<p>CodeIgniter comes with an "Auto-load" feature that permits libraries, helpers, and models to be initialized |
||||
automatically every time the system runs. If you need certain resources globally throughout your application you should |
||||
consider auto-loading them for convenience.</p> |
||||
|
||||
<p>The following items can be loaded automatically:</p> |
||||
|
||||
<ul> |
||||
<li>Core classes found in the "libraries" folder</li> |
||||
<li>Helper files found in the "helpers" folder</li> |
||||
<li>Custom config files found in the "config" folder</li> |
||||
<li>Language files found in the "system/language" folder </li> |
||||
<li>Models found in the "models" folder</li> |
||||
</ul> |
||||
|
||||
<p>To autoload resources, open the <var>application/config/autoload.php</var> file and add the item you want |
||||
loaded to the <samp>autoload</samp> array. You'll find instructions in that file corresponding to each |
||||
type of item.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> Do not include the file extension (.php) when adding items to the autoload array.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
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="common_functions.html">Common Functions</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,115 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Web Page Caching : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Page Caching |
||||
</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>Web Page Caching</h1> |
||||
|
||||
<p>CodeIgniter lets you cache your pages in order to achieve maximum performance.</p> |
||||
|
||||
<p>Although CodeIgniter is quite fast, the amount of dynamic information you display in your pages will correlate directly to the |
||||
server resources, memory, and processing cycles utilized, which affect your page load speeds. |
||||
By caching your pages, since they are saved in their fully rendered state, you can achieve performance that nears that of static web pages.</p> |
||||
|
||||
|
||||
<h2>How Does Caching Work?</h2> |
||||
|
||||
<p>Caching can be enabled on a per-page basis, and you can set the length of time that a page should remain cached before being refreshed. |
||||
When a page is loaded for the first time, the cache file will be written to your <dfn>application/cache</dfn> folder. On subsequent page loads the cache file will be retrieved |
||||
and sent to the requesting user's browser. If it has expired, it will be deleted and refreshed before being sent to the browser.</p> |
||||
|
||||
<p>Note: The Benchmark tag is not cached so you can still view your page load speed when caching is enabled.</p> |
||||
|
||||
<h2>Enabling Caching</h2> |
||||
|
||||
<p>To enable caching, put the following tag in any of your controller functions:</p> |
||||
|
||||
<code>$this->output->cache(<var>n</var>);</code> |
||||
|
||||
<p>Where <var>n</var> is the number of <strong>minutes</strong> you wish the page to remain cached between refreshes.</p> |
||||
|
||||
<p>The above tag can go anywhere within a function. It is not affected by the order that it appears, so place it wherever it seems |
||||
most logical to you. Once the tag is in place, your pages will begin being cached.</p> |
||||
|
||||
<p class="important"><strong>Warning:</strong> Because of the way CodeIgniter stores content for output, caching will only work if you are generating display for your controller with a <a href="./views.html">view</a>.</p> |
||||
<p class="important"><strong>Note:</strong> Before the cache files can be written you must set the file permissions on your |
||||
<dfn>application/cache</dfn> folder such that it is writable.</p> |
||||
|
||||
<h2>Deleting Caches</h2> |
||||
|
||||
<p>If you no longer wish to cache a file you can remove the caching tag and it will no longer be refreshed when it expires. Note: |
||||
Removing the tag will not delete the cache immediately. It will have to expire normally. If you need to remove it earlier you |
||||
will need to manually delete it from your cache folder.</p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="errors.html">Error Handling</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="profiling.html">Profiling Your Application</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,150 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Running via the CLI : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Running via the CLI |
||||
</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>Running via the CLI</h1> |
||||
|
||||
<p> |
||||
As well as calling an applications <a href="./controllers.html">Controllers</a> via the URL in a browser they can also be loaded via the command-line interface (CLI). |
||||
</p> |
||||
|
||||
|
||||
<ul> |
||||
<li><a href="#what">What is the CLI?</a></li> |
||||
<li><a href="#why">Why use this method?</a></li> |
||||
<li><a href="#how">How does it work?</a></li> |
||||
</ul> |
||||
|
||||
|
||||
<a name="what"></a> |
||||
<h2>What is the CLI?</h2> |
||||
|
||||
<p><dfn>The command-line interface is a text-based method of interacting with computers.</dfn> For more information, check the <a href="http://en.wikipedia.org/wiki/Command-line_interface">Wikipedia article</a>.</p> |
||||
|
||||
<a name="why"></a> |
||||
|
||||
<h2>Why run via the command-line?</h2> |
||||
|
||||
<p> |
||||
There are many reasons for running CodeIgniter from the command-line, but they are not always obvious.</p> |
||||
|
||||
<ul> |
||||
<li>Run your cron-jobs without needing to use wget or curl</li> |
||||
<li>Make your cron-jobs inaccessible from being loaded in the URL by checking for <kbd>$this->input->is_cli_request()</kbd></li> |
||||
<li>Make interactive "tasks" that can do things like set permissions, prune cache folders, run backups, etc.</li> |
||||
<li>Integrate with other applications in other languages. For example, a random C++ script could call one command and run code in your models!</li> |
||||
</ul> |
||||
|
||||
<a name="how"></a> |
||||
<h2>Let's try it: Hello World!</h2> |
||||
|
||||
<p>Let's create a simple controller so you can see it in action. Using your text editor, create a file called <dfn>tools.php</dfn>, and put the following code in it:</p> |
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="10"> |
||||
<?php |
||||
class Tools extends CI_Controller { |
||||
|
||||
public function message($to = 'World') |
||||
{ |
||||
echo "Hello {$to}!".PHP_EOL; |
||||
} |
||||
} |
||||
?> |
||||
</textarea> |
||||
|
||||
<p>Then save the file to your <dfn>application/controllers/</dfn> folder.</p> |
||||
|
||||
<p>Now normally you would visit the your site using a URL similar to this:</p> |
||||
|
||||
<code>example.com/index.php/<var>tools</var>/<var>message</var>/<var>to</var></code> |
||||
|
||||
<p>Instead, we are going to open Terminal in Mac/Lunix or go to Run > "cmd" in Windows and navigate to our CodeIgniter project.</p> |
||||
|
||||
<blockquote> |
||||
$ cd /path/to/project;<br/> |
||||
$ php index.php tools message |
||||
</blockquote> |
||||
|
||||
<p>If you did it right, you should see <samp>Hello World!</samp>.</p> |
||||
|
||||
<blockquote> |
||||
$ php index.php tools message "John Smith" |
||||
</blockquote> |
||||
|
||||
<p>Here we are passing it a argument in the same way that URL parameters work. "John Smith" is passed as a argument and output is: <samp>Hello John Smith!</samp>.</p> |
||||
|
||||
<h2>That's it!</h2> |
||||
|
||||
<p>That, in a nutshell, is all there is to know about controllers on the command line. Remember that this is just a normal controller, so routing and _remap works fine.</p> |
||||
|
||||
|
||||
|
||||
</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="reserved_names.html">Reserved Names</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,127 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<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='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_darker.jpg" width="154" height="43" 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 2.1.3</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_php('<var>version_number</var>')</h2> |
||||
|
||||
<p>is_php() determines of the PHP version being used is greater than the supplied <var>version_number</var>.</p> |
||||
|
||||
<code>if (is_php('5.3.0'))<br /> |
||||
{<br /> |
||||
$str = quoted_printable_encode($str);<br /> |
||||
}</code> |
||||
|
||||
<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> |
||||
|
||||
|
||||
<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> |
||||
|
||||
<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> |
||||
|
||||
|
||||
<h2>remove_invisible_characters(<var>$str</var>)</h2> |
||||
<p>This function prevents inserting null characters between ascii characters, like Java\0script.</p> |
||||
|
||||
|
||||
<h2>html_escape(<var>$mixed</var>)</h2> |
||||
<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> |
||||
|
||||
</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="routing.html">URI Routing</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,388 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Controllers : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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>Controllers</h1> |
||||
|
||||
<p>Controllers are the heart of your application, as they determine how HTTP requests should be handled.</p> |
||||
|
||||
|
||||
<ul> |
||||
<li><a href="#what">What is a Controller?</a></li> |
||||
<li><a href="#hello">Hello World</a></li> |
||||
<li><a href="#functions">Functions</a></li> |
||||
<li><a href="#passinguri">Passing URI Segments to Your Functions</a></li> |
||||
<li><a href="#default">Defining a Default Controller</a></li> |
||||
<li><a href="#remapping">Remapping Function Calls</a></li> |
||||
<li><a href="#output">Controlling Output Data</a></li> |
||||
<li><a href="#private">Private Functions</a></li> |
||||
<li><a href="#subfolders">Organizing Controllers into Sub-folders</a></li> |
||||
<li><a href="#constructors">Class Constructors</a></li> |
||||
<li><a href="#reserved">Reserved Function Names</a></li> |
||||
</ul> |
||||
|
||||
|
||||
<a name="what"></a> |
||||
<h2>What is a Controller?</h2> |
||||
|
||||
<p><dfn>A Controller is simply a class file that is named in a way that can be associated with a URI.</dfn></p> |
||||
|
||||
<p>Consider this URI:</p> |
||||
|
||||
<code>example.com/index.php/<var>blog</var>/</code> |
||||
|
||||
<p>In the above example, CodeIgniter would attempt to find a controller named <dfn>blog.php</dfn> and load it.</p> |
||||
|
||||
<p><strong>When a controller's name matches the first segment of a URI, it will be loaded.</strong></p> |
||||
|
||||
<a name="hello"></a> |
||||
<h2>Let's try it: Hello World!</h2> |
||||
|
||||
<p>Let's create a simple controller so you can see it in action. Using your text editor, create a file called <dfn>blog.php</dfn>, and put the following code in it:</p> |
||||
|
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="10"> |
||||
<?php |
||||
class Blog extends CI_Controller { |
||||
|
||||
public function index() |
||||
{ |
||||
echo 'Hello World!'; |
||||
} |
||||
} |
||||
?> |
||||
</textarea> |
||||
|
||||
|
||||
|
||||
<p>Then save the file to your <dfn>application/controllers/</dfn> folder.</p> |
||||
|
||||
<p>Now visit the your site using a URL similar to this:</p> |
||||
|
||||
<code>example.com/index.php/<var>blog</var>/</code> |
||||
|
||||
<p>If you did it right, you should see <samp>Hello World!</samp>.</p> |
||||
|
||||
<p>Note: Class names must start with an uppercase letter. In other words, this is valid:</p> |
||||
|
||||
<code><?php<br /> |
||||
class <var>Blog</var> extends CI_Controller {<br /> |
||||
<br /> |
||||
}<br /> |
||||
?></code> |
||||
|
||||
<p>This is <strong>not</strong> valid:</p> |
||||
|
||||
<code><?php<br /> |
||||
class <var>blog</var> extends CI_Controller {<br /> |
||||
<br /> |
||||
}<br /> |
||||
?></code> |
||||
|
||||
<p>Also, always make sure your controller <dfn>extends</dfn> the parent controller class so that it can inherit all its functions.</p> |
||||
|
||||
|
||||
|
||||
<a name="functions"></a> |
||||
<h2>Functions</h2> |
||||
|
||||
<p>In the above example the function name is <dfn>index()</dfn>. The "index" function is always loaded by default if the |
||||
<strong>second segment</strong> of the URI is empty. Another way to show your "Hello World" message would be this:</p> |
||||
|
||||
<code>example.com/index.php/<var>blog</var>/<samp>index</samp>/</code> |
||||
|
||||
<p><strong>The second segment of the URI determines which function in the controller gets called.</strong></p> |
||||
|
||||
<p>Let's try it. Add a new function to your controller:</p> |
||||
|
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="15"> |
||||
<?php |
||||
class Blog extends CI_Controller { |
||||
|
||||
public function index() |
||||
{ |
||||
echo 'Hello World!'; |
||||
} |
||||
|
||||
public function comments() |
||||
{ |
||||
echo 'Look at this!'; |
||||
} |
||||
} |
||||
?> |
||||
</textarea> |
||||
|
||||
<p>Now load the following URL to see the <dfn>comment</dfn> function:</p> |
||||
|
||||
<code>example.com/index.php/<var>blog</var>/<samp>comments</samp>/</code> |
||||
|
||||
<p>You should see your new message.</p> |
||||
|
||||
<a name="passinguri"></a> |
||||
<h2>Passing URI Segments to your Functions</h2> |
||||
|
||||
<p>If your URI contains more then two segments they will be passed to your function as parameters.</p> |
||||
|
||||
<p>For example, lets say you have a URI like this:</p> |
||||
|
||||
<code>example.com/index.php/<var>products</var>/<samp>shoes</samp>/<kbd>sandals</kbd>/<dfn>123</dfn></code> |
||||
|
||||
<p>Your function will be passed URI segments 3 and 4 ("sandals" and "123"):</p> |
||||
|
||||
<code> |
||||
<?php<br /> |
||||
class Products extends CI_Controller {<br /> |
||||
<br /> |
||||
public function shoes($sandals, $id)<br /> |
||||
{<br /> |
||||
echo $sandals;<br /> |
||||
echo $id;<br /> |
||||
}<br /> |
||||
}<br /> |
||||
?> |
||||
</code> |
||||
|
||||
<p class="important"><strong>Important:</strong> If you are using the <a href="routing.html">URI Routing</a> feature, the segments |
||||
passed to your function will be the re-routed ones.</p> |
||||
|
||||
|
||||
<a name="default"></a> |
||||
<h2>Defining a Default Controller</h2> |
||||
|
||||
<p>CodeIgniter can be told to load a default controller when a URI is not present, |
||||
as will be the case when only your site root URL is requested. To specify a default controller, open |
||||
your <dfn>application/config/routes.php</dfn> file and set this variable:</p> |
||||
|
||||
<code>$route['default_controller'] = '<var>Blog</var>';</code> |
||||
|
||||
<p>Where <var>Blog</var> is the name of the controller class you want used. If you now load your main index.php file without |
||||
specifying any URI segments you'll see your Hello World message by default.</p> |
||||
|
||||
|
||||
|
||||
<a name="remapping"></a> |
||||
<h2>Remapping Function Calls</h2> |
||||
|
||||
<p>As noted above, the second segment of the URI typically determines which function in the controller gets called. |
||||
CodeIgniter permits you to override this behavior through the use of the <kbd>_remap()</kbd> function:</p> |
||||
|
||||
<code>public function _remap()<br /> |
||||
{<br /> |
||||
// Some code here...<br /> |
||||
}</code> |
||||
|
||||
<p class="important"><strong>Important:</strong> If your controller contains a function named <kbd>_remap()</kbd>, it will <strong>always</strong> |
||||
get called regardless of what your URI contains. It overrides the normal behavior in which the URI determines which function is called, |
||||
allowing you to define your own function routing rules.</p> |
||||
|
||||
<p>The overridden function call (typically the second segment of the URI) will be passed as a parameter to the <kbd>_remap()</kbd> function:</p> |
||||
|
||||
<code>public function _remap(<var>$method</var>)<br /> |
||||
{<br /> |
||||
if ($method == 'some_method')<br /> |
||||
{<br /> |
||||
$this->$method();<br /> |
||||
}<br /> |
||||
else<br /> |
||||
{<br /> |
||||
$this->default_method();<br /> |
||||
}<br /> |
||||
}</code> |
||||
|
||||
<p>Any extra segments after the method name are passed into <kbd>_remap()</kbd> as an optional second parameter. This array can be used in combination with PHP's <a href="http://php.net/call_user_func_array">call_user_func_array</a> to emulate CodeIgniter's default behavior.</p> |
||||
|
||||
<code>public function _remap($method, $params = array())<br /> |
||||
{<br /> |
||||
$method = 'process_'.$method;<br /> |
||||
if (method_exists($this, $method))<br /> |
||||
{<br /> |
||||
return call_user_func_array(array($this, $method), $params);<br /> |
||||
}<br /> |
||||
show_404();<br /> |
||||
}</code> |
||||
|
||||
|
||||
<a name="output"></a> |
||||
<h2>Processing Output</h2> |
||||
|
||||
<p>CodeIgniter has an output class that takes care of sending your final rendered data to the web browser automatically. More information on this can be found in the |
||||
<a href="views.html">Views</a> and <a href="../libraries/output.html">Output class</a> pages. In some cases, however, you might want to |
||||
post-process the finalized data in some way and send it to the browser yourself. CodeIgniter permits you to |
||||
add a function named <dfn>_output()</dfn> to your controller that will receive the finalized output data.</p> |
||||
|
||||
<p><strong>Important:</strong> If your controller contains a function named <kbd>_output()</kbd>, it will <strong>always</strong> |
||||
be called by the output class instead of echoing the finalized data directly. The first parameter of the function will contain the finalized output.</p> |
||||
|
||||
<p>Here is an example:</p> |
||||
|
||||
<code> |
||||
public function _output($output)<br /> |
||||
{<br /> |
||||
echo $output;<br /> |
||||
}</code> |
||||
|
||||
<p class="important">Please note that your <dfn>_output()</dfn> function will receive the data in its finalized state. Benchmark and memory usage data will be rendered, |
||||
cache files written (if you have caching enabled), and headers will be sent (if you use that <a href="../libraries/output.html">feature</a>) |
||||
before it is handed off to the _output() function.<br /> |
||||
<br /> |
||||
To have your controller's output cached properly, its <dfn>_output()</dfn> method can use:<br /> |
||||
|
||||
<code>if ($this->output->cache_expiration > 0)<br /> |
||||
{<br /> |
||||
$this->output->_write_cache($output);<br /> |
||||
}</code> |
||||
|
||||
If you are using this feature the page execution timer and memory usage stats might not be perfectly accurate |
||||
since they will not take into acccount any further processing you do. For an alternate way to control output <em>before</em> any of the final processing is done, please see |
||||
the available methods in the <a href="../libraries/output.html">Output Class</a>.</p> |
||||
|
||||
<a name="private"></a> |
||||
<h2>Private Functions</h2> |
||||
|
||||
|
||||
<p>In some cases you may want certain functions hidden from public access. To make a function private, simply add an |
||||
underscore as the name prefix and it will not be served via a URL request. For example, if you were to have a function like this:</p> |
||||
|
||||
<code> |
||||
private function _utility()<br /> |
||||
{<br /> |
||||
// some code<br /> |
||||
}</code> |
||||
|
||||
<p>Trying to access it via the URL, like this, will not work:</p> |
||||
|
||||
<code>example.com/index.php/<var>blog</var>/<samp>_utility</samp>/</code> |
||||
|
||||
|
||||
|
||||
<a name="subfolders"></a> |
||||
<h2>Organizing Your Controllers into Sub-folders</h2> |
||||
|
||||
<p>If you are building a large application you might find it convenient to organize your controllers into sub-folders. CodeIgniter permits you to do this.</p> |
||||
|
||||
<p>Simply create folders within your <dfn>application/controllers</dfn> directory and place your controller classes within them.</p> |
||||
|
||||
<p><strong>Note:</strong> When using this feature the first segment of your URI must specify the folder. For example, lets say you have a controller |
||||
located here:</p> |
||||
|
||||
<code>application/controllers/<kbd>products</kbd>/shoes.php</code> |
||||
|
||||
<p>To call the above controller your URI will look something like this:</p> |
||||
|
||||
<code>example.com/index.php/products/shoes/show/123</code> |
||||
|
||||
<p>Each of your sub-folders may contain a default controller which will be |
||||
called if the URL contains only the sub-folder. Simply name your default controller as specified in your |
||||
<dfn>application/config/routes.php</dfn> file</p> |
||||
|
||||
|
||||
<p>CodeIgniter also permits you to remap your URIs using its <a href="routing.html">URI Routing</a> feature.</p> |
||||
|
||||
|
||||
<h2><a name="constructors"></a>Class Constructors</h2> |
||||
|
||||
|
||||
<p>If you intend to use a constructor in any of your Controllers, you <strong>MUST</strong> place the following line of code in it:</p> |
||||
|
||||
<code>parent::__construct();</code> |
||||
|
||||
<p>The reason this line is necessary is because your local constructor will be overriding the one in the parent controller class so we need to manually call it.</p> |
||||
|
||||
<code> |
||||
<?php<br /> |
||||
class <kbd>Blog</kbd> extends CI_Controller {<br /> |
||||
<br /> |
||||
public function <kbd>__construct()</kbd><br /> |
||||
{<br /> |
||||
<var>parent::__construct();</var><br /> |
||||
// Your own constructor code<br /> |
||||
}<br /> |
||||
}<br /> |
||||
?></code> |
||||
|
||||
<p>Constructors are useful if you need to set some default values, or run a default process when your class is instantiated. |
||||
Constructors can't return a value, but they can do some default work.</p> |
||||
|
||||
<a name="reserved"></a> |
||||
<h2>Reserved Function Names</h2> |
||||
|
||||
<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. See <a href="reserved_names.html">Reserved Names</a> for a full list.</p> |
||||
|
||||
<h2>That's it!</h2> |
||||
|
||||
<p>That, in a nutshell, is all there is to know about controllers.</p> |
||||
|
||||
|
||||
|
||||
</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="reserved_names.html">Reserved Names</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,186 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Creating Core System Classes : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Creating Core System Classes |
||||
</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>Creating Core System Classes</h1> |
||||
|
||||
<p>Every time CodeIgniter runs there are several base classes that are initialized automatically as part of the core framework. |
||||
It is possible, however, to swap any of the core system classes with your own versions or even extend the core versions.</p> |
||||
|
||||
<p><strong>Most users will never have any need to do this, |
||||
but the option to replace or extend them does exist for those who would like to significantly alter the CodeIgniter core.</strong> |
||||
</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> Messing with a core system class has a lot of implications, so make sure you |
||||
know what you are doing before attempting it.</p> |
||||
|
||||
|
||||
<h2>System Class List</h2> |
||||
|
||||
<p>The following is a list of the core system files that are invoked every time CodeIgniter runs:</p> |
||||
|
||||
<ul> |
||||
<li>Benchmark</li> |
||||
<li>Config</li> |
||||
<li>Controller</li> |
||||
<li>Exceptions</li> |
||||
<li>Hooks</li> |
||||
<li>Input</li> |
||||
<li>Language</li> |
||||
<li>Loader</li> |
||||
<li>Log</li> |
||||
<li>Output</li> |
||||
<li>Router</li> |
||||
<li>URI</li> |
||||
<li>Utf8</li> |
||||
</ul> |
||||
|
||||
<h2>Replacing Core Classes</h2> |
||||
|
||||
<p>To use one of your own system classes instead of a default one simply place your version inside your local <dfn>application/core</dfn> directory:</p> |
||||
|
||||
<code>application/core/<dfn>some-class.php</dfn></code> |
||||
|
||||
<p>If this directory does not exist you can create it.</p> |
||||
|
||||
<p>Any file named identically to one from the list above will be used instead of the one normally used.</p> |
||||
|
||||
<p>Please note that your class must use <kbd>CI</kbd> as a prefix. For example, if your file is named <kbd>Input.php</kbd> the class will be named:</p> |
||||
|
||||
<code> |
||||
class CI_Input {<br /><br /> |
||||
|
||||
} |
||||
</code> |
||||
|
||||
|
||||
|
||||
<h2>Extending Core Class</h2> |
||||
|
||||
<p>If all you need to do is add some functionality to an existing library - perhaps add a function or two - then |
||||
it's overkill to replace the entire library with your version. In this case it's better to simply extend the class. |
||||
Extending a class is nearly identical to replacing a class with a couple exceptions:</p> |
||||
|
||||
<ul> |
||||
<li>The class declaration must extend the parent class.</li> |
||||
<li>Your new class name and filename must be prefixed with <kbd>MY_</kbd> (this item is configurable. See below.).</li> |
||||
</ul> |
||||
|
||||
<p>For example, to extend the native <kbd>Input</kbd> class you'll create a file named <dfn>application/core/</dfn><kbd>MY_Input.php</kbd>, and declare your class with:</p> |
||||
|
||||
<code> |
||||
class MY_Input extends CI_Input {<br /><br /> |
||||
|
||||
}</code> |
||||
|
||||
<p>Note: If you need to use a constructor in your class make sure you extend the parent constructor:</p> |
||||
|
||||
<code> |
||||
class MY_Input extends CI_Input {<br /> |
||||
<br /> |
||||
function __construct()<br /> |
||||
{<br /> |
||||
parent::__construct();<br /> |
||||
}<br /> |
||||
}</code> |
||||
|
||||
<p class="important"><strong>Tip:</strong> Any functions in your class that are named identically to the functions in the parent class will be used instead of the native ones |
||||
(this is known as "method overriding"). |
||||
This allows you to substantially alter the CodeIgniter core.</p> |
||||
|
||||
<p>If you are extending the Controller core class, then be sure to extend your new class in your application controller's constructors.</p> |
||||
|
||||
<code>class Welcome extends MY_Controller {<br /> |
||||
<br /> |
||||
function __construct()<br /> |
||||
{<br /> |
||||
parent::__construct();<br /> |
||||
}<br /> |
||||
<br /> |
||||
function index()<br /> |
||||
{<br /> |
||||
$this->load->view('welcome_message');<br /> |
||||
}<br /> |
||||
}</code> |
||||
|
||||
<h3>Setting Your Own Prefix</h3> |
||||
|
||||
<p>To set your own sub-class prefix, open your <dfn>application/config/config.php</dfn> file and look for this item:</p> |
||||
|
||||
<code>$config['subclass_prefix'] = 'MY_';</code> |
||||
|
||||
<p>Please note that all native CodeIgniter libraries are prefixed with <kbd>CI_</kbd> so DO NOT use that as your prefix.</p> |
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="creating_libraries.html">Creating Your Own Libraries</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="hooks.html">Hooks - Extending the Core</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,100 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Creating Drivers : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Creating Drivers |
||||
</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>Creating Drivers</h1> |
||||
|
||||
<h2>Driver Directory and File Structure</h2> |
||||
|
||||
<p>Sample driver directory and file structure layout:</p> |
||||
|
||||
<ul> |
||||
<li>/application/libraries/Driver_name |
||||
<ul> |
||||
<li>Driver_name.php</li> |
||||
<li>drivers |
||||
<ul> |
||||
<li>Driver_name_subclass_1.php</li> |
||||
<li>Driver_name_subclass_2.php</li> |
||||
<li>Driver_name_subclass_3.php</li> |
||||
</ul> |
||||
</li> |
||||
</ul> |
||||
</li> |
||||
</ul> |
||||
|
||||
<p class="important"><strong>NOTE:</strong> In order to maintain compatibility on case-sensitive file systems, the <samp>Driver_name</samp> directory must be <var>ucfirst()</var></p> |
||||
|
||||
<!-- @todo write this! --> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="drivers.html">Using CodeIgniter Drivers</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="core_classes.html">Creating Core System Classes</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,293 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Creating Libraries : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Creating Libraries |
||||
</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>Creating Libraries</h1> |
||||
|
||||
<p>When we use the term "Libraries" we are normally referring to the classes that are located in the <kbd>libraries</kbd> |
||||
directory and described in the Class Reference of this user guide. In this case, however, we will instead describe how you can create |
||||
your own libraries within your <dfn>application/libraries</dfn> directory in order to maintain separation between your local resources |
||||
and the global framework resources.</p> |
||||
|
||||
<p>As an added bonus, CodeIgniter permits your libraries to <kbd>extend</kbd> native classes if you simply need to add some functionality |
||||
to an existing library. Or you can even replace native libraries just by placing identically named versions in your <dfn>application/libraries</dfn> folder.</p> |
||||
|
||||
<p>In summary:</p> |
||||
|
||||
<ul> |
||||
<li>You can create entirely new libraries.</li> |
||||
<li>You can extend native libraries.</li> |
||||
<li>You can replace native libraries.</li> |
||||
</ul> |
||||
|
||||
<p>The page below explains these three concepts in detail.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> The Database classes can not be extended or replaced with your own classes. All other classes are able to be replaced/extended.</p> |
||||
|
||||
|
||||
<h2>Storage</h2> |
||||
|
||||
<p>Your library classes should be placed within your <dfn>application/libraries</dfn> folder, as this is where CodeIgniter will look for them when |
||||
they are initialized.</p> |
||||
|
||||
|
||||
<h2>Naming Conventions</h2> |
||||
|
||||
<ul> |
||||
<li>File names must be capitalized. For example: <dfn>Myclass.php</dfn></li> |
||||
<li>Class declarations must be capitalized. For example: <kbd>class Myclass</kbd></li> |
||||
<li>Class names and file names must match.</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>The Class File</h2> |
||||
|
||||
<p>Classes should have this basic prototype (Note: We are using the name <kbd>Someclass</kbd> purely as an example):</p> |
||||
|
||||
<code><?php if ( ! defined('BASEPATH')) exit('No direct script access allowed'); |
||||
<br /><br /> |
||||
class Someclass {<br /> |
||||
<br /> |
||||
public function some_function()<br /> |
||||
{<br /> |
||||
}<br /> |
||||
}<br /><br /> |
||||
/* End of file Someclass.php */</code> |
||||
|
||||
|
||||
<h2>Using Your Class</h2> |
||||
|
||||
<p>From within any of your <a href="controllers.html">Controller</a> functions you can initialize your class using the standard:</p> |
||||
|
||||
<code>$this->load->library('<kbd>someclass</kbd>');</code> |
||||
|
||||
<p>Where <em>someclass</em> is the file name, without the ".php" file extension. You can submit the file name capitalized or lower case. |
||||
CodeIgniter doesn't care.</p> |
||||
|
||||
<p>Once loaded you can access your class using the <kbd>lower case</kbd> version:</p> |
||||
|
||||
<code>$this-><kbd>someclass</kbd>->some_function(); // Object instances will always be lower case |
||||
</code> |
||||
|
||||
|
||||
|
||||
<h2>Passing Parameters When Initializing Your Class</h2> |
||||
|
||||
<p>In the library loading function you can dynamically pass data as an array via the second parameter and it will be passed to your class |
||||
constructor:</p> |
||||
|
||||
<code> |
||||
$params = array('type' => 'large', 'color' => 'red');<br /> |
||||
<br /> |
||||
$this->load->library('Someclass', <kbd>$params</kbd>);</code> |
||||
|
||||
<p>If you use this feature you must set up your class constructor to expect data:</p> |
||||
|
||||
<code><?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');<br /> |
||||
<br /> |
||||
class Someclass {<br /> |
||||
<br /> |
||||
public function __construct($params)<br /> |
||||
{<br /> |
||||
// Do something with $params<br /> |
||||
}<br /> |
||||
}<br /><br /> |
||||
?></code> |
||||
|
||||
<p class="important">You can also pass parameters stored in a config file. Simply create a config file named identically to the class <kbd>file name</kbd> |
||||
and store it in your <dfn>application/config/</dfn> folder. Note that if you dynamically pass parameters as described above, |
||||
the config file option will not be available.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Utilizing CodeIgniter Resources within Your Library</h2> |
||||
|
||||
|
||||
<p>To access CodeIgniter's native resources within your library use the <kbd>get_instance()</kbd> function. |
||||
This function returns the CodeIgniter super object.</p> |
||||
|
||||
<p>Normally from within your controller functions you will call any of the available CodeIgniter functions using the <kbd>$this</kbd> construct:</p> |
||||
|
||||
<code> |
||||
<strong>$this</strong>->load->helper('url');<br /> |
||||
<strong>$this</strong>->load->library('session');<br /> |
||||
<strong>$this</strong>->config->item('base_url');<br /> |
||||
etc. |
||||
</code> |
||||
|
||||
<p><kbd>$this</kbd>, however, only works directly within your controllers, your models, or your views. |
||||
If you would like to use CodeIgniter's classes from within your own custom classes you can do so as follows:</p> |
||||
|
||||
|
||||
<p>First, assign the CodeIgniter object to a variable:</p> |
||||
|
||||
<code>$CI =& get_instance();</code> |
||||
|
||||
<p>Once you've assigned the object to a variable, you'll use that variable <em>instead</em> of <kbd>$this</kbd>:</p> |
||||
|
||||
<code> |
||||
$CI =& get_instance();<br /> |
||||
<br /> |
||||
$CI->load->helper('url');<br /> |
||||
$CI->load->library('session');<br /> |
||||
$CI->config->item('base_url');<br /> |
||||
etc. |
||||
</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> You'll notice that the above get_instance() function is being passed by reference: |
||||
<br /><br /> |
||||
<var>$CI =& get_instance();</var> |
||||
<br /> |
||||
<br /> |
||||
<kbd>This is very important.</kbd> Assigning by reference allows you to use the original CodeIgniter object rather than creating a copy of it.</p> |
||||
|
||||
|
||||
<h2>Replacing Native Libraries with Your Versions</h2> |
||||
|
||||
<p>Simply by naming your class files identically to a native library will cause CodeIgniter to use it instead of the native one. To use this |
||||
feature you must name the file and the class declaration exactly the same as the native library. For example, to replace the native <kbd>Email</kbd> library |
||||
you'll create a file named <dfn>application/libraries/Email.php</dfn>, and declare your class with:</p> |
||||
|
||||
<code> |
||||
class CI_Email {<br /><br /> |
||||
|
||||
}</code> |
||||
|
||||
<p>Note that most native classes are prefixed with <kbd>CI_</kbd>.</p> |
||||
|
||||
<p>To load your library you'll see the standard loading function:</p> |
||||
|
||||
<code>$this->load->library('<kbd>email</kbd>');</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> At this time the Database classes can not be replaced with your own versions.</p> |
||||
|
||||
|
||||
<h2>Extending Native Libraries</h2> |
||||
|
||||
<p>If all you need to do is add some functionality to an existing library - perhaps add a function or two - then |
||||
it's overkill to replace the entire library with your version. In this case it's better to simply extend the class. |
||||
Extending a class is nearly identical to replacing a class with a couple exceptions:</p> |
||||
|
||||
<ul> |
||||
<li>The class declaration must extend the parent class.</li> |
||||
<li>Your new class name and filename must be prefixed with <kbd>MY_</kbd> (this item is configurable. See below.).</li> |
||||
</ul> |
||||
|
||||
<p>For example, to extend the native <kbd>Email</kbd> class you'll create a file named <dfn>application/libraries/</dfn><kbd>MY_Email.php</kbd>, and declare your class with:</p> |
||||
|
||||
<code> |
||||
class MY_Email extends CI_Email {<br /><br /> |
||||
|
||||
}</code> |
||||
|
||||
<p>Note: If you need to use a constructor in your class make sure you extend the parent constructor:</p> |
||||
|
||||
|
||||
<code> |
||||
class MY_Email extends CI_Email {<br /> |
||||
<br /> |
||||
public function __construct()<br /> |
||||
{<br /> |
||||
parent::__construct();<br /> |
||||
}<br /> |
||||
}</code> |
||||
|
||||
|
||||
<h3>Loading Your Sub-class</h3> |
||||
|
||||
<p>To load your sub-class you'll use the standard syntax normally used. DO NOT include your prefix. For example, |
||||
to load the example above, which extends the Email class, you will use:</p> |
||||
|
||||
<code>$this->load->library('<kbd>email</kbd>');</code> |
||||
|
||||
<p>Once loaded you will use the class variable as you normally would for the class you are extending. In the case of |
||||
the email class all calls will use:</p> |
||||
|
||||
|
||||
<code>$this-><kbd>email</kbd>->some_function();</code> |
||||
|
||||
|
||||
<h3>Setting Your Own Prefix</h3> |
||||
|
||||
<p>To set your own sub-class prefix, open your <dfn>application/config/config.php</dfn> file and look for this item:</p> |
||||
|
||||
<code>$config['subclass_prefix'] = 'MY_';</code> |
||||
|
||||
<p>Please note that all native CodeIgniter libraries are prefixed with <kbd>CI_</kbd> so DO NOT use that as your prefix.</p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="libraries.html">Using CodeIgniter Libraries</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="drivers.html">Using CodeIgniter Drivers</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,87 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Credits : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Credits |
||||
</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>Credits</h1> |
||||
|
||||
<p>CodeIgniter was originally developed by <a href="http://www.ellislab.com/">Rick Ellis</a> (CEO of |
||||
<a href="http://ellislab.com/">EllisLab, Inc.</a>). The framework was written for performance in the real |
||||
world, with many of the class libraries, helpers, and sub-systems borrowed from the code-base of |
||||
<a href="http://www.expressionengine.com/">ExpressionEngine</a>.</p> |
||||
|
||||
<p>It is currently developed and maintained by the ExpressionEngine Development Team.<br /> |
||||
Bleeding edge development is spearheaded by the handpicked contributors of the Reactor Team.</p> |
||||
|
||||
<p>A hat tip goes to Ruby on Rails for inspiring us to create a PHP framework, and for |
||||
bringing frameworks into the general consciousness of the web community.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="../changelog.html">Change Log</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="../installation/downloads.html">Downloading CodeIgniter</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,104 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Using CodeIgniter Drivers : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Using CodeIgniter Drivers |
||||
</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>Using CodeIgniter Drivers</h1> |
||||
|
||||
|
||||
<p>Drivers are a special type of Library that has a parent class and any number of potential child classes. Child classes have access to the parent class, but not their siblings. Drivers provide an elegant syntax in your <a href="controllers.html">controllers</a> for libraries that benefit from or require being broken down into discrete classes.</p> |
||||
|
||||
<p>Drivers are found in the <dfn>system/libraries</dfn> folder, in their own folder which is identically named to the parent library class. Also inside that folder is a subfolder named <kbd>drivers</kbd>, which contains all of the possible child class files.</p> |
||||
|
||||
<p>To use a driver you will initialize it within a controller using the following initialization function:</p> |
||||
|
||||
<code>$this->load->driver('<var>class name</var>'); </code> |
||||
|
||||
<p>Where <var>class name</var> is the name of the driver class you want to invoke. For example, to load a driver named "Some Parent" you would do this:</p> |
||||
|
||||
<code>$this->load->driver('<var>some_parent</var>');</code> |
||||
|
||||
<p>Methods of that class can then be invoked with:</p> |
||||
|
||||
<code>$this->some_parent->some_method();</code> |
||||
|
||||
<p>The child classes, the drivers themselves, can then be called directly through the parent class, without initializing them:</p> |
||||
|
||||
<code>$this->some_parent->child_one->some_method();<br /> |
||||
$this->some_parent->child_two->another_method();</code> |
||||
|
||||
<h2>Creating Your Own Drivers</h2> |
||||
|
||||
<p>Please read the section of the user guide that discusses how to <a href="creating_drivers.html">create your own drivers</a>.</p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="creating_libraries.html">Creating Libraries</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="creating_drivers.html">Creating Drivers</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,126 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Handling Multiple Environments : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Handling Multiple Environments |
||||
</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>Handling Multiple Environments</h1> |
||||
|
||||
<p> |
||||
Developers often desire different system behavior depending on whether |
||||
an application is running in a development or production |
||||
environment. For example, verbose error output is something that would |
||||
be useful while developing an application, but it may also pose a security issue when "live". |
||||
</p> |
||||
|
||||
<h2>The ENVIRONMENT Constant</h2> |
||||
|
||||
<p> |
||||
By default, CodeIgniter comes with the environment constant set to |
||||
'<kbd>development</kbd>'. At the top of index.php, you will see: |
||||
</p> |
||||
|
||||
<code> |
||||
define('<var>ENVIRONMENT</var>', '<var>development</var>'); |
||||
</code> |
||||
|
||||
<p> |
||||
In addition to affecting some basic framework behavior (see the next section), |
||||
you may use this constant in your own development to differentiate |
||||
between which environment you are running in. |
||||
</p> |
||||
|
||||
<h2>Effects On Default Framework Behavior</h2> |
||||
|
||||
<p> |
||||
There are some places in the CodeIgniter system where the <kbd>ENVIRONMENT</kbd> |
||||
constant is used. This section describes how default framework behavior is |
||||
affected. |
||||
</p> |
||||
|
||||
<h3>Error Reporting</h3> |
||||
|
||||
<p> |
||||
Setting the <kbd>ENVIRONMENT</kbd> constant to a value of '<kbd>development</kbd>' will |
||||
cause all PHP errors to be rendered to the browser when they occur. Conversely, |
||||
setting the constant to '<kbd>production</kbd>' will disable all error output. Disabling |
||||
error reporting in production is a <a href="security.html">good security practice</a>. |
||||
</p> |
||||
|
||||
<h3>Configuration Files</h3> |
||||
|
||||
<p> |
||||
Optionally, you can have CodeIgniter load environment-specific |
||||
configuration files. This may be useful for managing things like differing API keys |
||||
across multiple environments. This is described in more detail in the |
||||
environment section of the <a href="../libraries/config.html#environments">Config Class</a> documentation. |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="managing_apps.html">Managing Applications</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="alternative_php.html">Alternative PHP Syntax</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,140 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Error Handling : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Error Handling |
||||
</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>Error Handling</h1> |
||||
|
||||
<p>CodeIgniter lets you build error reporting into your applications using the functions described below. |
||||
In addition, it has an error logging class that permits error and debugging messages to be saved as text files.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> By default, CodeIgniter displays all PHP errors. You might |
||||
wish to change this behavior once your development is complete. You'll find the <dfn>error_reporting()</dfn> |
||||
function located at the top of your main index.php file. Disabling error reporting will NOT prevent log files |
||||
from being written if there are errors.</p> |
||||
|
||||
<p>Unlike most systems in CodeIgniter, the error functions are simple procedural interfaces that are available |
||||
globally throughout the application. This approach permits error messages to get triggered without having to worry |
||||
about class/function scoping.</p> |
||||
|
||||
<p>The following functions let you generate errors:</p> |
||||
|
||||
<h2>show_error('<var>message</var>' [, int <var>$status_code</var>= 500 ] )</h2> |
||||
<p>This function will display the error message supplied to it using the following error template:</p> |
||||
<p><dfn>application/errors/</dfn><kbd>error_general.php</kbd></p> |
||||
<p>The optional parameter $status_code determines what HTTP status code should be sent with the error.</p> |
||||
|
||||
<h2>show_404('<var>page</var>' [, '<var>log_error</var>'])</h2> |
||||
<p>This function will display the 404 error message supplied to it using the following error template:</p> |
||||
<p><dfn>application/errors/</dfn><kbd>error_404.php</kbd></p> |
||||
|
||||
<p>The function expects the string passed to it to be the file path to the page that isn't found. |
||||
Note that CodeIgniter automatically shows 404 messages if controllers are not found.</p> |
||||
|
||||
<p>CodeIgniter automatically logs any show_404() calls. Setting the optional second parameter to FALSE will skip logging.</p> |
||||
|
||||
|
||||
<h2>log_message('<var>level</var>', '<samp>message</samp>')</h2> |
||||
|
||||
<p>This function lets you write messages to your log files. You must supply one of three "levels" |
||||
in the first parameter, indicating what type of message it is (debug, error, info), with the message |
||||
itself in the second parameter. Example:</p> |
||||
|
||||
<code> |
||||
if ($some_var == "")<br /> |
||||
{<br /> |
||||
log_message('error', 'Some variable did not contain a value.');<br /> |
||||
}<br /> |
||||
else<br /> |
||||
{<br /> |
||||
log_message('debug', 'Some variable was correctly set');<br /> |
||||
}<br /> |
||||
<br /> |
||||
log_message('info', 'The purpose of some variable is to provide some value.');<br /> |
||||
</code> |
||||
|
||||
<p>There are three message types:</p> |
||||
|
||||
<ol> |
||||
<li>Error Messages. These are actual errors, such as PHP errors or user errors.</li> |
||||
<li>Debug Messages. These are messages that assist in debugging. For example, if a class has been initialized, you could log this as debugging info.</li> |
||||
<li>Informational Messages. These are the lowest priority messages, simply giving information regarding some process. CodeIgniter doesn't natively generate any info messages but you may want to in your application.</li> |
||||
</ol> |
||||
|
||||
|
||||
<p class="important"><strong>Note:</strong> In order for the log file to actually be written, the |
||||
"logs" folder must be writable. In addition, you must set the "threshold" for logging in <dfn>application/config/config.php</dfn>. |
||||
You might, for example, only want error messages to be logged, and not the other two types. |
||||
If you set it to zero logging will be disabled.</p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="routing.html">URI Routing</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="caching.html">Page Caching</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,185 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Helper 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Helper Functions |
||||
</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>Helper Functions</h1> |
||||
|
||||
<p>Helpers, as the name suggests, help you with tasks. Each helper file is simply a collection of functions in a particular |
||||
category. There are <dfn>URL Helpers</dfn>, that assist in creating links, there are <dfn>Form Helpers</dfn> |
||||
that help you create form elements, <dfn>Text Helpers</dfn> perform various text formatting routines, |
||||
<dfn>Cookie Helpers</dfn> set and read cookies, <dfn>File Helpers</dfn> help you deal with files, etc. |
||||
</p> |
||||
|
||||
<p>Unlike most other systems in CodeIgniter, Helpers are not written in an Object Oriented format. They are simple, procedural functions. |
||||
Each helper function performs one specific task, with no dependence on other functions.</p> |
||||
|
||||
<p>CodeIgniter does not load Helper Files by default, so the first step in using |
||||
a Helper is to load it. Once loaded, it becomes globally available in your <a href="../general/controllers.html">controller</a> and <a href="../general/views.html">views</a>.</p> |
||||
|
||||
<p>Helpers are typically stored in your <dfn>system/helpers</dfn>, or <dfn>application/helpers </dfn>directory. CodeIgniter will look first in your <dfn>application/helpers</dfn> |
||||
directory. If the directory does not exist or the specified helper is not located there CI will instead look in your global |
||||
<dfn>system/helpers</dfn> folder.</p> |
||||
|
||||
|
||||
<h2>Loading a Helper</h2> |
||||
|
||||
<p>Loading a helper file is quite simple using the following function:</p> |
||||
|
||||
<code>$this->load->helper('<var>name</var>');</code> |
||||
|
||||
<p>Where <var>name</var> is the file name of the helper, without the .php file extension or the "helper" part.</p> |
||||
|
||||
<p>For example, to load the <dfn>URL Helper</dfn> file, which is named <var>url_helper.php</var>, you would do this:</p> |
||||
|
||||
<code>$this->load->helper('<var>url</var>');</code> |
||||
|
||||
<p>A helper can be loaded anywhere within your controller functions (or even within your View files, although that's not a good practice), |
||||
as long as you load it before you use it. You can load your helpers in your controller constructor so that they become available |
||||
automatically in any function, or you can load a helper in a specific function that needs it.</p> |
||||
|
||||
<p class="important">Note: The Helper loading function above does not return a value, so don't try to assign it to a variable. Just use it as shown.</p> |
||||
|
||||
|
||||
<h2>Loading Multiple Helpers</h2> |
||||
|
||||
<p>If you need to load more than one helper you can specify them in an array, like this:</p> |
||||
|
||||
<code>$this->load->helper( <samp>array(</samp>'<var>helper1</var>', '<var>helper2</var>', '<var>helper3</var>'<samp>)</samp> );</code> |
||||
|
||||
<h2>Auto-loading Helpers</h2> |
||||
|
||||
<p>If you find that you need a particular helper globally throughout your application, you can tell CodeIgniter to auto-load it during system initialization. |
||||
This is done by opening the <var>application/config/autoload.php</var> file and adding the helper to the autoload array.</p> |
||||
|
||||
|
||||
<h2>Using a Helper</h2> |
||||
|
||||
<p>Once you've loaded the Helper File containing the function you intend to use, you'll call it the way you would a standard PHP function.</p> |
||||
|
||||
<p>For example, to create a link using the <dfn>anchor()</dfn> function in one of your view files you would do this:</p> |
||||
|
||||
<code><?php echo anchor('blog/comments', 'Click Here');?></code> |
||||
|
||||
<p>Where "Click Here" is the name of the link, and "blog/comments" is the URI to the controller/function you wish to link to.</p> |
||||
|
||||
<h2>"Extending" Helpers</h2> |
||||
|
||||
<p>To "extend" Helpers, create a file in your <dfn>application/helpers/</dfn> folder with an identical name to the existing Helper, but prefixed with <kbd>MY_</kbd> (this item is configurable. See below.).</p> |
||||
|
||||
<p>If all you need to do is add some functionality to an existing helper - perhaps add a function or two, or change how a particular |
||||
helper function operates - then it's overkill to replace the entire helper with your version. In this case it's better to simply |
||||
"extend" the Helper. The term "extend" is used loosely since Helper functions are procedural and discrete and cannot be extended |
||||
in the traditional programmatic sense. Under the hood, this gives you the ability to add to the functions a Helper provides, |
||||
or to modify how the native Helper functions operate.</p> |
||||
|
||||
<p>For example, to extend the native <kbd>Array Helper</kbd> you'll create a file named <dfn>application/helpers/</dfn><kbd>MY_array_helper.php</kbd>, and add or override functions:</p> |
||||
|
||||
<code> |
||||
// any_in_array() is not in the Array Helper, so it defines a new function<br /> |
||||
function any_in_array($needle, $haystack)<br /> |
||||
{<br /> |
||||
$needle = (is_array($needle)) ? $needle : array($needle);<br /> |
||||
<br /> |
||||
foreach ($needle as $item)<br /> |
||||
{<br /> |
||||
if (in_array($item, $haystack))<br /> |
||||
{<br /> |
||||
return TRUE;<br /> |
||||
}<br /> |
||||
}<br /> |
||||
<br /> |
||||
return FALSE;<br /> |
||||
}<br /> |
||||
<br /> |
||||
// random_element() is included in Array Helper, so it overrides the native function<br /> |
||||
function random_element($array)<br /> |
||||
{<br /> |
||||
shuffle($array);<br /> |
||||
return array_pop($array);<br /> |
||||
}<br /> |
||||
</code> |
||||
|
||||
<h3>Setting Your Own Prefix</h3> |
||||
|
||||
<p>The filename prefix for "extending" Helpers is the same used to extend libraries and Core classes. To set your own prefix, open your <dfn>application/config/config.php</dfn> file and look for this item:</p> |
||||
|
||||
<code>$config['subclass_prefix'] = 'MY_';</code> |
||||
|
||||
<p>Please note that all native CodeIgniter libraries are prefixed with <kbd>CI_</kbd> so DO NOT use that as your prefix.</p> |
||||
|
||||
|
||||
<h2>Now What?</h2> |
||||
|
||||
<p>In the Table of Contents you'll find a list of all the available Helper Files. Browse each one to see what they do.</p> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="models.html">Models</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="libraries.html">Using Libraries</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,165 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Hooks : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Hooks - Extending the Framework Core |
||||
</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>Hooks - Extending the Framework Core</h1> |
||||
|
||||
<p>CodeIgniter's Hooks feature provides a means to tap into and modify the inner workings of the framework without hacking the core files. |
||||
When CodeIgniter runs it follows a specific execution process, diagramed in the <a href="../overview/appflow.html">Application Flow</a> page. |
||||
There may be instances, however, where you'd like to cause some action to take place at a particular stage in the execution process. |
||||
For example, you might want to run a script right before your controllers get loaded, or right after, or you might want to trigger one of |
||||
your own scripts in some other location. |
||||
</p> |
||||
|
||||
<h2>Enabling Hooks</h2> |
||||
|
||||
<p>The hooks feature can be globally enabled/disabled by setting the following item in the <kbd>application/config/config.php</kbd> file:</p> |
||||
|
||||
<code>$config['enable_hooks'] = TRUE;</code> |
||||
|
||||
|
||||
<h2>Defining a Hook</h2> |
||||
|
||||
<p>Hooks are defined in <dfn>application/config/hooks.php</dfn> file. Each hook is specified as an array with this prototype:</p> |
||||
|
||||
<code> |
||||
$hook['pre_controller'] = array(<br /> |
||||
'class' => 'MyClass',<br /> |
||||
'function' => 'Myfunction',<br /> |
||||
'filename' => 'Myclass.php',<br /> |
||||
'filepath' => 'hooks',<br /> |
||||
'params' => array('beer', 'wine', 'snacks')<br /> |
||||
);</code> |
||||
|
||||
<p><strong>Notes:</strong><br />The array index correlates to the name of the particular hook point you want to |
||||
use. In the above example the hook point is <kbd>pre_controller</kbd>. A list of hook points is found below. |
||||
The following items should be defined in your associative hook array:</p> |
||||
|
||||
<ul> |
||||
<li><strong>class</strong> The name of the class you wish to invoke. If you prefer to use a procedural function instead of a class, leave this item blank.</li> |
||||
<li><strong>function</strong> The function name you wish to call.</li> |
||||
<li><strong>filename</strong> The file name containing your class/function.</li> |
||||
<li><strong>filepath</strong> The name of the directory containing your script. Note: Your script must be located in a directory INSIDE your <kbd>application</kbd> folder, so the file path is relative to that folder. For example, if your script is located in <dfn>application/hooks</dfn>, you will simply use <samp>hooks</samp> as your filepath. If your script is located in <dfn>application/hooks/utilities</dfn> you will use <samp>hooks/utilities</samp> as your filepath. No trailing slash.</li> |
||||
<li><strong>params</strong> Any parameters you wish to pass to your script. This item is optional.</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Multiple Calls to the Same Hook</h2> |
||||
|
||||
<p>If want to use the same hook point with more then one script, simply make your array declaration multi-dimensional, like this:</p> |
||||
|
||||
<code> |
||||
$hook['pre_controller']<kbd>[]</kbd> = array(<br /> |
||||
'class' => 'MyClass',<br /> |
||||
'function' => 'Myfunction',<br /> |
||||
'filename' => 'Myclass.php',<br /> |
||||
'filepath' => 'hooks',<br /> |
||||
'params' => array('beer', 'wine', 'snacks')<br /> |
||||
);<br /> |
||||
<br /> |
||||
$hook['pre_controller']<kbd>[]</kbd> = array(<br /> |
||||
'class' => 'MyOtherClass',<br /> |
||||
'function' => 'MyOtherfunction',<br /> |
||||
'filename' => 'Myotherclass.php',<br /> |
||||
'filepath' => 'hooks',<br /> |
||||
'params' => array('red', 'yellow', 'blue')<br /> |
||||
);</code> |
||||
|
||||
<p>Notice the brackets after each array index:</p> |
||||
|
||||
<code>$hook['pre_controller']<kbd>[]</kbd></code> |
||||
|
||||
<p>This permits you to have the same hook point with multiple scripts. The order you define your array will be the execution order.</p> |
||||
|
||||
|
||||
<h2>Hook Points</h2> |
||||
|
||||
<p>The following is a list of available hook points.</p> |
||||
|
||||
<ul> |
||||
<li><strong>pre_system</strong><br /> |
||||
Called very early during system execution. Only the benchmark and hooks class have been loaded at this point. No routing or other processes have happened.</li> |
||||
<li><strong>pre_controller</strong><br /> |
||||
Called immediately prior to any of your controllers being called. All base classes, routing, and security checks have been done.</li> |
||||
<li><strong>post_controller_constructor</strong><br /> |
||||
Called immediately after your controller is instantiated, but prior to any method calls happening.</li> |
||||
<li><strong>post_controller</strong><br /> |
||||
Called immediately after your controller is fully executed.</li> |
||||
<li><strong>display_override</strong><br /> |
||||
Overrides the <dfn>_display()</dfn> function, used to send the finalized page to the web browser at the end of system execution. This permits you to |
||||
use your own display methodology. Note that you will need to reference the CI superobject with <dfn>$this->CI =& get_instance()</dfn> and then the finalized data will be available by calling <dfn>$this->CI->output->get_output()</dfn></li> |
||||
<li><strong>cache_override</strong><br /> |
||||
Enables you to call your own function instead of the <dfn>_display_cache()</dfn> function in the output class. This permits you to use your own cache display mechanism.</li> |
||||
<li><strong>post_system</strong><br /> |
||||
Called after the final rendered page is sent to the browser, at the end of system execution after the finalized data is sent to the browser.</li> |
||||
</ul> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="core_classes.html">Creating Core Classes</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="autoloader.html">Auto-loading Resources</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,98 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Using CodeIgniter Libraries : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Using CodeIgniter Libraries |
||||
</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>Using CodeIgniter Libraries</h1> |
||||
|
||||
|
||||
<p>All of the available libraries are located in your <dfn>system/libraries</dfn> folder. |
||||
In most cases, to use one of these classes involves initializing it within a <a href="controllers.html">controller</a> using the following initialization function:</p> |
||||
|
||||
<code>$this->load->library('<var>class name</var>'); </code> |
||||
|
||||
<p>Where <var>class name</var> is the name of the class you want to invoke. For example, to load the form validation class you would do this:</p> |
||||
|
||||
<code>$this->load->library('<var>form_validation</var>'); </code> |
||||
|
||||
<p>Once initialized you can use it as indicated in the user guide page corresponding to that class.</p> |
||||
|
||||
<p>Additionally, multiple libraries can be loaded at the same time by passing an array of libraries to the load function.</p> |
||||
|
||||
<code>$this->load->library(array('<var>email</var>', '<var>table</var>'));</code> |
||||
|
||||
<h2>Creating Your Own Libraries</h2> |
||||
|
||||
<p>Please read the section of the user guide that discusses how to <a href="creating_libraries.html">create your own libraries</a></p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="helpers.html">Helpers</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="creating_libraries.html">Creating Libraries</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,133 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Managing your Applications : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Managing your Applications |
||||
</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>Managing your Applications</h1> |
||||
|
||||
<p>By default it is assumed that you only intend to use CodeIgniter to manage one application, which you will build in your |
||||
<dfn>application/</dfn> directory. It is possible, however, to have multiple sets of applications that share a single |
||||
CodeIgniter installation, or even to rename or relocate your <dfn>application</dfn> folder.</p> |
||||
|
||||
<h2>Renaming the Application Folder</h2> |
||||
|
||||
<p>If you would like to rename your <dfn>application</dfn> folder you may do so as long as you open your main <kbd>index.php</kbd> |
||||
file and set its name using the <samp>$application_folder</samp> variable:</p> |
||||
|
||||
<code>$application_folder = "application";</code> |
||||
|
||||
<h2>Relocating your Application Folder</h2> |
||||
|
||||
<p>It is possible to move your <dfn>application</dfn> folder to a different location on your server than your <kbd>system</kbd> folder. |
||||
To do so open your main <kbd>index.php</kbd> and set a <em>full server path</em> in the <samp>$application_folder</samp> variable.</p> |
||||
|
||||
|
||||
<code>$application_folder = "/Path/to/your/application";</code> |
||||
|
||||
|
||||
<h2>Running Multiple Applications with one CodeIgniter Installation</h2> |
||||
|
||||
<p>If you would like to share a common CodeIgniter installation to manage several different applications simply |
||||
put all of the directories located inside your <kbd>application</kbd> folder into their |
||||
own sub-folder.</p> |
||||
|
||||
<p>For example, let's say you want to create two applications, "foo" and "bar". You could structure your |
||||
application folders like this:</p> |
||||
|
||||
<code>applications/<var>foo</var>/<br /> |
||||
applications/<var>foo</var>/config/<br /> |
||||
applications/<var>foo</var>/controllers/<br /> |
||||
applications/<var>foo</var>/errors/<br /> |
||||
applications/<var>foo</var>/libraries/<br /> |
||||
applications/<var>foo</var>/models/<br /> |
||||
applications/<var>foo</var>/views/<br /> |
||||
applications/<samp>bar</samp>/<br /> |
||||
applications/<samp>bar</samp>/config/<br /> |
||||
applications/<samp>bar</samp>/controllers/<br /> |
||||
applications/<samp>bar</samp>/errors/<br /> |
||||
applications/<samp>bar</samp>/libraries/<br /> |
||||
applications/<samp>bar</samp>/models/<br /> |
||||
applications/<samp>bar</samp>/views/</code> |
||||
|
||||
|
||||
<p>To select a particular application for use requires that you open your main <kbd>index.php</kbd> file and set the <dfn>$application_folder</dfn> |
||||
variable. For example, to select the "foo" application for use you would do this:</p> |
||||
|
||||
<code>$application_folder = "applications/foo";</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> Each of your applications will need its own <dfn>index.php</dfn> file which |
||||
calls the desired application. The index.php file can be named anything you want.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="profiling.html">Profiling Your Application</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="alternative_php.html">Alternative PHP Syntax</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,251 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Models : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Models |
||||
</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>Models</h1> |
||||
|
||||
<p>Models are <strong>optionally</strong> available for those who want to use a more traditional MVC approach.</p> |
||||
|
||||
|
||||
|
||||
<ul> |
||||
<li><a href="#what">What is a Model?</a></li> |
||||
<li><a href="#anatomy">Anatomy of a Model</a></li> |
||||
<li><a href="#loading">Loading a Model</a></li> |
||||
<li><a href="#auto_load_model">Auto-Loading a Model</a> </li> |
||||
<li><a href="#conn">Connecting to your Database</a></li> |
||||
</ul> |
||||
|
||||
|
||||
|
||||
<h2><a name="what"></a>What is a Model?</h2> |
||||
|
||||
<p>Models are PHP classes that are designed to work with information in your database. For example, let's say |
||||
you use CodeIgniter to manage a blog. You might have a model class that contains functions to insert, update, and |
||||
retrieve your blog data. Here is an example of what such a model class might look like:</p> |
||||
|
||||
<code> |
||||
class Blogmodel extends CI_Model {<br /> |
||||
<br /> |
||||
var $title = '';<br /> |
||||
var $content = '';<br /> |
||||
var $date = '';<br /> |
||||
<br /> |
||||
function __construct()<br /> |
||||
{<br /> |
||||
// Call the Model constructor<br /> |
||||
parent::__construct();<br /> |
||||
}<br /> |
||||
<br /> |
||||
function get_last_ten_entries()<br /> |
||||
{<br /> |
||||
$query = $this->db->get('entries', 10);<br /> |
||||
return $query->result();<br /> |
||||
}<br /> |
||||
<br /> |
||||
function insert_entry()<br /> |
||||
{<br /> |
||||
$this->title = $_POST['title']; // please read the below note<br /> |
||||
$this->content = $_POST['content'];<br /> |
||||
$this->date = time();<br /> |
||||
<br /> |
||||
$this->db->insert('entries', $this);<br /> |
||||
}<br /> |
||||
<br /> |
||||
function update_entry()<br /> |
||||
{<br /> |
||||
$this->title = $_POST['title'];<br /> |
||||
$this->content = $_POST['content'];<br /> |
||||
$this->date = time();<br /> |
||||
<br /> |
||||
$this->db->update('entries', $this, array('id' => $_POST['id']));<br /> |
||||
}<br /> |
||||
<br /> |
||||
}</code> |
||||
|
||||
<p>Note: The functions in the above example use the <a href="../database/active_record.html">Active Record</a> database functions.</p> |
||||
<p class="important"><strong>Note:</strong> For the sake of simplicity in this example we're using $_POST directly. This is generally bad practice, and a more common approach would be to use the <a href="../libraries/input.html">Input Class</a> $this->input->post('title')</p> |
||||
<h2><a name="anatomy"></a>Anatomy of a Model</h2> |
||||
|
||||
<p>Model classes are stored in your <dfn>application/models/</dfn> folder. They can be nested within sub-folders if you |
||||
want this type of organization.</p> |
||||
|
||||
<p>The basic prototype for a model class is this:</p> |
||||
|
||||
|
||||
<code> |
||||
class <var>Model_name</var> extends CI_Model {<br /> |
||||
<br /> |
||||
function <var>__construct</var>()<br /> |
||||
{<br /> |
||||
parent::__construct();<br /> |
||||
}<br /> |
||||
}</code> |
||||
|
||||
<p>Where <var>Model_name</var> is the name of your class. Class names <strong>must</strong> have the first letter capitalized with the rest of the name lowercase. |
||||
Make sure your class extends the base Model class.</p> |
||||
|
||||
<p>The file name will be a lower case version of your class name. For example, if your class is this:</p> |
||||
|
||||
<code> |
||||
class <var>User_model</var> extends CI_Model {<br /> |
||||
<br /> |
||||
function <var>__construct</var>()<br /> |
||||
{<br /> |
||||
parent::__construct();<br /> |
||||
}<br /> |
||||
}</code> |
||||
|
||||
<p>Your file will be this:</p> |
||||
|
||||
<code>application/models/<var>user_model.php</var></code> |
||||
|
||||
|
||||
|
||||
<h2><a name="loading"></a>Loading a Model</h2> |
||||
|
||||
<p>Your models will typically be loaded and called from within your <a href="controllers.html">controller</a> functions. |
||||
To load a model you will use the following function:</p> |
||||
|
||||
<code>$this->load->model('<var>Model_name</var>');</code> |
||||
|
||||
<p>If your model is located in a sub-folder, include the relative path from your models folder. For example, if |
||||
you have a model located at <dfn>application/models/blog/queries.php</dfn> you'll load it using:</p> |
||||
|
||||
<code>$this->load->model('<var>blog/queries</var>');</code> |
||||
|
||||
|
||||
<p>Once loaded, you will access your model functions using an object with the same name as your class:</p> |
||||
|
||||
<code> |
||||
$this->load->model('<var>Model_name</var>');<br /> |
||||
<br /> |
||||
$this-><var>Model_name</var>->function(); |
||||
</code> |
||||
|
||||
<p>If you would like your model assigned to a different object name you can specify it via the second parameter of the loading |
||||
function:</p> |
||||
|
||||
|
||||
<code> |
||||
$this->load->model('<var>Model_name</var>', '<kbd>fubar</kbd>');<br /> |
||||
<br /> |
||||
$this-><kbd>fubar</kbd>->function(); |
||||
</code> |
||||
|
||||
<p>Here is an example of a controller, that loads a model, then serves a view:</p> |
||||
|
||||
<code> |
||||
class Blog_controller extends CI_Controller {<br /> |
||||
<br /> |
||||
function blog()<br /> |
||||
{<br /> |
||||
$this->load->model('Blog');<br /> |
||||
<br /> |
||||
$data['query'] = $this->Blog->get_last_ten_entries();<br /><br /> |
||||
$this->load->view('blog', $data);<br /> |
||||
}<br /> |
||||
}</code> |
||||
|
||||
<h2><a name="auto_load_model" id="auto_load_model"></a>Auto-loading Models</h2> |
||||
<p>If you find that you need a particular model globally throughout your application, you can tell CodeIgniter to auto-load it during system initialization. This is done by opening the application/config/autoload.php file and adding the model to the autoload array.</p> |
||||
|
||||
|
||||
<h2><a name="conn"></a>Connecting to your Database</h2> |
||||
|
||||
<p>When a model is loaded it does <strong>NOT</strong> connect automatically to your database. The following options for connecting are available to you:</p> |
||||
|
||||
<ul> |
||||
<li>You can connect using the standard database methods <a href="../database/connecting.html">described here</a>, either from within your Controller class or your Model class.</li> |
||||
<li>You can tell the model loading function to auto-connect by passing <kbd>TRUE</kbd> (boolean) via the third parameter, |
||||
and connectivity settings, as defined in your database config file will be used: |
||||
|
||||
<code>$this->load->model('<var>Model_name</var>', '', <kbd>TRUE</kbd>);</code> |
||||
</li> |
||||
|
||||
|
||||
<li>You can manually pass database connectivity settings via the third parameter: |
||||
|
||||
|
||||
<code>$config['hostname'] = "localhost";<br /> |
||||
$config['username'] = "myusername";<br /> |
||||
$config['password'] = "mypassword";<br /> |
||||
$config['database'] = "mydatabase";<br /> |
||||
$config['dbdriver'] = "mysql";<br /> |
||||
$config['dbprefix'] = "";<br /> |
||||
$config['pconnect'] = FALSE;<br /> |
||||
$config['db_debug'] = TRUE;<br /> |
||||
<br /> |
||||
$this->load->model('<var>Model_name</var>', '', <kbd>$config</kbd>);</code></li> |
||||
</ul> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="views.html">Views</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="helpers.html">Helpers</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,181 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Profiling Your Application : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Profiling Your Application |
||||
</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>Profiling Your Application</h1> |
||||
|
||||
<p>The Profiler Class will display benchmark results, queries you have run, and $_POST data at the bottom of your pages. |
||||
This information can be useful during development in order to help with debugging and optimization.</p> |
||||
|
||||
|
||||
<h2>Initializing the Class</h2> |
||||
|
||||
<p class="important"><strong>Important:</strong> This class does <kbd>NOT</kbd> need to be initialized. It is loaded automatically by the |
||||
<a href="../libraries/output.html">Output Class</a> if profiling is enabled as shown below.</p> |
||||
|
||||
<h2>Enabling the Profiler</h2> |
||||
|
||||
<p>To enable the profiler place the following function anywhere within your <a href="controllers.html">Controller</a> functions:</p> |
||||
<code>$this->output->enable_profiler(TRUE);</code> |
||||
|
||||
<p>When enabled a report will be generated and inserted at the bottom of your pages.</p> |
||||
|
||||
<p>To disable the profiler you will use:</p> |
||||
<code>$this->output->enable_profiler(FALSE);</code> |
||||
|
||||
|
||||
<h2>Setting Benchmark Points</h2> |
||||
|
||||
<p>In order for the Profiler to compile and display your benchmark data you must name your mark points using specific syntax.</p> |
||||
|
||||
<p>Please read the information on setting Benchmark points in <a href="../libraries/benchmark.html">Benchmark Class</a> page.</p> |
||||
|
||||
|
||||
<h2>Enabling and Disabling Profiler Sections</h2> |
||||
|
||||
<p>Each section of Profiler data can be enabled or disabled by setting a corresponding config variable to <var>TRUE</var> or <var>FALSE</var>. This can be done one of two ways. First, you can set application wide defaults with the <dfn>application/config/profiler.php</dfn> config file.</p> |
||||
|
||||
<code>$config['config'] = FALSE;<br /> |
||||
$config['queries'] = FALSE;<br /></code> |
||||
|
||||
<p>In your controllers, you can override the defaults and config file values by calling the <kbd>set_profiler_sections()</kbd> method of the <a href="../libraries/output.html">Output class</a>:</p> |
||||
|
||||
<code>$sections = array(<br /> |
||||
'config' => TRUE,<br /> |
||||
'queries' => TRUE<br /> |
||||
);<br /> |
||||
<br /> |
||||
$this->output->set_profiler_sections($sections);</code> |
||||
|
||||
<p>Available sections and the array key used to access them are described in the table below.</p> |
||||
|
||||
<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder"> |
||||
<tr> |
||||
<th>Key</th> |
||||
<th>Description</th> |
||||
<th>Default</th> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>benchmarks</strong></td> |
||||
<td class="td">Elapsed time of Benchmark points and total execution time</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>config</strong></td> |
||||
<td class="td">CodeIgniter Config variables</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>controller_info</strong></td> |
||||
<td class="td">The Controller class and method requested</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>get</strong></td> |
||||
<td class="td">Any GET data passed in the request</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>http_headers</strong></td> |
||||
<td class="td">The HTTP headers for the current request</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>memory_usage</strong></td> |
||||
<td class="td">Amount of memory consumed by the current request, in bytes</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>post</strong></td> |
||||
<td class="td">Any POST data passed in the request</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>queries</strong></td> |
||||
<td class="td">Listing of all database queries executed, including execution time</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>uri_string</strong></td> |
||||
<td class="td">The URI of the current request</td> |
||||
<td class="td">TRUE</td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td"><strong>query_toggle_count</strong></td> |
||||
<td class="td">The number of queries after which the query block will default to hidden.</td> |
||||
<td class="td">25</td> |
||||
</tr> |
||||
</table> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="caching.html">Caching</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="managing_apps.html">Managing Applications</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,77 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Quick Reference Chart : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Quick Reference Chart |
||||
</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>Quick Reference Chart</h1> |
||||
|
||||
<p>For a PDF version of this chart, <a href="http://codeigniter.com/download_files/ci_quick_ref.pdf">click here</a>.</p> |
||||
|
||||
<p><img src="../images/ci_quick_ref.png" width="763" height="994" border="0" /></p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,82 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Server Requirements : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Server Requirements |
||||
</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>Server Requirements</h1> |
||||
|
||||
<ul> |
||||
<li><a href="http://www.php.net/">PHP</a> version 5.1.6 or newer.</li> |
||||
<li>A Database is required for most web application programming. Current supported databases are MySQL (4.1+), MySQLi, MS SQL, Postgres, Oracle, SQLite, and ODBC.</li> |
||||
</ul> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="../license.html">License Agreement</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,128 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<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='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_darker.jpg" width="154" height="43" 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 2.1.3</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 any of these:</p> |
||||
<ul> |
||||
<li>Controller</li> |
||||
<li>CI_Base</li> |
||||
<li>_ci_initialize</li> |
||||
<li>Default</li> |
||||
<li>index</li> |
||||
</ul> |
||||
<h3>Functions</h3> |
||||
<ul> |
||||
<li>is_really_writable()</li> |
||||
<li>load_class()</li> |
||||
<li>get_config()</li> |
||||
<li>config_item()</li> |
||||
<li>show_error()</li> |
||||
<li>show_404()</li> |
||||
<li>log_message()</li> |
||||
<li>_exception_handler()</li> |
||||
<li>get_instance()</li> |
||||
</ul> |
||||
<h3>Variables</h3> |
||||
<ul> |
||||
<li>$config</li> |
||||
<li>$mimes</li> |
||||
<li>$lang</li> |
||||
</ul> |
||||
<h3>Constants</h3> |
||||
<ul> |
||||
<li>ENVIRONMENT</li> |
||||
<li>EXT</li> |
||||
<li>FCPATH</li> |
||||
<li>SELF</li> |
||||
<li>BASEPATH</li> |
||||
<li>APPPATH</li> |
||||
<li>CI_VERSION</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="controllers.html">Controllers</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> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,171 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>URI Routing : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
URI Routing |
||||
</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>URI Routing</h1> |
||||
|
||||
<p>Typically there is a one-to-one relationship between a URL string and its corresponding controller class/method. |
||||
The segments in a URI normally follow this pattern:</p> |
||||
|
||||
<code>example.com/<dfn>class</dfn>/<samp>function</samp>/<var>id</var>/</code> |
||||
|
||||
<p>In some instances, however, you may want to remap this relationship so that a different class/function can be called |
||||
instead of the one corresponding to the URL.</p> |
||||
|
||||
<p>For example, lets say you want your URLs to have this prototype:</p> |
||||
|
||||
<p> |
||||
example.com/product/1/<br /> |
||||
example.com/product/2/<br /> |
||||
example.com/product/3/<br /> |
||||
example.com/product/4/ |
||||
</p> |
||||
|
||||
<p>Normally the second segment of the URL is reserved for the function name, but in the example above it instead has a product ID. |
||||
To overcome this, CodeIgniter allows you to remap the URI handler.</p> |
||||
|
||||
|
||||
<h2>Setting your own routing rules</h2> |
||||
|
||||
<p>Routing rules are defined in your <var>application/config/routes.php</var> file. In it you'll see an array called <dfn>$route</dfn> that |
||||
permits you to specify your own routing criteria. Routes can either be specified using <dfn>wildcards</dfn> or <dfn>Regular Expressions</dfn></p> |
||||
|
||||
|
||||
<h2>Wildcards</h2> |
||||
|
||||
<p>A typical wildcard route might look something like this:</p> |
||||
|
||||
<code>$route['product/:num'] = "catalog/product_lookup";</code> |
||||
|
||||
<p>In a route, the array key contains the URI to be matched, while the array value contains the destination it should be re-routed to. |
||||
In the above example, if the literal word "product" is found in the first segment of the URL, and a number is found in the second segment, |
||||
the "catalog" class and the "product_lookup" method are instead used.</p> |
||||
|
||||
<p>You can match literal values or you can use two wildcard types:</p> |
||||
|
||||
<p><strong>(:num)</strong> will match a segment containing only numbers.<br /> |
||||
<strong>(:any)</strong> will match a segment containing any character. |
||||
</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> Routes will run in the order they are defined. |
||||
Higher routes will always take precedence over lower ones.</p> |
||||
|
||||
<h2>Examples</h2> |
||||
|
||||
<p>Here are a few routing examples:</p> |
||||
|
||||
<code>$route['journals'] = "blogs";</code> |
||||
<p>A URL containing the word "journals" in the first segment will be remapped to the "blogs" class.</p> |
||||
|
||||
<code>$route['blog/joe'] = "blogs/users/34";</code> |
||||
<p>A URL containing the segments blog/joe will be remapped to the "blogs" class and the "users" method. The ID will be set to "34".</p> |
||||
|
||||
<code>$route['product/(:any)'] = "catalog/product_lookup";</code> |
||||
<p>A URL with "product" as the first segment, and anything in the second will be remapped to the "catalog" class and the "product_lookup" method.</p> |
||||
|
||||
<code>$route['product/(:num)'] = "catalog/product_lookup_by_id/$1";</code> |
||||
<p>A URL with "product" as the first segment, and a number in the second will be remapped to the "catalog" class and the "product_lookup_by_id" method passing in the match as a variable to the function.</p> |
||||
|
||||
<p class="important"><strong>Important:</strong> Do not use leading/trailing slashes.</p> |
||||
|
||||
<h2>Regular Expressions</h2> |
||||
|
||||
<p>If you prefer you can use regular expressions to define your routing rules. Any valid regular expression is allowed, as are back-references.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you use back-references you must use the dollar syntax rather than the double backslash syntax.</p> |
||||
|
||||
<p>A typical RegEx route might look something like this:</p> |
||||
|
||||
<code>$route['products/([a-z]+)/(\d+)'] = "$1/id_$2";</code> |
||||
|
||||
<p>In the above example, a URI similar to <dfn>products/shirts/123</dfn> would instead call the <dfn>shirts</dfn> controller class and the <dfn>id_123</dfn> function.</p> |
||||
|
||||
<p>You can also mix and match wildcards with regular expressions.</p> |
||||
|
||||
<h2>Reserved Routes</h2> |
||||
|
||||
<p>There are two reserved routes:</p> |
||||
|
||||
<code>$route['default_controller'] = 'welcome';</code> |
||||
|
||||
<p>This route indicates which controller class should be loaded if the URI contains no data, which will be the case |
||||
when people load your root URL. In the above example, the "welcome" class would be loaded. You |
||||
are encouraged to always have a default route otherwise a 404 page will appear by default.</p> |
||||
|
||||
<code>$route['404_override'] = '';</code> |
||||
|
||||
<p>This route indicates which controller class should be loaded if the requested controller is not found. It will override the default 404 |
||||
error page. It won't affect to the <samp>show_404()</samp> function, which will continue loading the default <dfn>error_404.php</dfn> file at <var>application/errors/error_404.php</var>.</p> |
||||
|
||||
<p class="important"><strong>Important:</strong> The reserved routes must come before any wildcard or regular expression routes.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
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="errors.html">Error Handling</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,164 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Security : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Security |
||||
</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>Security</h1> |
||||
|
||||
<p>This page describes some "best practices" regarding web security, and details |
||||
CodeIgniter's internal security features.</p> |
||||
|
||||
|
||||
<h2>URI Security</h2> |
||||
|
||||
<p>CodeIgniter is fairly restrictive regarding which characters it allows in your URI strings in order to help |
||||
minimize the possibility that malicious data can be passed to your application. URIs may only contain the following: |
||||
</p> |
||||
|
||||
<ul> |
||||
<li>Alpha-numeric text</li> |
||||
<li>Tilde: ~ </li> |
||||
<li>Period: .</li> |
||||
<li>Colon: :</li> |
||||
<li>Underscore: _</li> |
||||
<li>Dash: -</li> |
||||
</ul> |
||||
|
||||
<h2>Register_globals</h2> |
||||
|
||||
<p>During system initialization all global variables are unset, except those found in the $_GET, $_POST, and $_COOKIE arrays. The unsetting |
||||
routine is effectively the same as register_globals = off.</p> |
||||
|
||||
<a name="error_reporting"></a> |
||||
<h2>error_reporting</h2> |
||||
|
||||
<p> |
||||
In production environments, it is typically desirable to disable PHP's |
||||
error reporting by setting the internal error_reporting flag to a value of 0. This disables native PHP |
||||
errors from being rendered as output, which may potentially contain |
||||
sensitive information. |
||||
</p> |
||||
|
||||
<p> |
||||
Setting CodeIgniter's <kbd>ENVIRONMENT</kbd> constant in index.php to a |
||||
value of '<kbd>production</kbd>' will turn off these errors. In development |
||||
mode, it is recommended that a value of '<kbd>development</kbd>' is used. |
||||
More information about differentiating between environments can be found |
||||
on the <a href="environments.html">Handling Environments</a> page. |
||||
</p> |
||||
|
||||
<h2>magic_quotes_runtime</h2> |
||||
|
||||
<p>The magic_quotes_runtime directive is turned off during system initialization so that you don't have to remove slashes when |
||||
retrieving data from your database.</p> |
||||
|
||||
<h1>Best Practices</h1> |
||||
|
||||
<p>Before accepting any data into your application, whether it be POST data from a form submission, COOKIE data, URI data, |
||||
XML-RPC data, or even data from the SERVER array, you are encouraged to practice this three step approach:</p> |
||||
|
||||
<ol> |
||||
<li>Filter the data as if it were tainted.</li> |
||||
<li>Validate the data to ensure it conforms to the correct type, length, size, etc. (sometimes this step can replace step one)</li> |
||||
<li>Escape the data before submitting it into your database.</li> |
||||
</ol> |
||||
|
||||
<p>CodeIgniter provides the following functions to assist in this process:</p> |
||||
|
||||
<ul> |
||||
|
||||
<li><h2>XSS Filtering</h2> |
||||
|
||||
<p>CodeIgniter comes with a Cross Site Scripting filter. This filter looks for commonly |
||||
used techniques to embed malicious Javascript into your data, or other types of code that attempt to hijack cookies |
||||
or do other malicious things. The XSS Filter is described <a href="../libraries/security.html">here</a>. |
||||
</p> |
||||
</li> |
||||
|
||||
<li><h2>Validate the data</h2> |
||||
|
||||
<p>CodeIgniter has a <a href="../libraries/form_validation.html">Form Validation Class</a> that assists you in validating, filtering, and prepping |
||||
your data.</p> |
||||
</li> |
||||
|
||||
<li><h2>Escape all data before database insertion</h2> |
||||
|
||||
<p>Never insert information into your database without escaping it. Please see the section that discusses |
||||
<a href="../database/queries.html">queries</a> for more information.</p> |
||||
|
||||
</li> |
||||
|
||||
</ul> |
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="alternative_php.html">Alternative PHP</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="styleguide.html">PHP Style Guide</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,679 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Style Guide : 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' /> |
||||
|
||||
<style type="text/css" media="screen"> |
||||
code { |
||||
white-space: pre; |
||||
} |
||||
</style> |
||||
|
||||
<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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Style Guide |
||||
</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>General Style and Syntax</h1> |
||||
|
||||
<p>The following page describes the use of coding rules adhered to when developing CodeIgniter.</p> |
||||
|
||||
|
||||
<h2>Table of Contents</h2> |
||||
<ul class="minitoc"> |
||||
<li><a href="#file_format">File Format</a></li> |
||||
<li><a href="#php_closing_tag">PHP Closing Tag</a></li> |
||||
<li><a href="#class_and_method_naming">Class and Method Naming</a></li> |
||||
<li><a href="#variable_names">Variable Names</a></li> |
||||
<li><a href="#commenting">Commenting</a></li> |
||||
<li><a href="#constants">Constants</a></li> |
||||
<li><a href="#true_false_and_null">TRUE, FALSE, and NULL</a></li> |
||||
<li><a href="#logical_operators">Logical Operators</a></li> |
||||
<li><a href="#comparing_return_values_and_typecasting">Comparing Return Values and Typecasting</a></li> |
||||
<li><a href="#debugging_code">Debugging Code</a></li> |
||||
<li><a href="#whitespace_in_files">Whitespace in Files</a></li> |
||||
<li><a href="#compatibility">Compatibility</a></li> |
||||
<li><a href="#class_and_file_names_using_common_words">Class and File Names using Common Words</a></li> |
||||
<li><a href="#database_table_names">Database Table Names</a></li> |
||||
<li><a href="#one_file_per_class">One File per Class</a></li> |
||||
<li><a href="#whitespace">Whitespace</a></li> |
||||
<li><a href="#line_breaks">Line Breaks</a></li> |
||||
<li><a href="#code_indenting">Code Indenting</a></li> |
||||
<li><a href="#bracket_spacing">Bracket and Parenthetic Spacing</li> |
||||
<li><a href="#localized_text">Localized Text</a></li> |
||||
<li><a href="#private_methods_and_variables">Private Methods and Variables</a></li> |
||||
<li><a href="#php_errors">PHP Errors</a></li> |
||||
<li><a href="#short_open_tags">Short Open Tags</a></li> |
||||
<li><a href="#one_statement_per_line">One Statement Per Line</a></li> |
||||
<li><a href="#strings">Strings</a></li> |
||||
<li><a href="#sql_queries">SQL Queries</a></li> |
||||
<li><a href="#default_function_arguments">Default Function Arguments</a></li> |
||||
</ul> |
||||
|
||||
<li> |
||||
|
||||
<h2><a name="file_format"></a>File Format</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Files should be saved with Unicode (UTF-8) encoding. The <abbr title="Byte Order Mark">BOM</abbr> |
||||
should <em>not</em> be used. Unlike UTF-16 and UTF-32, there's no byte order to indicate in |
||||
a UTF-8 encoded file, and the <abbr title="Byte Order Mark">BOM</abbr> can have a negative side effect in PHP of sending output, |
||||
preventing the application from being able to set its own headers. Unix line endings should |
||||
be used (LF).</p> |
||||
|
||||
<p>Here is how to apply these settings in some of the more common text editors. Instructions for your |
||||
text editor may vary; check your text editor's documentation.</p> |
||||
|
||||
<h5>TextMate</h5> |
||||
|
||||
<ol> |
||||
<li>Open the Application Preferences</li> |
||||
<li>Click Advanced, and then the "Saving" tab</li> |
||||
<li>In "File Encoding", select "UTF-8 (recommended)"</li> |
||||
<li>In "Line Endings", select "LF (recommended)"</li> |
||||
<li><em>Optional:</em> Check "Use for existing files as well" if you wish to modify the line |
||||
endings of files you open to your new preference.</li> |
||||
</ol> |
||||
|
||||
<h5>BBEdit</h5> |
||||
|
||||
<ol> |
||||
<li>Open the Application Preferences</li> |
||||
<li>Select "Text Encodings" on the left.</li> |
||||
<li>In "Default text encoding for new documents", select "Unicode (UTF-8, no BOM)"</li> |
||||
<li><em>Optional:</em> In "If file's encoding can't be guessed, use", select |
||||
"Unicode (UTF-8, no BOM)"</li> |
||||
<li>Select "Text Files" on the left.</li> |
||||
<li>In "Default line breaks", select "Mac OS X and Unix (LF)"</li> |
||||
</ol> |
||||
</div> |
||||
|
||||
<h2><a name="php_closing_tag"></a>PHP Closing Tag</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>The PHP closing tag on a PHP document <strong>?></strong> is optional to the PHP parser. However, if used, any whitespace following the closing tag, whether introduced |
||||
by the developer, user, or an FTP application, can cause unwanted output, PHP errors, or if the latter are suppressed, blank pages. For this reason, all PHP files should |
||||
<strong>OMIT</strong> the closing PHP tag, and instead use a comment block to mark the end of file and it's location relative to the application root. |
||||
This allows you to still identify a file as being complete and not truncated.</p> |
||||
<code><strong>INCORRECT</strong>: |
||||
<?php |
||||
|
||||
echo "Here's my code!"; |
||||
|
||||
?> |
||||
|
||||
<strong>CORRECT</strong>: |
||||
<?php |
||||
|
||||
echo "Here's my code!"; |
||||
|
||||
/* End of file myfile.php */ |
||||
/* Location: ./system/modules/mymodule/myfile.php */ |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
<h2><a name="class_and_method_naming"></a>Class and Method Naming</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Class names should always start with an uppercase letter. Multiple words should be separated with an underscore, and not CamelCased. All other class methods should be entirely lowercased and named to clearly indicate their function, preferably including a verb. Try to avoid overly long and verbose names.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
class superclass |
||||
class SuperClass |
||||
|
||||
<strong>CORRECT</strong>: |
||||
class Super_class</code> |
||||
|
||||
|
||||
<code>class Super_class { |
||||
|
||||
function __construct() |
||||
{ |
||||
|
||||
} |
||||
}</code> |
||||
|
||||
<p>Examples of improper and proper method naming:</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
function fileproperties() // not descriptive and needs underscore separator |
||||
function fileProperties() // not descriptive and uses CamelCase |
||||
function getfileproperties() // Better! But still missing underscore separator |
||||
function getFileProperties() // uses CamelCase |
||||
function get_the_file_properties_from_the_file() // wordy |
||||
|
||||
<strong>CORRECT</strong>: |
||||
function get_file_properties() // descriptive, underscore separator, and all lowercase letters</code> |
||||
|
||||
</div> |
||||
|
||||
|
||||
<h2><a name="variable_names"></a>Variable Names</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>The guidelines for variable naming is very similar to that used for class methods. Namely, variables should contain only lowercase letters, use underscore separators, and be reasonably named to indicate their purpose and contents. Very short, non-word variables should only be used as iterators in for() loops.</p> |
||||
<code><strong>INCORRECT</strong>: |
||||
$j = 'foo'; // single letter variables should only be used in for() loops |
||||
$Str // contains uppercase letters |
||||
$bufferedText // uses CamelCasing, and could be shortened without losing semantic meaning |
||||
$groupid // multiple words, needs underscore separator |
||||
$name_of_last_city_used // too long |
||||
|
||||
<strong>CORRECT</strong>: |
||||
for ($j = 0; $j < 10; $j++) |
||||
$str |
||||
$buffer |
||||
$group_id |
||||
$last_city |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
<h2><a name="commenting"></a>Commenting</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>In general, code should be commented prolifically. It not only helps describe the flow and intent of the code for less experienced programmers, but can prove invaluable when returning to your own code months down the line. There is not a required format for comments, but the following are recommended.</p> |
||||
|
||||
<p><a href="http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblock">DocBlock</a> style comments preceding class and method declarations so they can be picked up by IDEs:</p> |
||||
|
||||
<code>/** |
||||
* Super Class |
||||
* |
||||
* @package Package Name |
||||
* @subpackage Subpackage |
||||
* @category Category |
||||
* @author Author Name |
||||
* @link http://example.com |
||||
*/ |
||||
class Super_class {</code> |
||||
|
||||
<code>/** |
||||
* Encodes string for use in XML |
||||
* |
||||
* @access public |
||||
* @param string |
||||
* @return string |
||||
*/ |
||||
function xml_encode($str)</code> |
||||
|
||||
<p>Use single line comments within code, leaving a blank line between large comment blocks and code.</p> |
||||
|
||||
<code>// break up the string by newlines |
||||
$parts = explode("\n", $str); |
||||
|
||||
// A longer comment that needs to give greater detail on what is |
||||
// occurring and why can use multiple single-line comments. Try to |
||||
// keep the width reasonable, around 70 characters is the easiest to |
||||
// read. Don't hesitate to link to permanent external resources |
||||
// that may provide greater detail: |
||||
// |
||||
// http://example.com/information_about_something/in_particular/ |
||||
|
||||
$parts = $this->foo($parts); |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
<h2><a name="constants"></a>Constants</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Constants follow the same guidelines as do variables, except constants should always be fully uppercase. <em>Always use CodeIgniter constants when appropriate, i.e. SLASH, LD, RD, PATH_CACHE, etc.</em></p> |
||||
<code><strong>INCORRECT</strong>: |
||||
myConstant // missing underscore separator and not fully uppercase |
||||
N // no single-letter constants |
||||
S_C_VER // not descriptive |
||||
$str = str_replace('{foo}', 'bar', $str); // should use LD and RD constants |
||||
|
||||
<strong>CORRECT</strong>: |
||||
MY_CONSTANT |
||||
NEWLINE |
||||
SUPER_CLASS_VERSION |
||||
$str = str_replace(LD.'foo'.RD, 'bar', $str); |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
<h2><a name="true_false_and_null"></a>TRUE, FALSE, and NULL</h2> |
||||
<div class="guidelineDetails"> |
||||
<p><strong>TRUE</strong>, <strong>FALSE</strong>, and <strong>NULL</strong> keywords should always be fully uppercase.</p> |
||||
<code><strong>INCORRECT</strong>: |
||||
if ($foo == true) |
||||
$bar = false; |
||||
function foo($bar = null) |
||||
|
||||
<strong>CORRECT</strong>: |
||||
if ($foo == TRUE) |
||||
$bar = FALSE; |
||||
function foo($bar = NULL)</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="logical_operators"></a>Logical Operators</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Use of <strong>||</strong> is discouraged as its clarity on some output devices is low (looking like the number 11 for instance). |
||||
<strong>&&</strong> is preferred over <strong>AND</strong> but either are acceptable, and a space should always precede and follow <strong>!</strong>.</p> |
||||
<code><strong>INCORRECT</strong>: |
||||
if ($foo || $bar) |
||||
if ($foo AND $bar) // okay but not recommended for common syntax highlighting applications |
||||
if (!$foo) |
||||
if (! is_array($foo)) |
||||
|
||||
<strong>CORRECT</strong>: |
||||
if ($foo OR $bar) |
||||
if ($foo && $bar) // recommended |
||||
if ( ! $foo) |
||||
if ( ! is_array($foo)) |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="comparing_return_values_and_typecasting"></a>Comparing Return Values and Typecasting</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Some PHP functions return FALSE on failure, but may also have a valid return value of "" or 0, which would evaluate to FALSE in loose comparisons. Be explicit by comparing the variable type when using these return values in conditionals to ensure the return value is indeed what you expect, and not a value that has an equivalent loose-type evaluation.</p> |
||||
<p>Use the same stringency in returning and checking your own variables. Use <strong>===</strong> and <strong>!==</strong> as necessary. |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
// If 'foo' is at the beginning of the string, strpos will return a 0, |
||||
// resulting in this conditional evaluating as TRUE |
||||
if (strpos($str, 'foo') == FALSE) |
||||
|
||||
<strong>CORRECT</strong>: |
||||
if (strpos($str, 'foo') === FALSE) |
||||
</code> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
function build_string($str = "") |
||||
{ |
||||
if ($str == "") // uh-oh! What if FALSE or the integer 0 is passed as an argument? |
||||
{ |
||||
|
||||
} |
||||
} |
||||
|
||||
<strong>CORRECT</strong>: |
||||
function build_string($str = "") |
||||
{ |
||||
if ($str === "") |
||||
{ |
||||
|
||||
} |
||||
}</code> |
||||
|
||||
<p>See also information regarding <a href="http://us3.php.net/manual/en/language.types.type-juggling.php#language.types.typecasting">typecasting</a>, which can be quite useful. Typecasting has a slightly different effect which may be desirable. When casting a variable as a string, for instance, NULL and boolean FALSE variables become empty strings, 0 (and other numbers) become strings of digits, and boolean TRUE becomes "1":</p> |
||||
|
||||
<code>$str = (string) $str; // cast $str as a string</code> |
||||
|
||||
</div> |
||||
|
||||
|
||||
<h2><a name="debugging_code"></a>Debugging Code</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>No debugging code can be left in place for submitted add-ons unless it is commented out, i.e. no var_dump(), print_r(), die(), and exit() calls that were used while creating the add-on, unless they are commented out.</p> |
||||
|
||||
<code>// print_r($foo);</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="whitespace_in_files"></a>Whitespace in Files</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>No whitespace can precede the opening PHP tag or follow the closing PHP tag. Output is buffered, so whitespace in your files can cause output to begin before CodeIgniter outputs its content, leading to errors and an inability for CodeIgniter to send proper headers. In the examples below, select the text with your mouse to reveal the incorrect whitespace.</p> |
||||
|
||||
<p><strong>INCORRECT</strong>:</p> |
||||
<code> |
||||
<?php |
||||
// ...there is whitespace and a linebreak above the opening PHP tag |
||||
// as well as whitespace after the closing PHP tag |
||||
?> |
||||
</code> |
||||
<p><strong>CORRECT</strong>:</p> |
||||
<code><?php |
||||
// this sample has no whitespace before or after the opening and closing PHP tags |
||||
?></code> |
||||
|
||||
</div> |
||||
|
||||
|
||||
<h2><a name="compatibility"></a>Compatibility</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Unless specifically mentioned in your add-on's documentation, all code must be compatible with PHP version 5.1+. Additionally, do not use PHP functions that require non-default libraries to be installed unless your code contains an alternative method when the function is not available, or you implicitly document that your add-on requires said PHP libraries.</p> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="class_and_file_names_using_common_words"></a>Class and File Names using Common Words</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>When your class or filename is a common word, or might quite likely be identically named in another PHP script, provide a unique prefix to help prevent collision. Always realize that your end users may be running other add-ons or third party PHP scripts. Choose a prefix that is unique to your identity as a developer or company.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
class Email pi.email.php |
||||
class Xml ext.xml.php |
||||
class Import mod.import.php |
||||
|
||||
<strong>CORRECT</strong>: |
||||
class Pre_email pi.pre_email.php |
||||
class Pre_xml ext.pre_xml.php |
||||
class Pre_import mod.pre_import.php |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
<h2><a name="database_table_names"></a>Database Table Names</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Any tables that your add-on might use must use the 'exp_' prefix, followed by a prefix uniquely identifying you as the developer or company, and then a short descriptive table name. You do not need to be concerned about the database prefix being used on the user's installation, as CodeIgniter's database class will automatically convert 'exp_' to what is actually being used.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
email_addresses // missing both prefixes |
||||
pre_email_addresses // missing exp_ prefix |
||||
exp_email_addresses // missing unique prefix |
||||
|
||||
<strong>CORRECT</strong>: |
||||
exp_pre_email_addresses |
||||
</code> |
||||
|
||||
<p class="important"><strong>NOTE:</strong> Be mindful that MySQL has a limit of 64 characters for table names. This should not be an issue as table names that would exceed this would likely have unreasonable names. For instance, the following table name exceeds this limitation by one character. Silly, no? <strong>exp_pre_email_addresses_of_registered_users_in_seattle_washington</strong> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="one_file_per_class"></a>One File per Class</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Use separate files for each class your add-on uses, unless the classes are <em>closely related</em>. An example of CodeIgniter files that contains multiple classes is the Database class file, which contains both the DB class and the DB_Cache class, and the Magpie plugin, which contains both the Magpie and Snoopy classes.</p> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="whitespace"></a>Whitespace</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Use tabs for whitespace in your code, not spaces. This may seem like a small thing, but using tabs instead of whitespace allows the developer looking at your code to have indentation at levels that they prefer and customize in whatever application they use. And as a side benefit, it results in (slightly) more compact files, storing one tab character versus, say, four space characters.</p> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="line_breaks"></a>Line Breaks</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Files must be saved with Unix line breaks. This is more of an issue for developers who work in Windows, but in any case ensure that your text editor is setup to save files with Unix line breaks.</p> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="code_indenting"></a>Code Indenting</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Use Allman style indenting. With the exception of Class declarations, braces are always placed on a line by themselves, and indented at the same level as the control statement that "owns" them.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
function foo($bar) { |
||||
// ... |
||||
} |
||||
|
||||
foreach ($arr as $key => $val) { |
||||
// ... |
||||
} |
||||
|
||||
if ($foo == $bar) { |
||||
// ... |
||||
} else { |
||||
// ... |
||||
} |
||||
|
||||
for ($i = 0; $i < 10; $i++) |
||||
{ |
||||
for ($j = 0; $j < 10; $j++) |
||||
{ |
||||
// ... |
||||
} |
||||
} |
||||
|
||||
<strong>CORRECT</strong>: |
||||
function foo($bar) |
||||
{ |
||||
// ... |
||||
} |
||||
|
||||
foreach ($arr as $key => $val) |
||||
{ |
||||
// ... |
||||
} |
||||
|
||||
if ($foo == $bar) |
||||
{ |
||||
// ... |
||||
} |
||||
else |
||||
{ |
||||
// ... |
||||
} |
||||
|
||||
for ($i = 0; $i < 10; $i++) |
||||
{ |
||||
for ($j = 0; $j < 10; $j++) |
||||
{ |
||||
// ... |
||||
} |
||||
}</code> |
||||
</div> |
||||
|
||||
|
||||
<h2><a name="bracket_spacing"></a>Bracket and Parenthetic Spacing</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>In general, parenthesis and brackets should not use any additional spaces. The exception is that a space should always follow PHP control structures that accept arguments with parenthesis (declare, do-while, elseif, for, foreach, if, switch, while), to help distinguish them from functions and increase readability.</p> |
||||
|
||||
<code>INCORRECT: |
||||
$arr[ $foo ] = 'foo'; |
||||
|
||||
CORRECT: |
||||
$arr[$foo] = 'foo'; // no spaces around array keys |
||||
|
||||
|
||||
INCORRECT: |
||||
function foo ( $bar ) |
||||
{ |
||||
|
||||
} |
||||
|
||||
CORRECT: |
||||
function foo($bar) // no spaces around parenthesis in function declarations |
||||
{ |
||||
|
||||
} |
||||
|
||||
|
||||
INCORRECT: |
||||
foreach( $query->result() as $row ) |
||||
|
||||
CORRECT: |
||||
foreach ($query->result() as $row) // single space following PHP control structures, but not in interior parenthesis |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="localized_text"></a>Localized Text</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Any text that is output in the control panel should use language variables in your lang file to allow localization.</p> |
||||
|
||||
<code>INCORRECT: |
||||
return "Invalid Selection"; |
||||
|
||||
CORRECT: |
||||
return $this->lang->line('invalid_selection');</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="private_methods_and_variables"></a>Private Methods and Variables</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Methods and variables that are only accessed internally by your class, such as utility and helper functions that your public methods use for code abstraction, should be prefixed with an underscore.</p> |
||||
|
||||
<code>convert_text() // public method |
||||
_convert_text() // private method</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="php_errors"></a>PHP Errors</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Code must run error free and not rely on warnings and notices to be hidden to meet this requirement. For instance, never access a variable that you did not set yourself (such as $_POST array keys) without first checking to see that it isset().</p> |
||||
|
||||
<p>Make sure that while developing your add-on, error reporting is enabled for ALL users, and that display_errors is enabled in the PHP environment. You can check this setting with:</p> |
||||
|
||||
<code>if (ini_get('display_errors') == 1) |
||||
{ |
||||
exit "Enabled"; |
||||
}</code> |
||||
|
||||
<p>On some servers where display_errors is disabled, and you do not have the ability to change this in the php.ini, you can often enable it with:</p> |
||||
|
||||
<code>ini_set('display_errors', 1);</code> |
||||
|
||||
<p class="important"><strong>NOTE:</strong> Setting the <a href="http://us.php.net/manual/en/ref.errorfunc.php#ini.display-errors">display_errors</a> setting with ini_set() at runtime is not identical to having it enabled in the PHP environment. Namely, it will not have any effect if the script has fatal errors</p> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="short_open_tags"></a>Short Open Tags</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Always use full PHP opening tags, in case a server does not have short_open_tag enabled.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
<? echo $foo; ?> |
||||
|
||||
<?=$foo?> |
||||
|
||||
<strong>CORRECT</strong>: |
||||
<?php echo $foo; ?></code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="one_statement_per_line"></a>One Statement Per Line</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Never combine statements on one line.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
$foo = 'this'; $bar = 'that'; $bat = str_replace($foo, $bar, $bag); |
||||
|
||||
<strong>CORRECT</strong>: |
||||
$foo = 'this'; |
||||
$bar = 'that'; |
||||
$bat = str_replace($foo, $bar, $bag); |
||||
</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="strings"></a>Strings</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Always use single quoted strings unless you need variables parsed, and in cases where you do need variables parsed, use braces to prevent greedy token parsing. You may also use double-quoted strings if the string contains single quotes, so you do not have to use escape characters.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
"My String" // no variable parsing, so no use for double quotes |
||||
"My string $foo" // needs braces |
||||
'SELECT foo FROM bar WHERE baz = \'bag\'' // ugly |
||||
|
||||
<strong>CORRECT</strong>: |
||||
'My String' |
||||
"My string {$foo}" |
||||
"SELECT foo FROM bar WHERE baz = 'bag'"</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="sql_queries"></a>SQL Queries</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>MySQL keywords are always capitalized: SELECT, INSERT, UPDATE, WHERE, AS, JOIN, ON, IN, etc.</p> |
||||
|
||||
<p>Break up long queries into multiple lines for legibility, preferably breaking for each clause.</p> |
||||
|
||||
<code><strong>INCORRECT</strong>: |
||||
// keywords are lowercase and query is too long for |
||||
// a single line (... indicates continuation of line) |
||||
$query = $this->db->query("select foo, bar, baz, foofoo, foobar as raboof, foobaz from exp_pre_email_addresses |
||||
...where foo != 'oof' and baz != 'zab' order by foobaz limit 5, 100"); |
||||
|
||||
<strong>CORRECT</strong>: |
||||
$query = $this->db->query("SELECT foo, bar, baz, foofoo, foobar AS raboof, foobaz |
||||
FROM exp_pre_email_addresses |
||||
WHERE foo != 'oof' |
||||
AND baz != 'zab' |
||||
ORDER BY foobaz |
||||
LIMIT 5, 100");</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
<h2><a name="default_function_arguments"></a>Default Function Arguments</h2> |
||||
<div class="guidelineDetails"> |
||||
<p>Whenever appropriate, provide function argument defaults, which helps prevent PHP errors with mistaken calls and provides common fallback values which can save a few lines of code. Example:</p> |
||||
|
||||
<code>function foo($bar = '', $baz = FALSE)</code> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="security.html">Security</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="../doc_style/index.html">Writing Documentation</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,151 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>CodeIgniter URLs : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
URLS |
||||
</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>CodeIgniter URLs</h1> |
||||
|
||||
<p>By default, URLs in CodeIgniter are designed to be search-engine and human friendly. Rather than using the standard "query string" |
||||
approach to URLs that is synonymous with dynamic systems, CodeIgniter uses a <strong>segment-based</strong> approach:</p> |
||||
|
||||
<code>example.com/<var>news</var>/<dfn>article</dfn>/<samp>my_article</samp></code> |
||||
|
||||
<p class="important"><strong>Note:</strong> Query string URLs can be optionally enabled, as described below.</p> |
||||
|
||||
<h2>URI Segments</h2> |
||||
|
||||
<p>The segments in the URL, in following with the Model-View-Controller approach, usually represent:</p> |
||||
|
||||
<code>example.com/<var>class</var>/<dfn>function</dfn>/<samp>ID</samp></code> |
||||
|
||||
<ol> |
||||
<li>The first segment represents the controller <strong>class</strong> that should be invoked.</li> |
||||
<li>The second segment represents the class <strong>function</strong>, or method, that should be called.</li> |
||||
<li>The third, and any additional segments, represent the ID and any variables that will be passed to the controller.</li> |
||||
</ol> |
||||
|
||||
<p>The <a href="../libraries/uri.html">URI Class</a> and the <a href="../helpers/url_helper.html">URL Helper</a> |
||||
contain functions that make it easy to work with your URI data. In addition, your URLs can be remapped using the |
||||
<a href="routing.html">URI Routing</a> feature for more flexibility.</p> |
||||
|
||||
|
||||
|
||||
<h2>Removing the index.php file</h2> |
||||
|
||||
<p>By default, the <strong>index.php</strong> file will be included in your URLs:</p> |
||||
|
||||
<code>example.com/<var>index.php</var>/news/article/my_article</code> |
||||
|
||||
<p>You can easily remove this file by using a .htaccess file with some simple rules. Here is an example |
||||
of such a file, using the "negative" method in which everything is redirected except the specified items:</p> |
||||
|
||||
<code>RewriteEngine on<br /> |
||||
RewriteCond $1 !^(index\.php|images|robots\.txt)<br /> |
||||
RewriteRule ^(.*)$ /index.php/$1 [L]</code> |
||||
|
||||
<p>In the above example, any HTTP request other than those for index.php, images, and robots.txt is treated as |
||||
a request for your index.php file.</p> |
||||
|
||||
|
||||
<h2>Adding a URL Suffix</h2> |
||||
|
||||
<p>In your <dfn>config/config.php</dfn> file you can specify a suffix that will be added to all URLs generated |
||||
by CodeIgniter. For example, if a URL is this:</p> |
||||
|
||||
<code>example.com/index.php/products/view/shoes</code> |
||||
|
||||
<p>You can optionally add a suffix, like <kbd>.html</kbd>, making the page appear to be of a certain type:</p> |
||||
|
||||
<code>example.com/index.php/products/view/shoes.html</code> |
||||
|
||||
|
||||
<h2>Enabling Query Strings</h2> |
||||
|
||||
<p>In some cases you might prefer to use query strings URLs:</p> |
||||
|
||||
<code>index.php?c=products&m=view&id=345</code> |
||||
|
||||
<p>CodeIgniter optionally supports this capability, which can be enabled in your <dfn>application/config.php</dfn> file. If you |
||||
open your config file you'll see these items:</p> |
||||
|
||||
<code>$config['enable_query_strings'] = FALSE;<br /> |
||||
$config['controller_trigger'] = 'c';<br /> |
||||
$config['function_trigger'] = 'm';</code> |
||||
|
||||
<p>If you change "enable_query_strings" to TRUE this feature will become active. Your controllers and functions will then |
||||
be accessible using the "trigger" words you've set to invoke your controllers and methods:</p> |
||||
|
||||
<code>index.php?c=controller&m=method</code> |
||||
|
||||
<p class="important"><strong>Please note:</strong> If you are using query strings you will have to build your own URLs, rather than utilizing |
||||
the URL helpers (and other helpers that generate URLs, like some of the form helpers) as these are designed to work with |
||||
segment based URLs.</p> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
<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 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,274 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Views : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Views |
||||
</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>Views</h1> |
||||
|
||||
<p>A <dfn>view</dfn> is simply a web page, or a page fragment, like a header, footer, sidebar, etc. |
||||
In fact, views can flexibly be embedded within other views (within other views, etc., etc.) if you need this type |
||||
of hierarchy.</p> |
||||
|
||||
<p>Views are never called directly, they must be loaded by a <a href="controllers.html">controller</a>. Remember that in an MVC framework, the Controller acts as the |
||||
traffic cop, so it is responsible for fetching a particular view. If you have not read the <a href="controllers.html">Controllers</a> page |
||||
you should do so before continuing.</p> |
||||
|
||||
<p>Using the example controller you created in the <a href="controllers.html">controller</a> page, let's add a view to it.</p> |
||||
|
||||
<h2>Creating a View</h2> |
||||
|
||||
<p>Using your text editor, create a file called <dfn>blogview.php</dfn>, and put this in it:</p> |
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="10"> |
||||
<html> |
||||
<head> |
||||
<title>My Blog</title> |
||||
</head> |
||||
<body> |
||||
<h1>Welcome to my Blog!</h1> |
||||
</body> |
||||
</html> |
||||
</textarea> |
||||
|
||||
<p>Then save the file in your <dfn>application/views/</dfn> folder.</p> |
||||
|
||||
<h2>Loading a View</h2> |
||||
|
||||
<p>To load a particular view file you will use the following function:</p> |
||||
|
||||
<code>$this->load->view('<var>name</var>');</code> |
||||
|
||||
<p>Where <var>name</var> is the name of your view file. Note: The .php file extension does not need to be specified unless you use something other than <kbd>.php</kbd>.</p> |
||||
|
||||
|
||||
<p>Now, open the controller file you made earlier called <dfn>blog.php</dfn>, and replace the echo statement with the view loading function:</p> |
||||
|
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="10"> |
||||
<?php |
||||
class Blog extends CI_Controller { |
||||
|
||||
function index() |
||||
{ |
||||
$this->load->view('blogview'); |
||||
} |
||||
} |
||||
?> |
||||
</textarea> |
||||
|
||||
|
||||
<p>If you visit your site using the URL you did earlier you should see your new view. The URL was similar to this:</p> |
||||
|
||||
<code>example.com/index.php/<var>blog</var>/</code> |
||||
|
||||
<h2>Loading multiple views</h2> |
||||
<p>CodeIgniter will intelligently handle multiple calls to $this->load->view from within a controller. If more than one call happens they will be appended together. For example, you may wish to have a header view, a menu view, a content view, and a footer view. That might look something like this:</p> |
||||
<p><code><?php<br /> |
||||
<br /> |
||||
class Page extends CI_Controller {<br /><br /> |
||||
|
||||
function index()<br /> |
||||
{<br /> |
||||
$data['page_title'] = 'Your title';<br /> |
||||
$this->load->view('header');<br /> |
||||
$this->load->view('menu');<br /> |
||||
$this->load->view('content', $data);<br /> |
||||
$this->load->view('footer');<br /> |
||||
}<br /> |
||||
<br /> |
||||
}<br /> |
||||
?></code></p> |
||||
<p>In the example above, we are using "dynamically added data", which you will see below.</p> |
||||
<h2>Storing Views within Sub-folders</h2> |
||||
<p>Your view files can also be stored within sub-folders if you prefer that type of organization. When doing so you will need |
||||
to include the folder name loading the view. Example:</p> |
||||
|
||||
<code>$this->load->view('<kbd>folder_name</kbd>/<var>file_name</var>');</code> |
||||
|
||||
|
||||
<h2>Adding Dynamic Data to the View</h2> |
||||
|
||||
<p>Data is passed from the controller to the view by way of an <strong>array</strong> or an <strong>object</strong> in the second |
||||
parameter of the view loading function. Here is an example using an array:</p> |
||||
|
||||
<code>$data = array(<br /> |
||||
'title' => 'My Title',<br /> |
||||
'heading' => 'My Heading',<br /> |
||||
'message' => 'My Message'<br /> |
||||
);<br /> |
||||
<br /> |
||||
$this->load->view('blogview', <var>$data</var>);</code> |
||||
|
||||
<p>And here's an example using an object:</p> |
||||
|
||||
<code>$data = new Someclass();<br /> |
||||
$this->load->view('blogview', <var>$data</var>);</code> |
||||
|
||||
<p>Note: If you use an object, the class variables will be turned into array elements.</p> |
||||
|
||||
|
||||
<p>Let's try it with your controller file. Open it add this code:</p> |
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="14"> |
||||
<?php |
||||
class Blog extends CI_Controller { |
||||
|
||||
function index() |
||||
{ |
||||
$data['title'] = "My Real Title"; |
||||
$data['heading'] = "My Real Heading"; |
||||
|
||||
$this->load->view('blogview', $data); |
||||
} |
||||
} |
||||
?> |
||||
</textarea> |
||||
|
||||
|
||||
<p>Now open your view file and change the text to variables that correspond to the array keys in your data:</p> |
||||
|
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="10"> |
||||
<html> |
||||
<head> |
||||
<title><?php echo $title;?></title> |
||||
</head> |
||||
<body> |
||||
<h1><?php echo $heading;?></h1> |
||||
</body> |
||||
</html> |
||||
</textarea> |
||||
|
||||
<p>Then load the page at the URL you've been using and you should see the variables replaced.</p> |
||||
|
||||
<h2>Creating Loops</h2> |
||||
|
||||
<p>The data array you pass to your view files is not limited to simple variables. You can |
||||
pass multi dimensional arrays, which can be looped to generate multiple rows. For example, if you |
||||
pull data from your database it will typically be in the form of a multi-dimensional array.</p> |
||||
|
||||
<p>Here's a simple example. Add this to your controller:</p> |
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="17"> |
||||
<?php |
||||
class Blog extends CI_Controller { |
||||
|
||||
function index() |
||||
{ |
||||
$data['todo_list'] = array('Clean House', 'Call Mom', 'Run Errands'); |
||||
|
||||
$data['title'] = "My Real Title"; |
||||
$data['heading'] = "My Real Heading"; |
||||
|
||||
$this->load->view('blogview', $data); |
||||
} |
||||
} |
||||
?> |
||||
</textarea> |
||||
|
||||
|
||||
<p>Now open your view file and create a loop:</p> |
||||
|
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="24"> |
||||
<html> |
||||
<head> |
||||
<title><?php echo $title;?></title> |
||||
</head> |
||||
<body> |
||||
<h1><?php echo $heading;?></h1> |
||||
|
||||
<h3>My Todo List</h3> |
||||
|
||||
<ul> |
||||
<?php foreach ($todo_list as $item):?> |
||||
|
||||
<li><?php echo $item;?></li> |
||||
|
||||
<?php endforeach;?> |
||||
</ul> |
||||
|
||||
</body> |
||||
</html> |
||||
</textarea> |
||||
<p><strong>Note:</strong> You'll notice that in the example above we are using PHP's alternative syntax. If you |
||||
are not familiar with it you can read about it <a href="alternative_php.html">here</a>.</p> |
||||
|
||||
<h2>Returning views as data</h2> |
||||
|
||||
<p>There is a third <strong>optional</strong> parameter lets you change the behavior of the function so that it returns data as a string |
||||
rather than sending it to your browser. This can be useful if you want to process the data in some way. If you |
||||
set the parameter to <kbd>true</kbd> (boolean) it will return data. The default behavior is <kbd>false</kbd>, which sends it |
||||
to your browser. Remember to assign it to a variable if you want the data returned:</p> |
||||
|
||||
<code>$string = $this->load->view('<var>myfile</var>', '', <kbd>true</kbd>);</code> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
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="models.html">Models</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,170 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Array 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Array 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>Array Helper</h1> |
||||
|
||||
<p>The Array Helper file contains functions that assist in working with arrays.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('array');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>element()</h2> |
||||
|
||||
<p>Lets you fetch an item from an array. The function tests whether the array index is set and whether it has a value. If |
||||
a value exists it is returned. If a value does not exist it returns FALSE, or whatever you've specified as the default value via the third parameter. Example:</p> |
||||
|
||||
<code> |
||||
$array = array('color' => 'red', 'shape' => 'round', 'size' => '');<br /> |
||||
<br /> |
||||
// returns "red"<br /> |
||||
echo element('color', $array);<br /> |
||||
<br /> |
||||
// returns NULL<br /> |
||||
echo element('size', $array, NULL); |
||||
</code> |
||||
|
||||
|
||||
<h2>random_element()</h2> |
||||
|
||||
<p>Takes an array as input and returns a random element from it. Usage example:</p> |
||||
|
||||
<code>$quotes = array(<br /> |
||||
"I find that the harder I work, the more luck I seem to have. - Thomas Jefferson",<br /> |
||||
"Don't stay in bed, unless you can make money in bed. - George Burns",<br /> |
||||
"We didn't lose the game; we just ran out of time. - Vince Lombardi",<br /> |
||||
"If everything seems under control, you're not going fast enough. - Mario Andretti",<br /> |
||||
"Reality is merely an illusion, albeit a very persistent one. - Albert Einstein",<br /> |
||||
"Chance favors the prepared mind - Louis Pasteur"<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo random_element($quotes);</code> |
||||
|
||||
|
||||
<h2>elements()</h2> |
||||
|
||||
<p>Lets you fetch a number of items from an array. The function tests whether each of the array indices is set. If an index does not exist |
||||
it is set to FALSE, or whatever you've specified as the default value via the third parameter. Example:</p> |
||||
|
||||
<code> |
||||
$array = array(<br /> |
||||
'color' => 'red',<br /> |
||||
'shape' => 'round',<br /> |
||||
'radius' => '10',<br /> |
||||
'diameter' => '20'<br /> |
||||
);<br /> |
||||
<br /> |
||||
$my_shape = elements(array('color', 'shape', 'height'), $array);<br /> |
||||
</code> |
||||
|
||||
<p>The above will return the following array:</p> |
||||
|
||||
<code> |
||||
array(<br /> |
||||
'color' => 'red',<br /> |
||||
'shape' => 'round',<br /> |
||||
'height' => FALSE<br /> |
||||
); |
||||
</code> |
||||
|
||||
<p>You can set the third parameter to any default value you like:</p> |
||||
|
||||
<code> |
||||
$my_shape = elements(array('color', 'shape', 'height'), $array, NULL);<br /> |
||||
</code> |
||||
|
||||
<p>The above will return the following array:</p> |
||||
|
||||
<code> |
||||
array(<br /> |
||||
'color' => 'red',<br /> |
||||
'shape' => 'round',<br /> |
||||
'height' => NULL<br /> |
||||
); |
||||
</code> |
||||
|
||||
<p>This is useful when sending the <kbd>$_POST</kbd> array to one of your Models. This prevents users from |
||||
sending additional POST data to be entered into your tables:</p> |
||||
|
||||
<code> |
||||
$this->load->model('post_model');<br /> |
||||
<br /> |
||||
$this->post_model->update(elements(array('id', 'title', 'content'), $_POST)); |
||||
</code> |
||||
|
||||
<p>This ensures that only the id, title and content fields are sent to be updated.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="../libraries/javascript.html">Javascript Class</a> · |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="captcha_helper.html">CAPTCHA Helper</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,195 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>CAPTCHA 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
CAPTCHA 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>CAPTCHA Helper</h1> |
||||
|
||||
<p>The CAPTCHA Helper file contains functions that assist in creating CAPTCHA images.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('captcha');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>create_captcha(<var>$data</var>)</h2> |
||||
|
||||
<p>Takes an array of information to generate the CAPTCHA as input and creates the image to your specifications, returning an array of associative data about the image.</p> |
||||
|
||||
<code>[array]<br /> |
||||
(<br /> |
||||
'image' => IMAGE TAG<br /> |
||||
'time' => TIMESTAMP (in microtime)<br /> |
||||
'word' => CAPTCHA WORD<br /> |
||||
)</code> |
||||
|
||||
<p>The "image" is the actual image tag: |
||||
<code><img src="http://example.com/captcha/12345.jpg" width="140" height="50" /></code></p> |
||||
|
||||
<p>The "time" is the micro timestamp used as the image name without the file |
||||
extension. It will be a number like this: 1139612155.3422</p> |
||||
|
||||
<p>The "word" is the word that appears in the captcha image, which if not |
||||
supplied to the function, will be a random string.</p> |
||||
|
||||
<h3>Using the CAPTCHA helper</h3> |
||||
|
||||
<p>Once loaded you can generate a captcha like this:</p> |
||||
|
||||
<code>$vals = array(<br /> |
||||
'word' => 'Random word',<br /> |
||||
'img_path' => './captcha/',<br /> |
||||
'img_url' => 'http://example.com/captcha/',<br /> |
||||
'font_path' => './path/to/fonts/texb.ttf',<br /> |
||||
'img_width' => '150',<br /> |
||||
'img_height' => 30,<br /> |
||||
'expiration' => 7200<br /> |
||||
);<br /> |
||||
<br /> |
||||
$cap = create_captcha($vals);<br /> |
||||
echo $cap['image'];</code> |
||||
|
||||
<ul> |
||||
<li>The captcha function requires the GD image library.</li> |
||||
<li>Only the img_path and img_url are required.</li> |
||||
<li>If a "word" is not supplied, the function will generate a random |
||||
ASCII string. You might put together your own word library that |
||||
you can draw randomly from.</li> |
||||
<li>If you do not specify a path to a TRUE TYPE font, the native ugly GD |
||||
font will be used.</li> |
||||
<li>The "captcha" folder must be writable (666, or 777)</li> |
||||
<li>The "expiration" (in seconds) signifies how long an image will |
||||
remain in the captcha folder before it will be deleted. The default |
||||
is two hours.</li> |
||||
</ul> |
||||
|
||||
<h3>Adding a Database</h3> |
||||
|
||||
<p>In order for the captcha function to prevent someone from submitting, you will need |
||||
to add the information returned from <kbd>create_captcha()</kbd> function to your database. |
||||
Then, when the data from the form is submitted by the user you will need to verify |
||||
that the data exists in the database and has not expired.</p> |
||||
|
||||
<p>Here is a table prototype:</p> |
||||
|
||||
<code>CREATE TABLE captcha (<br /> |
||||
captcha_id bigint(13) unsigned NOT NULL auto_increment,<br /> |
||||
captcha_time int(10) unsigned NOT NULL,<br /> |
||||
ip_address varchar(16) default '0' NOT NULL,<br /> |
||||
word varchar(20) NOT NULL,<br /> |
||||
PRIMARY KEY `captcha_id` (`captcha_id`),<br /> |
||||
KEY `word` (`word`)<br /> |
||||
);</code> |
||||
|
||||
<p>Here is an example of usage with a database. On the page where the CAPTCHA will be shown you'll have something like this:</p> |
||||
|
||||
<code>$this->load->helper('captcha');<br /> |
||||
$vals = array(<br /> |
||||
'img_path' => './captcha/',<br /> |
||||
'img_url' => 'http://example.com/captcha/'<br /> |
||||
);<br /> |
||||
<br /> |
||||
$cap = create_captcha($vals);<br /> |
||||
<br /> |
||||
$data = array(<br /> |
||||
'captcha_time' => $cap['time'],<br /> |
||||
'ip_address' => $this->input->ip_address(),<br /> |
||||
'word' => $cap['word']<br /> |
||||
);<br /> |
||||
<br /> |
||||
$query = $this->db->insert_string('captcha', $data);<br /> |
||||
$this->db->query($query);<br /> |
||||
<br /> |
||||
echo 'Submit the word you see below:';<br /> |
||||
echo $cap['image'];<br /> |
||||
echo '<input type="text" name="captcha" value="" />';</code> |
||||
|
||||
<p>Then, on the page that accepts the submission you'll have something like this:</p> |
||||
|
||||
<code>// First, delete old captchas<br /> |
||||
$expiration = time()-7200; // Two hour limit<br /> |
||||
$this->db->query("DELETE FROM captcha WHERE captcha_time < ".$expiration); <br /> |
||||
<br /> |
||||
// Then see if a captcha exists:<br /> |
||||
$sql = "SELECT COUNT(*) AS count FROM captcha WHERE word = ? AND ip_address = ? AND captcha_time > ?";<br /> |
||||
$binds = array($_POST['captcha'], $this->input->ip_address(), $expiration);<br /> |
||||
$query = $this->db->query($sql, $binds);<br /> |
||||
$row = $query->row();<br /> |
||||
<br /> |
||||
if ($row->count == 0)<br /> |
||||
{<br /> |
||||
echo "You must submit the word that appears in the image";<br /> |
||||
}</code> |
||||
|
||||
</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 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,107 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Cookie 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Cookie 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>Cookie Helper</h1> |
||||
|
||||
<p>The Cookie Helper file contains functions that assist in working with cookies.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('cookie');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>set_cookie()</h2> |
||||
|
||||
<p>This helper function gives you view file friendly syntax to set browser cookies. Refer to the <a href="../libraries/input.html">Input class</a> for a description of use, as this function is an alias to $this->input->set_cookie().</p> |
||||
|
||||
<h2>get_cookie()</h2> |
||||
|
||||
<p>This helper function gives you view file friendly syntax to get browser cookies. Refer to the <a href="../libraries/input.html">Input class</a> for a description of use, as this function is an alias to $this->input->cookie().</p> |
||||
|
||||
|
||||
<h2>delete_cookie()</h2> |
||||
|
||||
<p>Lets you delete a cookie. Unless you've set a custom path or other values, only the name of the cookie is needed:</p> |
||||
|
||||
<code>delete_cookie("name");</code> |
||||
|
||||
<p>This function is otherwise identical to <dfn>set_cookie()</dfn>, except that it does not have the value and expiration parameters. You can submit an array |
||||
of values in the first parameter or you can set discrete parameters.</p> |
||||
|
||||
<code>delete_cookie($name, $domain, $path, $prefix)</code> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="captcha_helper.html">CAPTCHA Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="date_helper.html">Date Helper</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,408 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Date 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Date 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>Date Helper</h1> |
||||
|
||||
<p>The Date Helper file contains functions that help you work with dates.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('date');</code> |
||||
|
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>now()</h2> |
||||
|
||||
<p>Returns the current time as a Unix timestamp, referenced either to your server's local time or GMT, based on the "time reference" |
||||
setting in your config file. If you do not intend to set your master time reference to GMT (which you'll typically do if you |
||||
run a site that lets each user set their own timezone settings) there is no benefit to using this function over PHP's time() function. |
||||
</p> |
||||
|
||||
|
||||
|
||||
|
||||
<h2>mdate()</h2> |
||||
|
||||
<p>This function is identical to PHPs <a href="http://www.php.net/date">date()</a> function, except that it lets you |
||||
use MySQL style date codes, where each code letter is preceded with a percent sign: %Y %m %d etc.</p> |
||||
|
||||
<p>The benefit of doing dates this way is that you don't have to worry about escaping any characters that |
||||
are not date codes, as you would normally have to do with the date() function. Example:</p> |
||||
|
||||
<code>$datestring = "Year: %Y Month: %m Day: %d - %h:%i %a";<br /> |
||||
$time = time();<br /> |
||||
<br /> |
||||
echo mdate($datestring, $time);</code> |
||||
|
||||
<p>If a timestamp is not included in the second parameter the current time will be used.</p> |
||||
|
||||
|
||||
<h2>standard_date()</h2> |
||||
|
||||
<p>Lets you generate a date string in one of several standardized formats. Example:</p> |
||||
|
||||
<code> |
||||
$format = 'DATE_RFC822';<br /> |
||||
$time = time();<br /> |
||||
<br /> |
||||
echo standard_date($format, $time); |
||||
</code> |
||||
|
||||
<p>The first parameter must contain the format, the second parameter must contain the date as a Unix timestamp.</p> |
||||
|
||||
<p>Supported formats:</p> |
||||
|
||||
<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder"> |
||||
<tr> |
||||
<th>Constant</th> |
||||
<th>Description</th> |
||||
<th>Example</th> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_ATOM</td> |
||||
<td>Atom</td> |
||||
<td>2005-08-15T16:13:03+0000</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_COOKIE</td> |
||||
<td>HTTP Cookies</td> |
||||
<td>Sun, 14 Aug 2005 16:13:03 UTC</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_ISO8601</td> |
||||
<td>ISO-8601</td> |
||||
<td>2005-08-14T16:13:03+00:00</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_RFC822</td> |
||||
<td>RFC 822</td> |
||||
<td>Sun, 14 Aug 05 16:13:03 UTC</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_RFC850</td> |
||||
<td>RFC 850</td> |
||||
<td>Sunday, 14-Aug-05 16:13:03 UTC</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_RFC1036</td> |
||||
<td>RFC 1036</td> |
||||
<td>Sunday, 14-Aug-05 16:13:03 UTC</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_RFC1123</td> |
||||
<td>RFC 1123</td> |
||||
<td>Sun, 14 Aug 2005 16:13:03 UTC</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_RFC2822</td> |
||||
<td>RFC 2822</td> |
||||
<td>Sun, 14 Aug 2005 16:13:03 +0000</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_RSS</td> |
||||
<td>RSS</td> |
||||
<td>Sun, 14 Aug 2005 16:13:03 UTC</td> |
||||
</tr> |
||||
<tr> |
||||
<td>DATE_W3C</td> |
||||
<td>World Wide Web Consortium</td> |
||||
<td>2005-08-14T16:13:03+0000</td> |
||||
</tr> |
||||
</table> |
||||
|
||||
<h2>local_to_gmt()</h2> |
||||
|
||||
<p>Takes a Unix timestamp as input and returns it as GMT. Example:</p> |
||||
|
||||
<code>$now = time();<br /> |
||||
<br /> |
||||
$gmt = local_to_gmt($now);</code> |
||||
|
||||
|
||||
<h2>gmt_to_local()</h2> |
||||
|
||||
<p>Takes a Unix timestamp (referenced to GMT) as input, and converts it to a localized timestamp based on the |
||||
timezone and Daylight Saving time submitted. Example:</p> |
||||
|
||||
<code> |
||||
$timestamp = '1140153693';<br /> |
||||
$timezone = 'UM8';<br /> |
||||
$daylight_saving = TRUE;<br /> |
||||
<br /> |
||||
echo gmt_to_local($timestamp, $timezone, $daylight_saving);</code> |
||||
|
||||
<p><strong>Note:</strong> For a list of timezones see the reference at the bottom of this page.</p> |
||||
|
||||
<h2>mysql_to_unix()</h2> |
||||
|
||||
<p>Takes a MySQL Timestamp as input and returns it as Unix. Example:</p> |
||||
|
||||
<code>$mysql = '20061124092345';<br /> |
||||
<br /> |
||||
$unix = mysql_to_unix($mysql);</code> |
||||
|
||||
|
||||
<h2>unix_to_human()</h2> |
||||
|
||||
<p>Takes a Unix timestamp as input and returns it in a human readable format with this prototype:</p> |
||||
|
||||
<code>YYYY-MM-DD HH:MM:SS AM/PM</code> |
||||
|
||||
<p>This can be useful if you need to display a date in a form field for submission.</p> |
||||
|
||||
<p>The time can be formatted with or without seconds, and it can be set to European or US format. If only |
||||
the timestamp is submitted it will return the time without seconds formatted for the U.S. Examples:</p> |
||||
|
||||
<code>$now = time();<br /> |
||||
<br /> |
||||
echo unix_to_human($now); // U.S. time, no seconds<br /> |
||||
<br /> |
||||
echo unix_to_human($now, TRUE, 'us'); // U.S. time with seconds<br /> |
||||
<br /> |
||||
echo unix_to_human($now, TRUE, 'eu'); // Euro time with seconds</code> |
||||
|
||||
|
||||
<h2>human_to_unix()</h2> |
||||
|
||||
<p>The opposite of the above function. Takes a "human" time as input and returns it as Unix. This function is |
||||
useful if you accept "human" formatted dates submitted via a form. Returns FALSE (boolean) if |
||||
the date string passed to it is not formatted as indicated above. Example:</p> |
||||
|
||||
<code>$now = time();<br /> |
||||
<br /> |
||||
$human = unix_to_human($now);<br /> |
||||
<br /> |
||||
$unix = human_to_unix($human);</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>timespan()</h2> |
||||
|
||||
<p>Formats a unix timestamp so that is appears similar to this:</p> |
||||
|
||||
<code>1 Year, 10 Months, 2 Weeks, 5 Days, 10 Hours, 16 Minutes</code> |
||||
|
||||
<p>The first parameter must contain a Unix timestamp. The second parameter must contain a |
||||
timestamp that is greater that the first timestamp. If the second parameter empty, the current time will be used. The most common purpose |
||||
for this function is to show how much time has elapsed from some point in time in the past to now. Example:</p> |
||||
|
||||
<code>$post_date = '1079621429';<br /> |
||||
$now = time();<br /> |
||||
<br /> |
||||
echo timespan($post_date, $now);</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> The text generated by this function is found in the following language file: language/<your_lang>/date_lang.php</p> |
||||
|
||||
|
||||
<h2>days_in_month()</h2> |
||||
|
||||
<p>Returns the number of days in a given month/year. Takes leap years into account. Example:</p> |
||||
<code>echo days_in_month(06, 2005);</code> |
||||
|
||||
<p>If the second parameter is empty, the current year will be used.</p> |
||||
<h2>timezones()</h2> |
||||
<p> Takes a timezone reference (for a list of valid timezones, see the "Timezone Reference" below) and returns the number of hours offset from UTC.</p> |
||||
<p><code>echo timezones('UM5');</code></p> |
||||
<p>This function is useful when used with timezone_menu(). </p> |
||||
<h2>timezone_menu()</h2> |
||||
<p>Generates a pull-down menu of timezones, like this one:</p> |
||||
|
||||
<form action="#"> |
||||
<select name="timezones"> |
||||
<option value='UM12'>(UTC - 12:00) Enitwetok, Kwajalien</option> |
||||
<option value='UM11'>(UTC - 11:00) Nome, Midway Island, Samoa</option> |
||||
<option value='UM10'>(UTC - 10:00) Hawaii</option> |
||||
<option value='UM9'>(UTC - 9:00) Alaska</option> |
||||
<option value='UM8'>(UTC - 8:00) Pacific Time</option> |
||||
<option value='UM7'>(UTC - 7:00) Mountain Time</option> |
||||
<option value='UM6'>(UTC - 6:00) Central Time, Mexico City</option> |
||||
<option value='UM5'>(UTC - 5:00) Eastern Time, Bogota, Lima, Quito</option> |
||||
<option value='UM4'>(UTC - 4:00) Atlantic Time, Caracas, La Paz</option> |
||||
<option value='UM25'>(UTC - 3:30) Newfoundland</option> |
||||
<option value='UM3'>(UTC - 3:00) Brazil, Buenos Aires, Georgetown, Falkland Is.</option> |
||||
<option value='UM2'>(UTC - 2:00) Mid-Atlantic, Ascention Is., St Helena</option> |
||||
<option value='UM1'>(UTC - 1:00) Azores, Cape Verde Islands</option> |
||||
<option value='UTC' selected='selected'>(UTC) Casablanca, Dublin, Edinburgh, London, Lisbon, Monrovia</option> |
||||
<option value='UP1'>(UTC + 1:00) Berlin, Brussels, Copenhagen, Madrid, Paris, Rome</option> |
||||
<option value='UP2'>(UTC + 2:00) Kaliningrad, South Africa, Warsaw</option> |
||||
<option value='UP3'>(UTC + 3:00) Baghdad, Riyadh, Moscow, Nairobi</option> |
||||
<option value='UP25'>(UTC + 3:30) Tehran</option> |
||||
<option value='UP4'>(UTC + 4:00) Adu Dhabi, Baku, Muscat, Tbilisi</option> |
||||
<option value='UP35'>(UTC + 4:30) Kabul</option> |
||||
<option value='UP5'>(UTC + 5:00) Islamabad, Karachi, Tashkent</option> |
||||
<option value='UP45'>(UTC + 5:30) Bombay, Calcutta, Madras, New Delhi</option> |
||||
<option value='UP6'>(UTC + 6:00) Almaty, Colomba, Dhaka</option> |
||||
<option value='UP7'>(UTC + 7:00) Bangkok, Hanoi, Jakarta</option> |
||||
<option value='UP8'>(UTC + 8:00) Beijing, Hong Kong, Perth, Singapore, Taipei</option> |
||||
<option value='UP9'>(UTC + 9:00) Osaka, Sapporo, Seoul, Tokyo, Yakutsk</option> |
||||
<option value='UP85'>(UTC + 9:30) Adelaide, Darwin</option> |
||||
<option value='UP10'>(UTC + 10:00) Melbourne, Papua New Guinea, Sydney, Vladivostok</option> |
||||
<option value='UP11'>(UTC + 11:00) Magadan, New Caledonia, Solomon Islands</option> |
||||
<option value='UP12'>(UTC + 12:00) Auckland, Wellington, Fiji, Marshall Island</option> |
||||
</select> |
||||
</form> |
||||
|
||||
<p>This menu is useful if you run a membership site in which your users are allowed to set their local timezone value.</p> |
||||
|
||||
<p>The first parameter lets you set the "selected" state of the menu. For example, to set Pacific time as the default you will do this:</p> |
||||
|
||||
<code>echo timezone_menu('UM8');</code> |
||||
|
||||
<p>Please see the timezone reference below to see the values of this menu.</p> |
||||
|
||||
<p>The second parameter lets you set a CSS class name for the menu.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> The text contained in the menu is found in the following language file: language/<your_lang>/date_lang.php</p> |
||||
|
||||
|
||||
|
||||
<h2>Timezone Reference</h2> |
||||
|
||||
<p>The following table indicates each timezone and its location.</p> |
||||
|
||||
<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder"> |
||||
<tr> |
||||
<th>Time Zone</th> |
||||
<th>Location</th> |
||||
</tr><tr> |
||||
|
||||
<td class="td">UM12</td><td class="td">(UTC - 12:00) Enitwetok, Kwajalien</td> |
||||
</tr><tr> |
||||
<td class="td">UM11</td><td class="td">(UTC - 11:00) Nome, Midway Island, Samoa</td> |
||||
</tr><tr> |
||||
<td class="td">UM10</td><td class="td">(UTC - 10:00) Hawaii</td> |
||||
</tr><tr> |
||||
<td class="td">UM9</td><td class="td">(UTC - 9:00) Alaska</td> |
||||
</tr><tr> |
||||
<td class="td">UM8</td><td class="td">(UTC - 8:00) Pacific Time</td> |
||||
</tr><tr> |
||||
<td class="td">UM7</td><td class="td">(UTC - 7:00) Mountain Time</td> |
||||
</tr><tr> |
||||
<td class="td">UM6</td><td class="td">(UTC - 6:00) Central Time, Mexico City</td> |
||||
</tr><tr> |
||||
<td class="td">UM5</td><td class="td">(UTC - 5:00) Eastern Time, Bogota, Lima, Quito</td> |
||||
</tr><tr> |
||||
<td class="td">UM4</td><td class="td">(UTC - 4:00) Atlantic Time, Caracas, La Paz</td> |
||||
</tr><tr> |
||||
<td class="td">UM25</td><td class="td">(UTC - 3:30) Newfoundland</td> |
||||
</tr><tr> |
||||
<td class="td">UM3</td><td class="td">(UTC - 3:00) Brazil, Buenos Aires, Georgetown, Falkland Is.</td> |
||||
</tr><tr> |
||||
<td class="td">UM2</td><td class="td">(UTC - 2:00) Mid-Atlantic, Ascention Is., St Helena</td> |
||||
</tr><tr> |
||||
<td class="td">UM1</td><td class="td">(UTC - 1:00) Azores, Cape Verde Islands</td> |
||||
</tr><tr> |
||||
<td class="td">UTC</td><td class="td">(UTC) Casablanca, Dublin, Edinburgh, London, Lisbon, Monrovia</td> |
||||
</tr><tr> |
||||
<td class="td">UP1</td><td class="td">(UTC + 1:00) Berlin, Brussels, Copenhagen, Madrid, Paris, Rome</td> |
||||
</tr><tr> |
||||
<td class="td">UP2</td><td class="td">(UTC + 2:00) Kaliningrad, South Africa, Warsaw</td> |
||||
</tr><tr> |
||||
<td class="td">UP3</td><td class="td">(UTC + 3:00) Baghdad, Riyadh, Moscow, Nairobi</td> |
||||
</tr><tr> |
||||
<td class="td">UP25</td><td class="td">(UTC + 3:30) Tehran</td> |
||||
</tr><tr> |
||||
<td class="td">UP4</td><td class="td">(UTC + 4:00) Adu Dhabi, Baku, Muscat, Tbilisi</td> |
||||
</tr><tr> |
||||
<td class="td">UP35</td><td class="td">(UTC + 4:30) Kabul</td> |
||||
</tr><tr> |
||||
<td class="td">UP5</td><td class="td">(UTC + 5:00) Islamabad, Karachi, Tashkent</td> |
||||
</tr><tr> |
||||
<td class="td">UP45</td><td class="td">(UTC + 5:30) Bombay, Calcutta, Madras, New Delhi</td> |
||||
</tr><tr> |
||||
<td class="td">UP6</td><td class="td">(UTC + 6:00) Almaty, Colomba, Dhaka</td> |
||||
</tr><tr> |
||||
<td class="td">UP7</td><td class="td">(UTC + 7:00) Bangkok, Hanoi, Jakarta</td> |
||||
</tr><tr> |
||||
<td class="td">UP8</td><td class="td">(UTC + 8:00) Beijing, Hong Kong, Perth, Singapore, Taipei</td> |
||||
</tr><tr> |
||||
<td class="td">UP9</td><td class="td">(UTC + 9:00) Osaka, Sapporo, Seoul, Tokyo, Yakutsk</td> |
||||
</tr><tr> |
||||
<td class="td">UP85</td><td class="td">(UTC + 9:30) Adelaide, Darwin</td> |
||||
</tr><tr> |
||||
<td class="td">UP10</td><td class="td">(UTC + 10:00) Melbourne, Papua New Guinea, Sydney, Vladivostok</td> |
||||
</tr><tr> |
||||
<td class="td">UP11</td><td class="td">(UTC + 11:00) Magadan, New Caledonia, Solomon Islands</td> |
||||
</tr><tr> |
||||
<td class="td">UP12</td><td class="td">(UTC + 12:00) Auckland, Wellington, Fiji, Marshall Island</td> |
||||
</tr> |
||||
</table> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="cookie_helper.html">Cookie Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="directory_helper.html">Directory Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,143 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Directory 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Directory 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>Directory Helper</h1> |
||||
|
||||
<p>The Directory Helper file contains functions that assist in working with directories.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('directory');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>directory_map('<var>source directory</var>')</h2> |
||||
|
||||
<p>This function reads the directory path specified in the first parameter |
||||
and builds an array representation of it and all its contained files. Example:</p> |
||||
|
||||
<code>$map = directory_map('./mydirectory/');</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> Paths are almost always relative to your main index.php file.</p> |
||||
|
||||
<p>Sub-folders contained within the directory will be mapped as well. If you wish to control the recursion depth, |
||||
you can do so using the second parameter (integer). A depth of 1 will only map the top level directory:</p> |
||||
|
||||
<code>$map = directory_map('./mydirectory/', 1);</code> |
||||
|
||||
<p>By default, hidden files will not be included in the returned array. To override this behavior, |
||||
you may set a third parameter to <var>true</var> (boolean):</p> |
||||
|
||||
<code>$map = directory_map('./mydirectory/', FALSE, TRUE);</code> |
||||
|
||||
<p>Each folder name will be an array index, while its contained files will be numerically indexed. |
||||
Here is an example of a typical array:</p> |
||||
|
||||
<code>Array<br /> |
||||
(<br /> |
||||
[libraries] => Array<br /> |
||||
(<br /> |
||||
[0] => benchmark.html<br /> |
||||
[1] => config.html<br /> |
||||
[database] => Array<br /> |
||||
(<br /> |
||||
[0] => active_record.html<br /> |
||||
[1] => binds.html<br /> |
||||
[2] => configuration.html<br /> |
||||
[3] => connecting.html<br /> |
||||
[4] => examples.html<br /> |
||||
[5] => fields.html<br /> |
||||
[6] => index.html<br /> |
||||
[7] => queries.html<br /> |
||||
)<br /> |
||||
[2] => email.html<br /> |
||||
[3] => file_uploading.html<br /> |
||||
[4] => image_lib.html<br /> |
||||
[5] => input.html<br /> |
||||
[6] => language.html<br /> |
||||
[7] => loader.html<br /> |
||||
[8] => pagination.html<br /> |
||||
[9] => uri.html<br /> |
||||
)</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="date_helper.html">Date Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="download_helper.html">Download Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,112 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Download 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Download 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>Download Helper</h1> |
||||
|
||||
<p>The Download Helper lets you download data to your desktop.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('download');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>force_download('<var>filename</var>', '<var>data</var>')</h2> |
||||
|
||||
<p>Generates server headers which force data to be downloaded to your desktop. Useful with file downloads. |
||||
The first parameter is the <strong>name you want the downloaded file to be named</strong>, the second parameter is the file data. |
||||
Example:</p> |
||||
|
||||
<code> |
||||
$data = 'Here is some text!';<br /> |
||||
$name = 'mytext.txt';<br /> |
||||
<br /> |
||||
force_download($name, $data); |
||||
</code> |
||||
|
||||
<p>If you want to download an existing file from your server you'll need to read the file into a string:</p> |
||||
|
||||
<code> |
||||
$data = file_get_contents("/path/to/photo.jpg"); // Read the file's contents<br /> |
||||
$name = 'myphoto.jpg';<br /> |
||||
<br /> |
||||
force_download($name, $data); |
||||
</code> |
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="directory_helper.html">Directory Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="email_helper.html">Email Helper</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,102 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Email 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Email 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>Email Helper</h1> |
||||
|
||||
<p>The Email Helper provides some assistive functions for working with Email. For a more robust email solution, see CodeIgniter's <a href="../libraries/email.html">Email Class</a>.</p> |
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<p><code>$this->load->helper('email');</code></p> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>valid_email('<var>email</var>')</h2> |
||||
|
||||
<p>Checks if an email is a correctly formatted email. Note that is doesn't actually prove the email will recieve mail, simply that it is a validly formed address.</p> |
||||
<p>It returns TRUE/FALSE</p> |
||||
<code> $this->load->helper('email');<br /> |
||||
<br /> |
||||
if (valid_email('[email protected]'))<br /> |
||||
{<br /> |
||||
echo 'email is valid';<br /> |
||||
}<br /> |
||||
else<br /> |
||||
{<br /> |
||||
echo 'email is not valid';<br /> |
||||
}</code> |
||||
<h2>send_email('<var>recipient</var>', '<var>subject</var>', '<var>message</var>')</h2> |
||||
<p>Sends an email using PHP's native <a href="http://www.php.net/function.mail">mail()</a> function. For a more robust email solution, see CodeIgniter's <a href="../libraries/email.html">Email Class</a>.</p> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="download_helper.html">Download Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="file_helper.html">File Helper</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,179 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>File 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
File 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>File Helper</h1> |
||||
|
||||
<p>The File Helper file contains functions that assist in working with files.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('file');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>read_file('<var>path</var>')</h2> |
||||
|
||||
<p>Returns the data contained in the file specified in the path. Example:</p> |
||||
|
||||
<code>$string = read_file('./path/to/file.php');</code> |
||||
|
||||
<p>The path can be a relative or full server path. Returns FALSE (boolean) on failure.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> The path is relative to your main site index.php file, NOT your controller or view files. |
||||
CodeIgniter uses a front controller so paths are always relative to the main site index.</p> |
||||
|
||||
<p>If your server is running an open_basedir restriction this function |
||||
might not work if you are trying to access a file above the calling script.</p> |
||||
|
||||
<h2>write_file('<var>path</var>', <kbd>$data</kbd>)</h2> |
||||
|
||||
<p>Writes data to the file specified in the path. If the file does not exist the function will create it. Example:</p> |
||||
|
||||
<code> |
||||
$data = 'Some file data';<br /> |
||||
<br /> |
||||
if ( ! write_file('./path/to/file.php', $data))<br /> |
||||
{<br /> |
||||
echo 'Unable to write the file';<br /> |
||||
}<br /> |
||||
else<br /> |
||||
{<br /> |
||||
echo 'File written!';<br /> |
||||
}</code> |
||||
|
||||
<p>You can optionally set the write mode via the third parameter:</p> |
||||
|
||||
<code>write_file('./path/to/file.php', $data, <var>'r+'</var>);</code> |
||||
|
||||
<p>The default mode is <kbd>wb</kbd>. Please see the <a href="http://php.net/fopen">PHP user guide</a> for mode options.</p> |
||||
|
||||
<p>Note: In order for this function to write data to a file its file permissions must be set such that it is writable (666, 777, etc.). |
||||
If the file does not already exist, the directory containing it must be writable.</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> The path is relative to your main site index.php file, NOT your controller or view files. |
||||
CodeIgniter uses a front controller so paths are always relative to the main site index.</p> |
||||
|
||||
<h2>delete_files('<var>path</var>')</h2> |
||||
|
||||
<p>Deletes ALL files contained in the supplied path. Example:</p> |
||||
<code>delete_files('./path/to/directory/');</code> |
||||
|
||||
<p>If the second parameter is set to <kbd>true</kbd>, any directories contained within the supplied root path will be deleted as well. Example:</p> |
||||
|
||||
<code>delete_files('./path/to/directory/', TRUE);</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> The files must be writable or owned by the system in order to be deleted.</p> |
||||
|
||||
<h2>get_filenames('<var>path/to/directory/</var>')</h2> |
||||
|
||||
<p>Takes a server path as input and returns an array containing the names of all files contained within it. The file path |
||||
can optionally be added to the file names by setting the second parameter to TRUE.</p> |
||||
|
||||
<h2>get_dir_file_info('<var>path/to/directory/</var>', <kbd>$top_level_only</kbd> = TRUE)</h2> |
||||
|
||||
<p>Reads the specified directory and builds an array containing the filenames, filesize, dates, and permissions. Sub-folders contained within the specified path are only read if forced |
||||
by sending the second parameter, <kbd>$top_level_only</kbd> to <samp>FALSE</samp>, as this can be an intensive operation.</p> |
||||
|
||||
<h2>get_file_info('<var>path/to/file</var>', <kbd>$file_information</kbd>)</h2> |
||||
|
||||
<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>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> |
||||
<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> |
||||
|
||||
<h2>symbolic_permissions(<kbd>$perms</kbd>)</h2> |
||||
|
||||
<p>Takes numeric permissions (such as is returned by <kbd>fileperms()</kbd> and returns standard symbolic notation of file permissions.</p> |
||||
|
||||
<code>echo symbolic_permissions(fileperms('./index.php'));<br /> |
||||
<br /> |
||||
// -rw-r--r--</code> |
||||
|
||||
<h2>octal_permissions(<kbd>$perms</kbd>)</h2> |
||||
|
||||
<p>Takes numeric permissions (such as is returned by <kbd>fileperms()</kbd> and returns a three character octal notation of file permissions.</p> |
||||
|
||||
<code>echo octal_permissions(fileperms('./index.php'));<br /> |
||||
<br /> |
||||
// 644</code> |
||||
|
||||
</div> |
||||
|
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="email_helper.html">Email Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="form_helper.html">Form Helper</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,484 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Form 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Form 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>Form Helper</h1> |
||||
|
||||
<p>The Form Helper file contains functions that assist in working with forms.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('form');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
|
||||
|
||||
<h2>form_open()</h2> |
||||
|
||||
<p>Creates an opening form tag with a base URL <strong>built from your config preferences</strong>. It will optionally let you |
||||
add form attributes and hidden input fields, and will always add the attribute <kbd>accept-charset</kbd> based on the charset value in your config file.</p> |
||||
|
||||
<p>The main benefit of using this tag rather than hard coding your own HTML is that it permits your site to be more portable |
||||
in the event your URLs ever change.</p> |
||||
|
||||
<p>Here's a simple example:</p> |
||||
|
||||
<code>echo form_open('email/send');</code> |
||||
|
||||
<p>The above example would create a form that points to your base URL plus the "email/send" URI segments, like this:</p> |
||||
|
||||
<code><form method="post" accept-charset="utf-8" action="http:/example.com/index.php/email/send" /></code> |
||||
|
||||
<h4>Adding Attributes</h4> |
||||
|
||||
<p>Attributes can be added by passing an associative array to the second parameter, like this:</p> |
||||
|
||||
<code> |
||||
$attributes = array('class' => 'email', 'id' => 'myform');<br /> |
||||
<br /> |
||||
echo form_open('email/send', $attributes);</code> |
||||
|
||||
<p>The above example would create a form similar to this:</p> |
||||
|
||||
<code><form method="post" accept-charset="utf-8" action="http:/example.com/index.php/email/send" class="email" id="myform" /></code> |
||||
|
||||
<h4>Adding Hidden Input Fields</h4> |
||||
|
||||
<p>Hidden fields can be added by passing an associative array to the third parameter, like this:</p> |
||||
|
||||
<code> |
||||
$hidden = array('username' => 'Joe', 'member_id' => '234');<br /> |
||||
<br /> |
||||
echo form_open('email/send', '', $hidden);</code> |
||||
|
||||
<p>The above example would create a form similar to this:</p> |
||||
|
||||
<code><form method="post" accept-charset="utf-8" action="http:/example.com/index.php/email/send"><br /> |
||||
<input type="hidden" name="username" value="Joe" /><br /> |
||||
<input type="hidden" name="member_id" value="234" /></code> |
||||
|
||||
|
||||
<h2>form_open_multipart()</h2> |
||||
|
||||
<p>This function is absolutely identical to the <dfn>form_open()</dfn> tag above except that it adds a multipart attribute, |
||||
which is necessary if you would like to use the form to upload files with.</p> |
||||
|
||||
<h2>form_hidden()</h2> |
||||
|
||||
<p>Lets you generate hidden input fields. You can either submit a name/value string to create one field:</p> |
||||
|
||||
<code>form_hidden('username', 'johndoe');<br /> |
||||
<br /> |
||||
// Would produce:<br /><br /> |
||||
<input type="hidden" name="username" value="johndoe" /></code> |
||||
|
||||
<p>Or you can submit an associative array to create multiple fields:</p> |
||||
|
||||
<code>$data = array(<br /> |
||||
'name' => 'John Doe',<br /> |
||||
'email' => '[email protected]',<br /> |
||||
'url' => 'http://example.com'<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo form_hidden($data);<br /> |
||||
<br /> |
||||
// Would produce:<br /><br /> |
||||
<input type="hidden" name="name" value="John Doe" /><br /> |
||||
<input type="hidden" name="email" value="[email protected]" /><br /> |
||||
<input type="hidden" name="url" value="http://example.com" /></code> |
||||
|
||||
|
||||
|
||||
|
||||
<h2>form_input()</h2> |
||||
|
||||
<p>Lets you generate a standard text input field. You can minimally pass the field name and value in the first |
||||
and second parameter:</p> |
||||
|
||||
<code>echo form_input('username', 'johndoe');</code> |
||||
|
||||
<p>Or you can pass an associative array containing any data you wish your form to contain:</p> |
||||
|
||||
<code>$data = array(<br /> |
||||
'name' => 'username',<br /> |
||||
'id' => 'username',<br /> |
||||
'value' => 'johndoe',<br /> |
||||
'maxlength' => '100',<br /> |
||||
'size' => '50',<br /> |
||||
'style' => 'width:50%',<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo form_input($data);<br /> |
||||
<br /> |
||||
// Would produce:<br /><br /> |
||||
<input type="text" name="username" id="username" value="johndoe" maxlength="100" size="50" style="width:50%" /></code> |
||||
|
||||
<p>If you would like your form to contain some additional data, like Javascript, you can pass it as a string in the |
||||
third parameter:</p> |
||||
|
||||
<code>$js = 'onClick="some_function()"';<br /> |
||||
<br /> |
||||
echo form_input('username', 'johndoe', $js);</code> |
||||
|
||||
<h2>form_password()</h2> |
||||
|
||||
<p>This function is identical in all respects to the <dfn>form_input()</dfn> function above |
||||
except that is sets it as a "password" type.</p> |
||||
|
||||
<h2>form_upload()</h2> |
||||
|
||||
<p>This function is identical in all respects to the <dfn>form_input()</dfn> function above |
||||
except that is sets it as a "file" type, allowing it to be used to upload files.</p> |
||||
|
||||
<h2>form_textarea()</h2> |
||||
|
||||
<p>This function is identical in all respects to the <dfn>form_input()</dfn> function above |
||||
except that it generates a "textarea" type. Note: Instead of the "maxlength" and "size" attributes in the above |
||||
example, you will instead specify "rows" and "cols".</p> |
||||
|
||||
|
||||
<h2>form_dropdown()</h2> |
||||
|
||||
<p>Lets you create a standard drop-down field. The first parameter will contain the name of the field, |
||||
the second parameter will contain an associative array of options, and the third parameter will contain the |
||||
value you wish to be selected. You can also pass an array of multiple items through the third parameter, and CodeIgniter will create a multiple select for you. Example:</p> |
||||
|
||||
<code>$options = array(<br /> |
||||
'small' => 'Small Shirt',<br /> |
||||
'med' => 'Medium Shirt',<br /> |
||||
'large' => 'Large Shirt',<br /> |
||||
'xlarge' => 'Extra Large Shirt',<br /> |
||||
);<br /> |
||||
<br /> |
||||
$shirts_on_sale = array('small', 'large');<br /> |
||||
<br /> |
||||
echo form_dropdown('shirts', $options, 'large');<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
<br /> |
||||
<select name="shirts"><br /> |
||||
<option value="small">Small Shirt</option><br /> |
||||
<option value="med">Medium Shirt</option><br /> |
||||
<option value="large" selected="selected">Large Shirt</option><br /> |
||||
<option value="xlarge">Extra Large Shirt</option><br /> |
||||
</select><br /> |
||||
<br /> |
||||
echo form_dropdown('shirts', $options, $shirts_on_sale);<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
<br /> |
||||
<select name="shirts" multiple="multiple"><br /> |
||||
<option value="small" selected="selected">Small Shirt</option><br /> |
||||
<option value="med">Medium Shirt</option><br /> |
||||
<option value="large" selected="selected">Large Shirt</option><br /> |
||||
<option value="xlarge">Extra Large Shirt</option><br /> |
||||
</select></code> |
||||
|
||||
|
||||
<p>If you would like the opening <select> to contain additional data, like an <kbd>id</kbd> attribute or JavaScript, you can pass it as a string in the |
||||
fourth parameter:</p> |
||||
|
||||
<code>$js = 'id="shirts" onChange="some_function();"';<br /> |
||||
<br /> |
||||
echo form_dropdown('shirts', $options, 'large', $js);</code> |
||||
|
||||
<p>If the array passed as $options is a multidimensional array, form_dropdown() will produce an <optgroup> with the array key as the label.</p> |
||||
|
||||
<h2>form_multiselect()</h2> |
||||
|
||||
<p>Lets you create a standard multiselect field. The first parameter will contain the name of the field, |
||||
the second parameter will contain an associative array of options, and the third parameter will contain the |
||||
value or values you wish to be selected. The parameter usage is identical to using <kbd>form_dropdown()</kbd> above, |
||||
except of course that the name of the field will need to use POST array syntax, e.g. <samp>foo[]</samp>.</p> |
||||
|
||||
|
||||
<h2>form_fieldset()</h2> |
||||
|
||||
<p>Lets you generate fieldset/legend fields.</p> |
||||
<code>echo form_fieldset('Address Information');<br /> |
||||
echo "<p>fieldset content here</p>\n";<br /> |
||||
echo form_fieldset_close(); |
||||
<br /> |
||||
<br /> |
||||
// Produces<br /> |
||||
<fieldset> |
||||
<br /> |
||||
<legend>Address Information</legend> |
||||
<br /> |
||||
<p>form content here</p> |
||||
<br /> |
||||
</fieldset></code> |
||||
<p>Similar to other functions, you can submit an associative array in the second parameter if you prefer to set additional attributes. </p> |
||||
<p><code>$attributes = array('id' => 'address_info', 'class' => 'address_info');<br /> |
||||
echo form_fieldset('Address Information', $attributes);<br /> |
||||
echo "<p>fieldset content here</p>\n";<br /> |
||||
echo form_fieldset_close(); <br /> |
||||
<br /> |
||||
// Produces<br /> |
||||
<fieldset id="address_info" class="address_info"> <br /> |
||||
<legend>Address Information</legend> <br /> |
||||
<p>form content here</p> <br /> |
||||
</fieldset></code></p> |
||||
<h2>form_fieldset_close()</h2> |
||||
<p>Produces a closing </fieldset> tag. The only advantage to using this function is it permits you to pass data to it |
||||
which will be added below the tag. For example:</p> |
||||
<code>$string = "</div></div>";<br /> |
||||
<br /> |
||||
echo form_fieldset_close($string);<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
</fieldset><br /> |
||||
</div></div></code> |
||||
<h2>form_checkbox()</h2> |
||||
<p>Lets you generate a checkbox field. Simple example:</p> |
||||
<code>echo form_checkbox('newsletter', 'accept', TRUE);<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
<br /> |
||||
<input type="checkbox" name="newsletter" value="accept" checked="checked" /></code> |
||||
<p>The third parameter contains a boolean TRUE/FALSE to determine whether the box should be checked or not.</p> |
||||
<p>Similar to the other form functions in this helper, you can also pass an array of attributes to the function:</p> |
||||
|
||||
<code>$data = array(<br /> |
||||
'name' => 'newsletter',<br /> |
||||
'id' => 'newsletter',<br /> |
||||
'value' => 'accept',<br /> |
||||
'checked' => TRUE,<br /> |
||||
'style' => 'margin:10px',<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo form_checkbox($data);<br /> |
||||
<br /> |
||||
// Would produce:<br /><br /> |
||||
<input type="checkbox" name="newsletter" id="newsletter" value="accept" checked="checked" style="margin:10px" /></code> |
||||
|
||||
<p>As with other functions, if you would like the tag to contain additional data, like JavaScript, you can pass it as a string in the |
||||
fourth parameter:</p> |
||||
|
||||
<code>$js = 'onClick="some_function()"';<br /> |
||||
<br /> |
||||
echo form_checkbox('newsletter', 'accept', TRUE, $js)</code> |
||||
|
||||
|
||||
<h2>form_radio()</h2> |
||||
<p>This function is identical in all respects to the <dfn>form_checkbox()</dfn> function above except that is sets it as a "radio" type.</p> |
||||
|
||||
|
||||
<h2>form_submit()</h2> |
||||
|
||||
<p>Lets you generate a standard submit button. Simple example:</p> |
||||
<code>echo form_submit('mysubmit', 'Submit Post!');<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
<br /> |
||||
<input type="submit" name="mysubmit" value="Submit Post!" /></code> |
||||
<p>Similar to other functions, you can submit an associative array in the first parameter if you prefer to set your own attributes. |
||||
The third parameter lets you add extra data to your form, like JavaScript.</p> |
||||
<h2>form_label()</h2> |
||||
<p>Lets you generate a <label>. Simple example:</p> |
||||
<code>echo form_label('What is your Name', 'username');<br /> |
||||
<br /> |
||||
// Would produce: |
||||
<br /> |
||||
<label for="username">What is your Name</label></code> |
||||
<p>Similar to other functions, you can submit an associative array in the third parameter if you prefer to set additional attributes. </p> |
||||
<p><code>$attributes = array(<br /> |
||||
'class' => 'mycustomclass',<br /> |
||||
'style' => 'color: #000;',<br /> |
||||
);<br /> |
||||
echo form_label('What is your Name', 'username', $attributes);<br /> |
||||
<br /> |
||||
// Would produce: <br /> |
||||
<label for="username" class="mycustomclass" style="color: #000;">What is your Name</label></code></p> |
||||
<h2>form_reset()</h2> |
||||
|
||||
<p>Lets you generate a standard reset button. Use is identical to <dfn>form_submit()</dfn>.</p> |
||||
|
||||
<h2>form_button()</h2> |
||||
|
||||
<p>Lets you generate a standard button element. You can minimally pass the button name and content in the first and second parameter:</p> |
||||
<code> |
||||
echo form_button('name','content');<br /> |
||||
<br /> |
||||
// Would produce<br /> |
||||
<button name="name" type="button">Content</button> |
||||
</code> |
||||
|
||||
Or you can pass an associative array containing any data you wish your form to contain: |
||||
<code> |
||||
$data = array(<br /> |
||||
'name' => 'button',<br /> |
||||
'id' => 'button',<br /> |
||||
'value' => 'true',<br /> |
||||
'type' => 'reset',<br /> |
||||
'content' => 'Reset'<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo form_button($data);<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
<button name="button" id="button" value="true" type="reset">Reset</button> |
||||
</code> |
||||
|
||||
If you would like your form to contain some additional data, like JavaScript, you can pass it as a string in the third parameter: |
||||
<code> |
||||
$js = 'onClick="some_function()"';<br /><br /> |
||||
echo form_button('mybutton', 'Click Me', $js); |
||||
</code> |
||||
|
||||
|
||||
<h2>form_close()</h2> |
||||
|
||||
<p>Produces a closing </form> tag. The only advantage to using this function is it permits you to pass data to it |
||||
which will be added below the tag. For example:</p> |
||||
|
||||
<code>$string = "</div></div>";<br /> |
||||
<br /> |
||||
echo form_close($string);<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
<br /> |
||||
</form><br /> |
||||
</div></div></code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>form_prep()</h2> |
||||
|
||||
<p>Allows you to safely use HTML and characters such as quotes within form elements without breaking out of the form. Consider this example:</p> |
||||
|
||||
<code>$string = 'Here is a string containing <strong>"quoted"</strong> text.';<br /> |
||||
<br /> |
||||
<input type="text" name="myform" value="<var>$string</var>" /></code> |
||||
|
||||
<p>Since the above string contains a set of quotes it will cause the form to break. |
||||
The form_prep function converts HTML so that it can be used safely:</p> |
||||
|
||||
<code><input type="text" name="myform" value="<var><?php echo form_prep($string); ?></var>" /></code> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you use any of the form helper functions listed in this page the form |
||||
values will be prepped automatically, so there is no need to call this function. Use it only if you are |
||||
creating your own form elements.</p> |
||||
|
||||
|
||||
<h2>set_value()</h2> |
||||
|
||||
<p>Permits you to set the value of an input form or textarea. You must supply the field name via the first parameter of the function. |
||||
The second (optional) parameter allows you to set a default value for the form. Example:</p> |
||||
|
||||
<code><input type="text" name="quantity" value="<dfn><?php echo set_value('quantity', '0'); ?></dfn>" size="50" /></code> |
||||
|
||||
<p>The above form will show "0" when loaded for the first time.</p> |
||||
|
||||
<h2>set_select()</h2> |
||||
|
||||
<p>If you use a <dfn><select></dfn> menu, this function permits you to display the menu item that was selected. The first parameter |
||||
must contain the name of the select menu, the second parameter must contain the value of |
||||
each item, and the third (optional) parameter lets you set an item as the default (use boolean TRUE/FALSE).</p> |
||||
|
||||
<p>Example:</p> |
||||
|
||||
<code> |
||||
<select name="myselect"><br /> |
||||
<option value="one" <dfn><?php echo set_select('myselect', 'one', TRUE); ?></dfn> >One</option><br /> |
||||
<option value="two" <dfn><?php echo set_select('myselect', 'two'); ?></dfn> >Two</option><br /> |
||||
<option value="three" <dfn><?php echo set_select('myselect', 'three'); ?></dfn> >Three</option><br /> |
||||
</select> |
||||
</code> |
||||
|
||||
|
||||
<h2>set_checkbox()</h2> |
||||
|
||||
<p>Permits you to display a checkbox in the state it was submitted. The first parameter |
||||
must contain the name of the checkbox, the second parameter must contain its value, and the third (optional) parameter lets you set an item as the default (use boolean TRUE/FALSE). Example:</p> |
||||
|
||||
<code><input type="checkbox" name="mycheck" value="1" <dfn><?php echo set_checkbox('mycheck', '1'); ?></dfn> /><br /> |
||||
<input type="checkbox" name="mycheck" value="2" <dfn><?php echo set_checkbox('mycheck', '2'); ?></dfn> /></code> |
||||
|
||||
|
||||
<h2>set_radio()</h2> |
||||
|
||||
<p>Permits you to display radio buttons in the state they were submitted. This function is identical to the <strong>set_checkbox()</strong> function above.</p> |
||||
|
||||
<code><input type="radio" name="myradio" value="1" <dfn><?php echo set_radio('myradio', '1', TRUE); ?></dfn> /><br /> |
||||
<input type="radio" name="myradio" value="2" <dfn><?php echo set_radio('myradio', '2'); ?></dfn> /></code> |
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="file_helper.html">File Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="html_helper.html">HTML Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,390 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>HTML 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
HTML 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>HTML Helper</h1> |
||||
|
||||
<p>The HTML Helper file contains functions that assist in working with HTML.</p> |
||||
|
||||
<ul> |
||||
<li><a href="#br">br()</a></li> |
||||
<li><a href="#heading">heading()</a></li> |
||||
<li><a href="#img">img()</a></li> |
||||
<li><a href="#link_tag">link_tag()</a></li> |
||||
<li><a href="#nbs">nbs()</a></li> |
||||
<li><a href="#ol_and_ul">ol() and ul()</a></li> |
||||
<li><a href="#meta">meta()</a></li> |
||||
<li><a href="#doctype">doctype()</a></li> |
||||
</ul> |
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('html');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2><a name="br"></a>br()</h2> |
||||
<p>Generates line break tags (<br />) based on the number you submit. Example:</p> |
||||
<code>echo br(3);</code> |
||||
<p>The above would produce: <br /><br /><br /></p> |
||||
|
||||
<h2><a name="heading"></a>heading()</h2> |
||||
<p>Lets you create HTML <h1> tags. The first parameter will contain the data, the |
||||
second the size of the heading. Example:</p> |
||||
<code>echo heading('Welcome!', 3);</code> |
||||
<p>The above would produce: <h3>Welcome!</h3></p> |
||||
|
||||
<p>Additionally, in order to add attributes to the heading tag such as HTML classes, ids or inline styles, a third parameter is available.</p> |
||||
<code>echo heading('Welcome!', 3, 'class="pink"')</code> |
||||
<p>The above code produces: <h3 class="pink">Welcome!<<h3></p> |
||||
|
||||
|
||||
<h2><a name="img"></a>img()</h2> |
||||
<p>Lets you create HTML <img /> tags. The first parameter contains the image source. Example:</p> |
||||
<code>echo img('images/picture.jpg');<br /> |
||||
// gives <img src="http://site.com/images/picture.jpg" /></code> |
||||
<p>There is an optional second parameter that is a TRUE/FALSE value that specifics if the src should have the page specified by $config['index_page'] added to the address it creates. Presumably, this would be if you were using a media controller.</p> |
||||
<p><code>echo img('images/picture.jpg', TRUE);<br /> |
||||
// gives <img src="http://site.com/index.php/images/picture.jpg" alt="" /></code></p> |
||||
<p>Additionally, an associative array can be passed to the img() function for complete control over all attributes and values. If an alt attribute is not provided, CodeIgniter will generate an empty string.</p> |
||||
<p><code> $image_properties = array(<br /> |
||||
'src' => 'images/picture.jpg',<br /> |
||||
'alt' => 'Me, demonstrating how to eat 4 slices of pizza at one time',<br /> |
||||
'class' => 'post_images',<br /> |
||||
'width' => '200',<br /> |
||||
'height' => '200',<br /> |
||||
'title' => 'That was quite a night',<br /> |
||||
'rel' => 'lightbox',<br /> |
||||
);<br /> |
||||
<br /> |
||||
img($image_properties);<br /> |
||||
// <img src="http://site.com/index.php/images/picture.jpg" alt="Me, demonstrating how to eat 4 slices of pizza at one time" class="post_images" width="200" height="200" title="That was quite a night" rel="lightbox" /></code></p> |
||||
|
||||
<h2><a name="link_tag"></a>link_tag()</h2> |
||||
<p>Lets you create HTML <link /> tags. This is useful for stylesheet links, as well as other links. The parameters are href, with optional rel, type, title, media and index_page. index_page is a TRUE/FALSE value that specifics if the href should have the page specified by $config['index_page'] added to the address it creates.<code> |
||||
echo link_tag('css/mystyles.css');<br /> |
||||
// gives <link href="http://site.com/css/mystyles.css" rel="stylesheet" type="text/css" /></code></p> |
||||
<p>Further examples:</p> |
||||
|
||||
<code> |
||||
echo link_tag('favicon.ico', 'shortcut icon', 'image/ico');<br /> |
||||
// <link href="http://site.com/favicon.ico" rel="shortcut icon" type="image/ico" /> |
||||
<br /> |
||||
<br /> |
||||
echo link_tag('feed', 'alternate', 'application/rss+xml', 'My RSS Feed');<br /> |
||||
// <link href="http://site.com/feed" rel="alternate" type="application/rss+xml" title="My RSS Feed" /> </code> |
||||
<p>Additionally, an associative array can be passed to the link() function for complete control over all attributes and values.</p> |
||||
<p><code> |
||||
$link = array(<br /> |
||||
'href' => 'css/printer.css',<br /> |
||||
'rel' => 'stylesheet',<br /> |
||||
'type' => 'text/css',<br /> |
||||
'media' => 'print'<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo link_tag($link);<br /> |
||||
// <link href="http://site.com/css/printer.css" rel="stylesheet" type="text/css" media="print" /></code></p> |
||||
|
||||
<h2><a name="nbs"></a>nbs()</h2> |
||||
<p>Generates non-breaking spaces (&nbsp;) based on the number you submit. Example:</p> |
||||
<code>echo nbs(3);</code> |
||||
<p>The above would produce: &nbsp;&nbsp;&nbsp;</p> |
||||
|
||||
<h2><a name="ol_and_ul"></a>ol() and ul()</h2> |
||||
|
||||
<p>Permits you to generate ordered or unordered HTML lists from simple or multi-dimensional arrays. Example:</p> |
||||
|
||||
<code> |
||||
$this->load->helper('html');<br /> |
||||
<br /> |
||||
$list = array(<br /> |
||||
'red', <br /> |
||||
'blue', <br /> |
||||
'green',<br /> |
||||
'yellow'<br /> |
||||
);<br /> |
||||
<br /> |
||||
$attributes = array(<br /> |
||||
'class' => 'boldlist',<br /> |
||||
'id' => 'mylist'<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo ul($list, $attributes);<br /> |
||||
</code> |
||||
|
||||
<p>The above code will produce this:</p> |
||||
|
||||
<code> |
||||
<ul class="boldlist" id="mylist"><br /> |
||||
<li>red</li><br /> |
||||
<li>blue</li><br /> |
||||
<li>green</li><br /> |
||||
<li>yellow</li><br /> |
||||
</ul> |
||||
</code> |
||||
|
||||
<p>Here is a more complex example, using a multi-dimensional array:</p> |
||||
|
||||
<code> |
||||
$this->load->helper('html');<br /> |
||||
<br /> |
||||
$attributes = array(<br /> |
||||
'class' => 'boldlist',<br /> |
||||
'id' => 'mylist'<br /> |
||||
);<br /> |
||||
<br /> |
||||
$list = array(<br /> |
||||
'colors' => array(<br /> |
||||
'red',<br /> |
||||
'blue',<br /> |
||||
'green'<br /> |
||||
),<br /> |
||||
'shapes' => array(<br /> |
||||
'round', <br /> |
||||
'square',<br /> |
||||
'circles' => array(<br /> |
||||
'ellipse', <br /> |
||||
'oval', <br /> |
||||
'sphere'<br /> |
||||
)<br /> |
||||
),<br /> |
||||
'moods' => array(<br /> |
||||
'happy', <br /> |
||||
'upset' => array(<br /> |
||||
'defeated' => array(<br /> |
||||
'dejected',<br /> |
||||
'disheartened',<br /> |
||||
'depressed'<br /> |
||||
),<br /> |
||||
'annoyed',<br /> |
||||
'cross',<br /> |
||||
'angry'<br /> |
||||
)<br /> |
||||
)<br /> |
||||
);<br /> |
||||
<br /> |
||||
<br /> |
||||
echo ul($list, $attributes);</code> |
||||
|
||||
<p>The above code will produce this:</p> |
||||
|
||||
<code> |
||||
<ul class="boldlist" id="mylist"><br /> |
||||
<li>colors<br /> |
||||
<ul><br /> |
||||
<li>red</li><br /> |
||||
<li>blue</li><br /> |
||||
<li>green</li><br /> |
||||
</ul><br /> |
||||
</li><br /> |
||||
<li>shapes<br /> |
||||
<ul><br /> |
||||
<li>round</li><br /> |
||||
<li>suare</li><br /> |
||||
<li>circles<br /> |
||||
<ul><br /> |
||||
<li>elipse</li><br /> |
||||
<li>oval</li><br /> |
||||
<li>sphere</li><br /> |
||||
</ul><br /> |
||||
</li><br /> |
||||
</ul><br /> |
||||
</li><br /> |
||||
<li>moods<br /> |
||||
<ul><br /> |
||||
<li>happy</li><br /> |
||||
<li>upset<br /> |
||||
<ul><br /> |
||||
<li>defeated<br /> |
||||
<ul><br /> |
||||
<li>dejected</li><br /> |
||||
<li>disheartened</li><br /> |
||||
<li>depressed</li><br /> |
||||
</ul><br /> |
||||
</li><br /> |
||||
<li>annoyed</li><br /> |
||||
<li>cross</li><br /> |
||||
<li>angry</li><br /> |
||||
</ul><br /> |
||||
</li><br /> |
||||
</ul><br /> |
||||
</li><br /> |
||||
</ul> |
||||
</code> |
||||
|
||||
|
||||
|
||||
<h2><a name="meta"></a>meta()</h2> |
||||
|
||||
<p>Helps you generate meta tags. You can pass strings to the function, or simple arrays, or multidimensional ones. Examples:</p> |
||||
|
||||
<code> |
||||
echo meta('description', 'My Great site');<br /> |
||||
// Generates: <meta name="description" content="My Great Site" /><br /> |
||||
<br /><br /> |
||||
|
||||
echo meta('Content-type', 'text/html; charset=utf-8', 'equiv'); // Note the third parameter. Can be "equiv" or "name"<br /> |
||||
// Generates: <meta http-equiv="Content-type" content="text/html; charset=utf-8" /><br /> |
||||
|
||||
<br /><br /> |
||||
|
||||
echo meta(array('name' => 'robots', 'content' => 'no-cache'));<br /> |
||||
// Generates: <meta name="robots" content="no-cache" /><br /> |
||||
|
||||
<br /><br /> |
||||
|
||||
$meta = array(<br /> |
||||
array('name' => 'robots', 'content' => 'no-cache'),<br /> |
||||
array('name' => 'description', 'content' => 'My Great Site'),<br /> |
||||
array('name' => 'keywords', 'content' => 'love, passion, intrigue, deception'),<br /> |
||||
array('name' => 'robots', 'content' => 'no-cache'),<br /> |
||||
array('name' => 'Content-type', 'content' => 'text/html; charset=utf-8', 'type' => 'equiv')<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo meta($meta); |
||||
<br /> |
||||
// Generates: <br /> |
||||
// <meta name="robots" content="no-cache" /><br /> |
||||
// <meta name="description" content="My Great Site" /><br /> |
||||
// <meta name="keywords" content="love, passion, intrigue, deception" /><br /> |
||||
// <meta name="robots" content="no-cache" /><br /> |
||||
// <meta http-equiv="Content-type" content="text/html; charset=utf-8" /> |
||||
</code> |
||||
|
||||
|
||||
<h2><a name="doctype"></a>doctype()</h2> |
||||
|
||||
<p>Helps you generate document type declarations, or DTD's. XHTML 1.0 Strict is used by default, but many doctypes are available.</p> |
||||
|
||||
<code> |
||||
echo doctype();<br /> |
||||
// <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><br /> |
||||
<br /> |
||||
echo doctype('html4-trans');<br /> |
||||
// <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
||||
</code> |
||||
|
||||
<p>The following is a list of doctype choices. These are configurable, and pulled from <samp>application/config/doctypes.php</samp></p> |
||||
|
||||
<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder"> |
||||
<tr> |
||||
<th>Doctype</th> |
||||
<th>Option</th> |
||||
<th>Result</th> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">XHTML 1.1</td> |
||||
<td class="td">doctype('xhtml11')</td> |
||||
<td class="td"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"></td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">XHTML 1.0 Strict</td> |
||||
<td class="td">doctype('xhtml1-strict')</td> |
||||
<td class="td"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"></td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">XHTML 1.0 Transitional</td> |
||||
<td class="td">doctype('xhtml1-trans')</td> |
||||
<td class="td"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"></td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">XHTML 1.0 Frameset</td> |
||||
<td class="td">doctype('xhtml1-frame')</td> |
||||
<td class="td"><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"></td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">HTML 5</td> |
||||
<td class="td">doctype('html5')</td> |
||||
<td class="td"><!DOCTYPE html></td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">HTML 4 Strict</td> |
||||
<td class="td">doctype('html4-strict')</td> |
||||
<td class="td"><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"></td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">HTML 4 Transitional</td> |
||||
<td class="td">doctype('html4-trans')</td> |
||||
<td class="td"><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"></td> |
||||
</tr> |
||||
<tr> |
||||
<td class="td">HTML 4 Frameset</td> |
||||
<td class="td">doctype('html4-frame')</td> |
||||
<td class="td"><!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd"></td> |
||||
</tr> |
||||
</table> |
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="form_helper.html">Form Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="path_helper.html"> Path Helper</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,151 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Inflector 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Inflector 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>Inflector Helper</h1> |
||||
|
||||
<p>The Inflector Helper file contains functions that permits you to change words to plural, singular, camel case, etc.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('inflector');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
|
||||
<h2>singular()</h2> |
||||
|
||||
<p>Changes a plural word to singular. Example:</p> |
||||
|
||||
<code> |
||||
$word = "dogs";<br /> |
||||
echo singular($word); // Returns "dog" |
||||
</code> |
||||
|
||||
|
||||
<h2>plural()</h2> |
||||
|
||||
<p>Changes a singular word to plural. Example:</p> |
||||
|
||||
<code> |
||||
$word = "dog";<br /> |
||||
echo plural($word); // Returns "dogs" |
||||
</code> |
||||
|
||||
|
||||
<p>To force a word to end with "es" use a second "true" argument. </p> |
||||
<code> $word = "pass";<br /> |
||||
echo plural($word, TRUE); // Returns "passes" </code> |
||||
|
||||
<h2>camelize()</h2> |
||||
<p>Changes a string of words separated by spaces or underscores to camel case. Example:</p> |
||||
|
||||
<code> |
||||
$word = "my_dog_spot";<br /> |
||||
echo camelize($word); // Returns "myDogSpot" |
||||
</code> |
||||
|
||||
|
||||
<h2>underscore()</h2> |
||||
|
||||
<p>Takes multiple words separated by spaces and underscores them. Example:</p> |
||||
|
||||
<code> |
||||
$word = "my dog spot";<br /> |
||||
echo underscore($word); // Returns "my_dog_spot" |
||||
</code> |
||||
|
||||
|
||||
<h2>humanize()</h2> |
||||
|
||||
<p>Takes multiple words separated by underscores and adds spaces between them. Each word is capitalized. Example:</p> |
||||
|
||||
<code> |
||||
$word = "my_dog_spot";<br /> |
||||
echo humanize($word); // Returns "My Dog Spot" |
||||
</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="html_helper.html"> HTML Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="number_helper.html">Number Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,98 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Language 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Language 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>Language Helper</h1> |
||||
|
||||
<p>The Language Helper file contains functions that assist in working with language files.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('language');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>lang('<var>language line</var>', '<var>element id</var>')</h2> |
||||
|
||||
<p>This function returns a line of text from a loaded language file with simplified syntax |
||||
that may be more desirable for view files than calling <kbd>$this->lang->line()</kbd>. |
||||
The optional second parameter will also output a form label for you. Example:</p> |
||||
|
||||
<code>echo lang('<samp>language_key</samp>', '<samp>form_item_id</samp>');<br /> |
||||
// becomes <label for="form_item_id">language_key</label></code> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="date_helper.html">Date Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="download_helper.html">Download Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,113 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Number 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Number 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>Number Helper</h1> |
||||
|
||||
<p>The Number Helper file contains functions that help you work with numeric data.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('number');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
|
||||
<h2>byte_format()</h2> |
||||
|
||||
<p>Formats a numbers as bytes, based on size, and adds the appropriate suffix. Examples:</p> |
||||
|
||||
<code> |
||||
echo byte_format(456); // Returns 456 Bytes<br /> |
||||
echo byte_format(4567); // Returns 4.5 KB<br /> |
||||
echo byte_format(45678); // Returns 44.6 KB<br /> |
||||
echo byte_format(456789); // Returns 447.8 KB<br /> |
||||
echo byte_format(3456789); // Returns 3.3 MB<br /> |
||||
echo byte_format(12345678912345); // Returns 1.8 GB<br /> |
||||
echo byte_format(123456789123456789); // Returns 11,228.3 TB |
||||
</code> |
||||
|
||||
<p>An optional second parameter allows you to set the precision of the result.</p> |
||||
|
||||
<code> |
||||
echo byte_format(45678, 2); // Returns 44.61 KB |
||||
</code> |
||||
|
||||
<p class="important"> |
||||
<strong>Note:</strong> |
||||
The text generated by this function is found in the following language file: language/<your_lang>/number_lang.php |
||||
</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="inflector_helper.html">Inflector Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="path_helper.html">Path Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,106 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Path 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Path 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>Path Helper</h1> |
||||
|
||||
<p>The Path Helper file contains functions that permits you to work with file paths on the server.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('path');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
|
||||
<h2>set_realpath()</h2> |
||||
|
||||
<p>Checks to see if the path exists. This function will return a server path without symbolic links or relative directory structures. An optional second argument will cause an error to be triggered if the path cannot be resolved.</p> |
||||
|
||||
<code>$directory = '/etc/passwd';<br /> |
||||
echo set_realpath($directory);<br /> |
||||
// returns "/etc/passwd"<br /> |
||||
<br /> |
||||
$non_existent_directory = '/path/to/nowhere';<br /> |
||||
echo set_realpath($non_existent_directory, TRUE);<br /> |
||||
// returns an <strong>error</strong>, as the path could not be resolved |
||||
<br /><br /> |
||||
echo set_realpath($non_existent_directory, FALSE);<br /> |
||||
// returns "/path/to/nowhere" |
||||
|
||||
|
||||
|
||||
</code> |
||||
<h2> </h2> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="number_helper.html">Number Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="security_helper.html">Security Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,132 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Security 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Security 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>Security Helper</h1> |
||||
|
||||
<p>The Security Helper file contains security related functions.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('security');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
|
||||
<h2>xss_clean()</h2> |
||||
|
||||
<p>Provides Cross Site Script Hack filtering. This function is an alias to the one in the |
||||
<a href="../libraries/input.html">Input class</a>. More info can be found there.</p> |
||||
|
||||
|
||||
<h2>sanitize_filename()</h2> |
||||
|
||||
<p>Provides protection against directory traversal. This function is an alias to the one in the |
||||
<a href="../libraries/security.html">Security class</a>. More info can be found there.</p> |
||||
|
||||
|
||||
<h2>do_hash()</h2> |
||||
|
||||
<p>Permits you to create SHA1 or MD5 one way hashes suitable for encrypting passwords. Will create SHA1 by default. Examples:</p> |
||||
|
||||
<code> |
||||
$str = do_hash($str); // SHA1<br /> |
||||
<br /> |
||||
$str = do_hash($str, 'md5'); // MD5 |
||||
</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> This function was formerly named <kbd>dohash()</kbd>, which has been deprecated in favour of <kbd>do_hash()</kbd>.</p> |
||||
|
||||
|
||||
|
||||
<h2>strip_image_tags()</h2> |
||||
|
||||
<p>This is a security function that will strip image tags from a string. It leaves the image URL as plain text.</p> |
||||
|
||||
<code>$string = strip_image_tags($string);</code> |
||||
|
||||
|
||||
<h2>encode_php_tags()</h2> |
||||
|
||||
<p>This is a security function that converts PHP tags to entities. Note: If you use the XSS filtering function it does this automatically.</p> |
||||
|
||||
<code>$string = encode_php_tags($string);</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="path_helper.html"> Path Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="smiley_helper.html">Smiley Helper</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,215 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Smiley 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Smiley 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>Smiley Helper</h1> |
||||
|
||||
<p>The Smiley Helper file contains functions that let you manage smileys (emoticons).</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('smiley');</code> |
||||
|
||||
<h2>Overview</h2> |
||||
|
||||
<p>The Smiley helper has a renderer that takes plain text simileys, like <dfn>:-)</dfn> and turns |
||||
them into a image representation, like <img src="../images/smile.gif" width="19" height="19" border="0" alt="smile!" /></p> |
||||
|
||||
<p>It also lets you display a set of smiley images that when clicked will be inserted into a form field. |
||||
For example, if you have a blog that allows user commenting you can show the smileys next to the comment form. |
||||
Your users can click a desired smiley and with the help of some JavaScript it will be placed into the form field.</p> |
||||
|
||||
|
||||
|
||||
<h2>Clickable Smileys Tutorial</h2> |
||||
|
||||
<p>Here is an example demonstrating how you might create a set of clickable smileys next to a form field. This example |
||||
requires that you first download and install the smiley images, then create a controller and the View as described.</p> |
||||
|
||||
<p class="important"><strong>Important:</strong> Before you begin, please <a href="http://codeigniter.com/download_files/smileys.zip">download the smiley images</a> and put them in |
||||
a publicly accessible place on your server. This helper also assumes you have the smiley replacement array located at |
||||
<dfn>application/config/smileys.php</dfn></p> |
||||
|
||||
|
||||
<h3>The Controller</h3> |
||||
|
||||
<p>In your <dfn>application/controllers/</dfn> folder, create a file called <kbd>smileys.php</kbd> and place the code below in it.</p> |
||||
|
||||
<p><strong>Important:</strong> Change the URL in the <dfn>get_clickable_smileys()</dfn> function below so that it points to |
||||
your <dfn>smiley</dfn> folder.</p> |
||||
|
||||
<p>You'll notice that in addition to the smiley helper we are using the <a href="../libraries/table.html">Table Class</a>.</p> |
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="25"> |
||||
<?php |
||||
|
||||
class Smileys extends CI_Controller { |
||||
|
||||
function __construct() |
||||
{ |
||||
parent::__construct(); |
||||
} |
||||
|
||||
function index() |
||||
{ |
||||
$this->load->helper('smiley'); |
||||
$this->load->library('table'); |
||||
|
||||
$image_array = get_clickable_smileys('http://example.com/images/smileys/', 'comments'); |
||||
|
||||
$col_array = $this->table->make_columns($image_array, 8); |
||||
|
||||
$data['smiley_table'] = $this->table->generate($col_array); |
||||
|
||||
$this->load->view('smiley_view', $data); |
||||
} |
||||
|
||||
} |
||||
?> |
||||
</textarea> |
||||
|
||||
<p>In your <dfn>application/views/</dfn> folder, create a file called <kbd>smiley_view.php</kbd> and place this code in it:</p> |
||||
|
||||
<textarea class="textarea" style="width:100%" cols="50" rows="20"> |
||||
<html> |
||||
<head> |
||||
<title>Smileys</title> |
||||
|
||||
<?php echo smiley_js(); ?> |
||||
|
||||
</head> |
||||
<body> |
||||
|
||||
<form name="blog"> |
||||
<textarea name="comments" id="comments" cols="40" rows="4"></textarea> |
||||
</form> |
||||
|
||||
<p>Click to insert a smiley!</p> |
||||
|
||||
<?php echo $smiley_table; ?> |
||||
|
||||
</body> |
||||
</html> |
||||
</textarea> |
||||
|
||||
|
||||
<p>When you have created the above controller and view, load it by visiting <dfn>http://www.example.com/index.php/smileys/</dfn></p> |
||||
|
||||
|
||||
<h3>Field Aliases</h3> |
||||
|
||||
<p>When making changes to a view it can be inconvenient to have the field id in the controller. To work around this, |
||||
you can give your smiley links a generic name that will be tied to a specific id in your view.</p> |
||||
<code>$image_array = get_smiley_links("http://example.com/images/smileys/", "comment_textarea_alias");</code> |
||||
|
||||
<p>To map the alias to the field id, pass them both into the smiley_js function:</p> |
||||
<code>$image_array = smiley_js("comment_textarea_alias", "comments");</code> |
||||
|
||||
|
||||
<h1>Function Reference</h1> |
||||
|
||||
<h2>get_clickable_smileys()</h2> |
||||
|
||||
<p>Returns an array containing your smiley images wrapped in a clickable link. You must supply the URL to your smiley folder |
||||
and a field id or field alias.</p> |
||||
|
||||
<code>$image_array = get_smiley_links("http://example.com/images/smileys/", "comment");</code> |
||||
<p class="important">Note: Usage of this function without the second parameter, in combination with js_insert_smiley has been deprecated.</p> |
||||
|
||||
|
||||
<h2>smiley_js()</h2> |
||||
|
||||
<p>Generates the JavaScript that allows the images to be clicked and inserted into a form field. |
||||
If you supplied an alias instead of an id when generating your smiley links, you need to pass the |
||||
alias and corresponding form id into the function. |
||||
This function is designed to be placed into the <head> area of your web page.</p> |
||||
|
||||
<code><?php echo smiley_js(); ?></code> |
||||
<p class="important">Note: This function replaces js_insert_smiley, which has been deprecated.</p> |
||||
|
||||
|
||||
<h2>parse_smileys()</h2> |
||||
|
||||
<p>Takes a string of text as input and replaces any contained plain text smileys into the image |
||||
equivalent. The first parameter must contain your string, the second must contain the URL to your smiley folder:</p> |
||||
|
||||
<code> |
||||
$str = 'Here are some simileys: :-) ;-)'; |
||||
|
||||
$str = parse_smileys($str, "http://example.com/images/smileys/"); |
||||
|
||||
echo $str; |
||||
</code> |
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="security_helper.html">Security Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="string_helper.html">String Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,189 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>String 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
String 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>String Helper</h1> |
||||
|
||||
<p>The String Helper file contains functions that assist in working with strings.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('string');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>random_string()</h2> |
||||
|
||||
<p>Generates a random string based on the type and length you specify. Useful for creating passwords or generating random hashes.</p> |
||||
|
||||
<p>The first parameter specifies the type of string, the second parameter specifies the length. The following choices are available:</p> |
||||
|
||||
alpha, alunum, numeric, nozero, unique, md5, encrypt and sha1 |
||||
<ul> |
||||
<li><strong>alpha</strong>: A string with lower and uppercase letters only.</li> |
||||
<li><strong>alnum</strong>: Alpha-numeric string with lower and uppercase characters.</li> |
||||
<li><strong>numeric</strong>: Numeric string.</li> |
||||
<li><strong>nozero</strong>: Numeric string with no zeros.</li> |
||||
<li><strong>unique</strong>: Encrypted with MD5 and uniqid(). Note: The length parameter is not available for this type. |
||||
Returns a fixed length 32 character string.</li> |
||||
<li><strong>sha1</strong>: An encrypted random number based on <kbd>do_hash()</kbd> from the <a href="security_helper.html">security helper</a>.</li> |
||||
</ul> |
||||
|
||||
<p>Usage example:</p> |
||||
|
||||
<code>echo random_string('alnum', 16);</code> |
||||
|
||||
|
||||
<h2>increment_string()</h2> |
||||
|
||||
<p>Increments a string by appending a number to it or increasing the number. Useful for creating "copies" or a file or duplicating database content which has unique titles or slugs.</p> |
||||
|
||||
<p>Usage example:</p> |
||||
|
||||
<code>echo increment_string('file', '_'); // "file_1"<br/> |
||||
echo increment_string('file', '-', 2); // "file-2"<br/> |
||||
echo increment_string('file-4'); // "file-5"<br/></code> |
||||
|
||||
|
||||
<h2>alternator()</h2> |
||||
|
||||
<p>Allows two or more items to be alternated between, when cycling through a loop. Example:</p> |
||||
|
||||
<code>for ($i = 0; $i < 10; $i++)<br /> |
||||
{<br /> |
||||
echo alternator('string one', 'string two');<br /> |
||||
}<br /> |
||||
</code> |
||||
|
||||
<p>You can add as many parameters as you want, and with each iteration of your loop the next item will be returned.</p> |
||||
|
||||
<code>for ($i = 0; $i < 10; $i++)<br /> |
||||
{<br /> |
||||
echo alternator('one', 'two', 'three', 'four', 'five');<br /> |
||||
}<br /> |
||||
</code> |
||||
|
||||
<p><strong>Note:</strong> To use multiple separate calls to this function simply call the function with no arguments to re-initialize.</p> |
||||
|
||||
|
||||
|
||||
<h2>repeater()</h2> |
||||
<p>Generates repeating copies of the data you submit. Example:</p> |
||||
<code>$string = "\n";<br /> |
||||
echo repeater($string, 30);</code> |
||||
|
||||
<p>The above would generate 30 newlines.</p> |
||||
<h2>reduce_double_slashes()</h2> |
||||
<p>Converts double slashes in a string to a single slash, except those found in http://. Example: </p> |
||||
<code>$string = "http://example.com//index.php";<br /> |
||||
echo reduce_double_slashes($string); // results in "http://example.com/index.php"</code> |
||||
<h2>trim_slashes()</h2> |
||||
<p>Removes any leading/trailing slashes from a string. Example:<br /> |
||||
<br /> |
||||
<code>$string = "/this/that/theother/";<br /> |
||||
echo trim_slashes($string); // results in this/that/theother</code></p> |
||||
|
||||
|
||||
<h2>reduce_multiples()</h2> |
||||
<p>Reduces multiple instances of a particular character occuring directly after each other. Example:</p> |
||||
<code> |
||||
$string="Fred, Bill,, Joe, Jimmy";<br /> |
||||
$string=reduce_multiples($string,","); //results in "Fred, Bill, Joe, Jimmy" |
||||
</code> |
||||
<p>The function accepts the following parameters: |
||||
<code>reduce_multiples(string: text to search in, string: character to reduce, boolean: whether to remove the character from the front and end of the string)</code> |
||||
|
||||
The first parameter contains the string in which you want to reduce the multiplies. The second parameter contains the character you want to have reduced. |
||||
The third parameter is FALSE by default; if set to TRUE it will remove occurences of the character at the beginning and the end of the string. Example: |
||||
|
||||
<code> |
||||
$string=",Fred, Bill,, Joe, Jimmy,";<br /> |
||||
$string=reduce_multiples($string, ", ", TRUE); //results in "Fred, Bill, Joe, Jimmy" |
||||
</code> |
||||
</p> |
||||
|
||||
<h2>quotes_to_entities()</h2> |
||||
<p>Converts single and double quotes in a string to the corresponding HTML entities. Example:</p> |
||||
<code>$string="Joe's \"dinner\"";<br /> |
||||
$string=quotes_to_entities($string); //results in "Joe&#39;s &quot;dinner&quot;" |
||||
</code> |
||||
|
||||
<h2>strip_quotes()</h2> |
||||
<p>Removes single and double quotes from a string. Example:</p> |
||||
<code>$string="Joe's \"dinner\"";<br /> |
||||
$string=strip_quotes($string); //results in "Joes dinner" |
||||
</code> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="smiley_helper.html">Smiley Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="text_helper.html">Text Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,211 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Text 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Text 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>Text Helper</h1> |
||||
|
||||
<p>The Text Helper file contains functions that assist in working with text.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('text');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
|
||||
<h2>word_limiter()</h2> |
||||
|
||||
<p>Truncates a string to the number of <strong>words</strong> specified. Example:</p> |
||||
|
||||
<code> |
||||
$string = "Here is a nice text string consisting of eleven words.";<br /> |
||||
<br /> |
||||
$string = word_limiter($string, 4);<br /><br /> |
||||
|
||||
// Returns: Here is a nice… |
||||
</code> |
||||
|
||||
<p>The third parameter is an optional suffix added to the string. By default it adds an ellipsis.</p> |
||||
|
||||
|
||||
<h2>character_limiter()</h2> |
||||
|
||||
<p>Truncates a string to the number of <strong>characters</strong> specified. It maintains the integrity |
||||
of words so the character count may be slightly more or less then what you specify. Example:</p> |
||||
|
||||
<code> |
||||
$string = "Here is a nice text string consisting of eleven words.";<br /> |
||||
<br /> |
||||
$string = character_limiter($string, 20);<br /><br /> |
||||
|
||||
// Returns: Here is a nice text string… |
||||
</code> |
||||
|
||||
<p>The third parameter is an optional suffix added to the string, if undeclared this helper uses an ellipsis.</p> |
||||
|
||||
|
||||
|
||||
<h2>ascii_to_entities()</h2> |
||||
|
||||
<p>Converts ASCII values to character entities, including high ASCII and MS Word characters that can cause problems when used in a web page, |
||||
so that they can be shown consistently regardless of browser settings or stored reliably in a database. |
||||
There is some dependence on your server's supported character sets, so it may not be 100% reliable in all cases, but for the most |
||||
part it should correctly identify characters outside the normal range (like accented characters). Example:</p> |
||||
|
||||
<code>$string = ascii_to_entities($string);</code> |
||||
|
||||
|
||||
<h2>entities_to_ascii()</h2> |
||||
|
||||
<p>This function does the opposite of the previous one; it turns character entities back into ASCII.</p> |
||||
|
||||
<h2>convert_accented_characters()</h2> |
||||
|
||||
<p>Transliterates high ASCII characters to low ASCII equivalents, useful when non-English characters need to be used where only standard ASCII characters are safely used, for instance, in URLs.</p> |
||||
|
||||
<code>$string = convert_accented_characters($string);</code> |
||||
|
||||
<p>This function uses a companion config file <dfn>application/config/foreign_chars.php</dfn> to define the to and from array for transliteration.</p> |
||||
|
||||
<h2>word_censor()</h2> |
||||
|
||||
<p>Enables you to censor words within a text string. The first parameter will contain the original string. The |
||||
second will contain an array of words which you disallow. The third (optional) parameter can contain a replacement value |
||||
for the words. If not specified they are replaced with pound signs: ####. Example:</p> |
||||
|
||||
<code> |
||||
$disallowed = array('darn', 'shucks', 'golly', 'phooey');<br /> |
||||
<br /> |
||||
$string = word_censor($string, $disallowed, 'Beep!');</code> |
||||
|
||||
|
||||
<h2>highlight_code()</h2> |
||||
|
||||
<p>Colorizes a string of code (PHP, HTML, etc.). Example:</p> |
||||
|
||||
<code>$string = highlight_code($string);</code> |
||||
|
||||
<p>The function uses PHP's highlight_string() function, so the colors used are the ones specified in your php.ini file.</p> |
||||
|
||||
|
||||
<h2>highlight_phrase()</h2> |
||||
|
||||
<p>Will highlight a phrase within a text string. The first parameter will contain the original string, the second will |
||||
contain the phrase you wish to highlight. The third and fourth parameters will contain the opening/closing HTML tags |
||||
you would like the phrase wrapped in. Example:</p> |
||||
|
||||
<code> |
||||
$string = "Here is a nice text string about nothing in particular.";<br /> |
||||
<br /> |
||||
$string = highlight_phrase($string, "nice text", '<span style="color:#990000">', '</span>'); |
||||
</code> |
||||
|
||||
<p>The above text returns:</p> |
||||
|
||||
<p>Here is a <span style="color:#990000">nice text</span> string about nothing in particular.</p> |
||||
|
||||
|
||||
|
||||
<h2>word_wrap()</h2> |
||||
|
||||
<p>Wraps text at the specified <strong>character</strong> count while maintaining complete words. Example:</p> |
||||
|
||||
<code>$string = "Here is a simple string of text that will help us demonstrate this function.";<br /> |
||||
<br /> |
||||
echo word_wrap($string, 25);<br /> |
||||
<br /> |
||||
// Would produce:<br /> |
||||
<br /> |
||||
Here is a simple string<br /> |
||||
of text that will help<br /> |
||||
us demonstrate this<br /> |
||||
function</code> |
||||
|
||||
<h2>ellipsize()</h2> |
||||
|
||||
<p>This function will strip tags from a string, split it at a defined maximum length, and insert an ellipsis.</p> |
||||
<p>The first parameter is the string to ellipsize, the second is the number of characters in the final string. The third parameter is where in the string the ellipsis should appear from 0 - 1, left to right. For example. a value of 1 will place the ellipsis at the right of the string, .5 in the middle, and 0 at the left.</p> |
||||
<p>An optional forth parameter is the kind of ellipsis. By default, <samp>&hellip;</samp> will be inserted.</p> |
||||
|
||||
<code>$str = 'this_string_is_entirely_too_long_and_might_break_my_design.jpg';<br /> |
||||
<br /> |
||||
echo ellipsize($str, 32, .5);</code> |
||||
|
||||
Produces: |
||||
|
||||
<code>this_string_is_e…ak_my_design.jpg</code> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="string_helper.html">String Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="typography_helper.html">Typography Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,112 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Typography 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Typography 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>Typography Helper</h1> |
||||
|
||||
<p>The Typography Helper file contains functions that help your format text in semantically relevant ways.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('typography');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
|
||||
<h2>auto_typography()</h2> |
||||
|
||||
<p>Formats text so that it is semantically and typographically correct HTML. Please see the <a href="../libraries/typography.html">Typography Class</a> for more info.</p> |
||||
|
||||
<p>Usage example:</p> |
||||
|
||||
<code>$string = auto_typography($string);</code> |
||||
|
||||
<p><strong>Note:</strong> Typographic formatting can be processor intensive, particularly if you have a lot of content being formatted. |
||||
If you choose to use this function you may want to consider |
||||
<a href="../general/caching.html">caching</a> your pages.</p> |
||||
|
||||
|
||||
<h2>nl2br_except_pre()</h2> |
||||
|
||||
<p>Converts newlines to <br /> tags unless they appear within <pre> tags. |
||||
This function is identical to the native PHP <dfn>nl2br()</dfn> function, except that it ignores <pre> tags.</p> |
||||
|
||||
<p>Usage example:</p> |
||||
|
||||
<code>$string = nl2br_except_pre($string);</code> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="text_helper.html">Text Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="url_helper.html">URL Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,302 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>URL 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
URL 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>URL Helper</h1> |
||||
|
||||
<p>The URL Helper file contains functions that assist in working with URLs.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('url');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>site_url()</h2> |
||||
|
||||
<p>Returns your site URL, as specified in your config file. The index.php file (or whatever you have set as your |
||||
site <dfn>index_page</dfn> in your config file) will be added to the URL, as will any URI segments you pass to the function, and the <dfn>url_suffix</dfn> as set in your config file.</p> |
||||
|
||||
<p>You are encouraged to use this function any time you need to generate a local URL so that your pages become more portable |
||||
in the event your URL changes.</p> |
||||
|
||||
<p>Segments can be optionally passed to the function as a string or an array. Here is a string example:</p> |
||||
|
||||
<code>echo site_url("news/local/123");</code> |
||||
|
||||
<p>The above example would return something like: http://example.com/index.php/news/local/123</p> |
||||
|
||||
<p>Here is an example of segments passed as an array:</p> |
||||
|
||||
<code> |
||||
$segments = array('news', 'local', '123');<br /> |
||||
<br /> |
||||
echo site_url($segments);</code> |
||||
|
||||
|
||||
<h2>base_url()</h2> |
||||
<p>Returns your site base URL, as specified in your config file. Example:</p> |
||||
<code>echo base_url();</code> |
||||
|
||||
<p>This function returns the same thing as site_url, without the <dfn>index_page</dfn> or <dfn>url_suffix</dfn> being appended.</p> |
||||
|
||||
<p>Also like site_url, you can supply segments as a string or an array. Here is a string example:</p> |
||||
|
||||
<code>echo base_url("blog/post/123");</code> |
||||
|
||||
<p>The above example would return something like: http://example.com/blog/post/123</p> |
||||
|
||||
<p>This is useful because unlike site_url(), you can supply a string to a file, such as an image or stylesheet. For example:</p> |
||||
|
||||
<code>echo base_url("images/icons/edit.png");</code> |
||||
|
||||
<p>This would give you something like: http://example.com/images/icons/edit.png</p> |
||||
|
||||
|
||||
<h2>current_url()</h2> |
||||
<p>Returns the full URL (including segments) of the page being currently viewed.</p> |
||||
|
||||
|
||||
<h2>uri_string()</h2> |
||||
<p>Returns the URI segments of any page that contains this function. For example, if your URL was this:</p> |
||||
<code>http://some-site.com/blog/comments/123</code> |
||||
|
||||
<p>The function would return:</p> |
||||
<code>/blog/comments/123</code> |
||||
|
||||
|
||||
<h2>index_page()</h2> |
||||
<p>Returns your site "index" page, as specified in your config file. Example:</p> |
||||
<code>echo index_page();</code> |
||||
|
||||
|
||||
|
||||
<h2>anchor()</h2> |
||||
|
||||
<p>Creates a standard HTML anchor link based on your local site URL:</p> |
||||
|
||||
<code><a href="http://example.com">Click Here</a></code> |
||||
|
||||
<p>The tag has three optional parameters:</p> |
||||
|
||||
<code>anchor(<var>uri segments</var>, <var>text</var>, <var>attributes</var>)</code> |
||||
|
||||
<p>The first parameter can contain any segments you wish appended to the URL. As with the <dfn>site_url()</dfn> function above, |
||||
segments can be a string or an array.</p> |
||||
|
||||
<p><strong>Note:</strong> If you are building links that are internal to your application do not include the base URL (http://...). This |
||||
will be added automatically from the information specified in your config file. Include only the URI segments you wish appended to the URL.</p> |
||||
|
||||
<p>The second segment is the text you would like the link to say. If you leave it blank, the URL will be used.</p> |
||||
|
||||
<p>The third parameter can contain a list of attributes you would like added to the link. The attributes can be a simple string or an associative array.</p> |
||||
|
||||
<p>Here are some examples:</p> |
||||
|
||||
<code>echo anchor('news/local/123', 'My News', 'title="News title"');</code> |
||||
|
||||
<p>Would produce: <a href="http://example.com/index.php/news/local/123" title="News title">My News</a></p> |
||||
|
||||
<code>echo anchor('news/local/123', 'My News', array('title' => 'The best news!'));</code> |
||||
|
||||
<p>Would produce: <a href="http://example.com/index.php/news/local/123" title="The best news!">My News</a></p> |
||||
|
||||
|
||||
<h2>anchor_popup()</h2> |
||||
|
||||
<p>Nearly identical to the <dfn>anchor()</dfn> function except that it opens the URL in a new window. |
||||
|
||||
You can specify JavaScript window attributes in the third parameter to control how the window is opened. If |
||||
the third parameter is not set it will simply open a new window with your own browser settings. Here is an example |
||||
with attributes:</p> |
||||
|
||||
<code> |
||||
|
||||
$atts = array(<br /> |
||||
'width' => '800',<br /> |
||||
'height' => '600',<br /> |
||||
'scrollbars' => 'yes',<br /> |
||||
'status' => 'yes',<br /> |
||||
'resizable' => 'yes',<br /> |
||||
'screenx' => '0',<br /> |
||||
'screeny' => '0'<br /> |
||||
);<br /> |
||||
<br /> |
||||
echo anchor_popup('news/local/123', 'Click Me!', $atts);</code> |
||||
|
||||
<p>Note: The above attributes are the function defaults so you only need to set the ones that are different from what you need. |
||||
If you want the function to use all of its defaults simply pass an empty array in the third parameter:</p> |
||||
|
||||
<code>echo anchor_popup('news/local/123', 'Click Me!', array());</code> |
||||
|
||||
|
||||
<h2>mailto()</h2> |
||||
|
||||
<p>Creates a standard HTML email link. Usage example:</p> |
||||
|
||||
<code>echo mailto('[email protected]', 'Click Here to Contact Me');</code> |
||||
|
||||
<p>As with the <dfn>anchor()</dfn> tab above, you can set attributes using the third parameter.</p> |
||||
|
||||
|
||||
<h2>safe_mailto()</h2> |
||||
|
||||
<p>Identical to the above function except it writes an obfuscated version of the mailto tag using ordinal numbers |
||||
written with JavaScript to help prevent the email address from being harvested by spam bots.</p> |
||||
|
||||
|
||||
<h2>auto_link()</h2> |
||||
|
||||
<p>Automatically turns URLs and email addresses contained in a string into links. Example:</p> |
||||
|
||||
<code>$string = auto_link($string);</code> |
||||
|
||||
<p>The second parameter determines whether URLs and emails are converted or just one or the other. Default behavior is both |
||||
if the parameter is not specified. Email links are encoded as safe_mailto() as shown above.</p> |
||||
|
||||
<p>Converts only URLs:</p> |
||||
<code>$string = auto_link($string, 'url');</code> |
||||
|
||||
<p>Converts only Email addresses:</p> |
||||
<code>$string = auto_link($string, 'email');</code> |
||||
|
||||
<p>The third parameter determines whether links are shown in a new window. The value can be TRUE or FALSE (boolean):</p> |
||||
<code>$string = auto_link($string, 'both', TRUE);</code> |
||||
|
||||
|
||||
<h2>url_title()</h2> |
||||
<p>Takes a string as input and creates a human-friendly URL string. This is useful if, for example, you have a blog |
||||
in which you'd like to use the title of your entries in the URL. Example:</p> |
||||
|
||||
<code>$title = "What's wrong with CSS?";<br /> |
||||
<br /> |
||||
$url_title = url_title($title);<br /> |
||||
<br /> |
||||
// Produces: Whats-wrong-with-CSS |
||||
</code> |
||||
|
||||
|
||||
<p>The second parameter determines the word delimiter. By default dashes are used.</p> |
||||
|
||||
<code>$title = "What's wrong with CSS?";<br /> |
||||
<br /> |
||||
$url_title = url_title($title, '_');<br /> |
||||
<br /> |
||||
// Produces: Whats_wrong_with_CSS |
||||
</code> |
||||
|
||||
<p>The third parameter determines whether or not lowercase characters are forced. By default they are not. Options are boolean <dfn>TRUE</dfn>/<dfn>FALSE</dfn>:</p> |
||||
|
||||
<code>$title = "What's wrong with CSS?";<br /> |
||||
<br /> |
||||
$url_title = url_title($title, '_', TRUE);<br /> |
||||
<br /> |
||||
// Produces: whats_wrong_with_css |
||||
</code> |
||||
|
||||
<h3>prep_url()</h3> |
||||
<p>This function will add <kbd>http://</kbd> in the event that a scheme is missing from a URL. Pass the URL string to the function like this:</p> |
||||
<code> |
||||
$url = "example.com";<br /><br /> |
||||
$url = prep_url($url);</code> |
||||
|
||||
|
||||
|
||||
|
||||
<h2>redirect()</h2> |
||||
|
||||
<p>Does a "header redirect" to the URI specified. If you specify the full site URL that link will be build, but for local links simply providing the URI segments |
||||
to the controller you want to direct to will create the link. The function will build the URL based on your config file values.</p> |
||||
|
||||
<p>The optional second parameter allows you to choose between the "location" |
||||
method (default) or the "refresh" method. Location is faster, but on Windows servers it can sometimes be a problem. The optional third parameter allows you to send a specific HTTP Response Code - this could be used for example to create 301 redirects for search engine purposes. The default Response Code is 302. The third parameter is <em>only</em> available with 'location' redirects, and not 'refresh'. Examples:</p> |
||||
|
||||
<code>if ($logged_in == FALSE)<br /> |
||||
{<br /> |
||||
redirect('/login/form/', 'refresh');<br /> |
||||
}<br /> |
||||
<br /> |
||||
// with 301 redirect<br /> |
||||
redirect('/article/13', 'location', 301);</code> |
||||
|
||||
<p class="important"><strong>Note:</strong> In order for this function to work it must be used before anything is outputted |
||||
to the browser since it utilizes server headers.<br /> |
||||
<strong>Note:</strong> For very fine grained control over headers, you should use the <a href="../libraries/output.html">Output Library</a>'s set_header() function.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="typography_helper.html">Typography Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="xml_helper.html">XML Helper</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,105 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>XML 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
XML 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>XML Helper</h1> |
||||
|
||||
<p>The XML Helper file contains functions that assist in working with XML data.</p> |
||||
|
||||
|
||||
<h2>Loading this Helper</h2> |
||||
|
||||
<p>This helper is loaded using the following code:</p> |
||||
<code>$this->load->helper('xml');</code> |
||||
|
||||
<p>The following functions are available:</p> |
||||
|
||||
<h2>xml_convert('<var>string</var>')</h2> |
||||
|
||||
<p>Takes a string as input and converts the following reserved XML characters to entities:</p> |
||||
|
||||
<p> |
||||
Ampersands: &<br /> |
||||
Less then and greater than characters: < ><br /> |
||||
Single and double quotes: ' "<br /> |
||||
Dashes: -</p> |
||||
|
||||
<p>This function ignores ampersands if they are part of existing character entities. Example:</p> |
||||
|
||||
<code>$string = xml_convert($string);</code> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="url_helper.html">URL Helper</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
|
Before Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 123 B |
|
Before Width: | Height: | Size: 5.5 KiB |
|
Before Width: | Height: | Size: 8.4 KiB |
|
Before Width: | Height: | Size: 92 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 66 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 370 B |
|
Before Width: | Height: | Size: 570 B |
|
Before Width: | Height: | Size: 445 B |
|
Before Width: | Height: | Size: 304 B |
|
Before Width: | Height: | Size: 1.9 KiB |
|
Before Width: | Height: | Size: 781 B |
|
Before Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 43 B |
@ -1,98 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Welcome to CodeIgniter : 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='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('null');</script></div></div> |
||||
<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> |
||||
<div id="masthead"> |
||||
<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> |
||||
<tr> |
||||
<td><h1>CodeIgniter User Guide Version 2.1.3</h1></td> |
||||
<td id="breadcrumb_right"><a href="toc.html">Table of Contents Page</a></td> |
||||
</tr> |
||||
</table> |
||||
</div> |
||||
<!-- END NAVIGATION --> |
||||
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" style="width:100%"> |
||||
<tr> |
||||
<td id="breadcrumb"> |
||||
<a href="http://codeigniter.com/">CodeIgniter Home</a> › CodeIgniter User Guide |
||||
</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> |
||||
|
||||
|
||||
|
||||
<br clear="all" /> |
||||
|
||||
<div class="center"><img src="images/ci_logo_flame.jpg" width="150" height="164" border="0" alt="CodeIgniter" /></div> |
||||
|
||||
|
||||
<!-- START CONTENT --> |
||||
<div id="content"> |
||||
|
||||
|
||||
|
||||
<h2>Welcome to CodeIgniter</h2> |
||||
|
||||
<p>CodeIgniter is an Application Development Framework - a toolkit - for people who build web sites using PHP. |
||||
Its goal is to enable you to develop projects much faster than you could if you were writing code |
||||
from scratch, by providing a rich set of libraries for commonly needed tasks, as well as a simple interface and |
||||
logical structure to access these libraries. CodeIgniter lets you creatively focus on your project by |
||||
minimizing the amount of code needed for a given task.</p> |
||||
|
||||
|
||||
<h2>Who is CodeIgniter For?</h2> |
||||
|
||||
<p>CodeIgniter is right for you if:</p> |
||||
|
||||
<ul> |
||||
<li>You want a framework with a small footprint.</li> |
||||
<li>You need exceptional performance.</li> |
||||
<li>You need broad compatibility with standard hosting accounts that run a variety of PHP versions and configurations.</li> |
||||
<li>You want a framework that requires nearly zero configuration.</li> |
||||
<li>You want a framework that does not require you to use the command line.</li> |
||||
<li>You want a framework that does not require you to adhere to restrictive coding rules.</li> |
||||
<li>You do not want to be forced to learn a templating language (although a template parser is optionally available if you desire one).</li> |
||||
<li>You eschew complexity, favoring simple solutions.</li> |
||||
<li>You need clear, thorough documentation.</li> |
||||
</ul> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p><a href="#top">Top of Page</a></p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
|
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,119 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Downloading CodeIgniter : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Downloading CodeIgniter |
||||
</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>Downloading CodeIgniter</h1> |
||||
|
||||
<ul> |
||||
<li><a href="http://codeigniter.com/downloads/">CodeIgniter V 2.1.3 (Current version)</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/reactor/CodeIgniter_2.1.2.zip">CodeIgniter V 2.1.2</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/reactor/CodeIgniter_2.1.1.zip">CodeIgniter V 2.1.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/reactor/CodeIgniter_2.1.0.zip">CodeIgniter V 2.1.0</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.3.zip">CodeIgniter V 2.0.3</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.2.zip">CodeIgniter V 2.0.2</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.1.zip">CodeIgniter V 2.0.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/reactor/CodeIgniter_2.0.0.zip">CodeIgniter V 2.0.0</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.7.3.zip">CodeIgniter V 1.7.3</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.7.2.zip">CodeIgniter V 1.7.2</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.7.1.zip">CodeIgniter V 1.7.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.7.0.zip">CodeIgniter V 1.7.0</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.6.3.zip">CodeIgniter V 1.6.3</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.6.2.zip">CodeIgniter V 1.6.2</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.6.1.zip">CodeIgniter V 1.6.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.6.0.zip">CodeIgniter V 1.6.0</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.5.4.zip">CodeIgniter V 1.5.4</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.5.3.zip">CodeIgniter V 1.5.3</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.5.2.zip">CodeIgniter V 1.5.2</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.5.1.zip">CodeIgniter V 1.5.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.4.1.zip">CodeIgniter V 1.4.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.3.3.zip">CodeIgniter V 1.3.3</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.3.2.zip">CodeIgniter V 1.3.2</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.3.1.zip">CodeIgniter V 1.3.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.3.zip">CodeIgniter V 1.3</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.2.zip">CodeIgniter V 1.2</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.1b.zip">CodeIgniter V 1.1</a></li> |
||||
<li><a href="http://codeigniter.com/download_files/CodeIgniter_1.0b.zip">CodeIgniter V 1.0</a></li> |
||||
</ul> |
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="git">Git Server</h1> |
||||
<p><a href="http://git-scm.com/about">Git</a> is a distributed version control system.</p> |
||||
|
||||
<p>Public Git access is available at <a href="https://github.com/EllisLab/CodeIgniter">GitHub</a>. |
||||
Please note that while every effort is made to keep this code base functional, we cannot guarantee the functionality of code taken |
||||
from the tip.</p> |
||||
|
||||
<p>Beginning with version 2.0.3, stable tags are also available via GitHub, simply select the version from the Tags dropdown.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="../general/credits.html">Credits</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="../installation/index.html">Installation Instructions</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com/">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,108 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Installation Instructions : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Installation Instructions |
||||
</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>Installation Instructions</h1> |
||||
|
||||
<p>CodeIgniter is installed in four steps:</p> |
||||
|
||||
<ol> |
||||
<li>Unzip the package.</li> |
||||
<li>Upload the CodeIgniter folders and files to your server. Normally the index.php file will be at your root.</li> |
||||
<li>Open the <dfn>application/config/config.php</dfn> file with a text editor and set your base URL. If you intend to use encryption or sessions, set your encryption key.</li> |
||||
<li>If you intend to use a database, open the <dfn>application/config/database.php</dfn> file with a text editor and set your database settings.</li> |
||||
</ol> |
||||
|
||||
<p>If you wish to increase security by hiding the location of your CodeIgniter files you can rename the <dfn>system</dfn> and <dfn>application</dfn> folders |
||||
to something more private. If you do rename them, you must open your main <kbd>index.php</kbd> file and set the <samp>$system_folder</samp> and <samp>$application_folder</samp> |
||||
variables at the top of the file with the new name you've chosen.</p> |
||||
|
||||
<p>For the best security, both the <dfn>system</dfn> and any <dfn>application</dfn> folders should be placed above web root so that they are not directly accessible via a browser. By default, .htaccess files are included in each folder to help prevent direct access, but it is best to remove them from public access entirely in case the web server configuration changes or doesn't abide by the .htaccess.</p> |
||||
|
||||
<p>After moving them, open your main <kdb>index.php</kbd> file and set the <samp>$system_folder</samp> and <samp>$application_folder</samp> variables, preferably with a full path, e.g. '<dfn>/www/MyUser/system</dfn>'.</p> |
||||
|
||||
<p> |
||||
One additional measure to take in production environments is to disable |
||||
PHP error reporting and any other development-only functionality. In CodeIgniter, |
||||
this can be done by setting the <kbd>ENVIRONMENT</kbd> constant, which is |
||||
more fully described on the <a href="../general/security.html">security page</a>. |
||||
</p> |
||||
|
||||
<p>That's it!</p> |
||||
|
||||
<p>If you're new to CodeIgniter, please read the <a href="../overview/getting_started.html">Getting Started</a> section of the User Guide to begin learning how |
||||
to build dynamic PHP applications. Enjoy!</p> |
||||
|
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="../general/credits.html">Credits</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="upgrading.html">Upgrading from a Previous Version</a> |
||||
</p> |
||||
|
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,90 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Troubleshooting : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Trouble Shooting |
||||
</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>Troubleshooting</h1> |
||||
|
||||
<p>If you find that no matter what you put in your URL only your default page is loading, it might be that your server |
||||
does not support the PATH_INFO variable needed to serve search-engine friendly URLs. |
||||
|
||||
As a first step, open your <dfn>application/config/config.php</dfn> file and look for the <kbd>URI Protocol</kbd> |
||||
information. It will recommend that you try a couple alternate settings. If it still doesn't work after you've tried this you'll need |
||||
to force CodeIgniter to add a question mark to your URLs. To do this open your <kbd>application/config/config.php</kbd> file and change this:</p> |
||||
|
||||
<code>$config['index_page'] = "index.php";</code> |
||||
|
||||
<p>To this:</p> |
||||
|
||||
<code>$config['index_page'] = "index.php?";</code> |
||||
|
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="upgrading.html">Upgrading from a Previous Version</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="../overview/at_a_glance.html">CodeIgniter at a Glance</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,92 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from Beta 1.1 to Final 1.2 |
||||
</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>Upgrading From Beta 1.0 to Final 1.2</h1> |
||||
|
||||
<p>To upgrade to Version 1.2 please replace the following directories with the new versions:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<ul> |
||||
<li>drivers</li> |
||||
<li>helpers</li> |
||||
<li>init</li> |
||||
<li>language</li> |
||||
<li>libraries</li> |
||||
<li>plugins</li> |
||||
<li>scaffolding</li> |
||||
</ul> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,203 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.2 to 1.3 |
||||
</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>Upgrading from 1.2 to 1.3</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.2. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file |
||||
with a static one.</p> |
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace the following directories in your "system" folder with the new versions:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<ul> |
||||
<li>application/<strong>models</strong>/ (new for 1.3)</li> |
||||
<li>codeigniter (new for 1.3)</li> |
||||
<li>drivers</li> |
||||
<li>helpers</li> |
||||
<li>init</li> |
||||
<li>language</li> |
||||
<li>libraries</li> |
||||
<li>plugins</li> |
||||
<li>scaffolding</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Step 2: Update your error files</h2> |
||||
|
||||
<p>Version 1.3 contains two new error templates located in <dfn>application/errors</dfn>, and for naming consistency the other error templates have |
||||
been renamed.</p> |
||||
|
||||
<p>If you <strong>have not</strong> customized any of the error templates simply |
||||
replace this folder:</p> |
||||
|
||||
<ul> |
||||
<li>application/errors/</li> |
||||
</ul> |
||||
|
||||
<p>If you <strong>have</strong> customized your error templates, rename them as follows:</p> |
||||
|
||||
|
||||
<ul> |
||||
<li>404.php = error_404.php</li> |
||||
<li>error.php = error_general.php</li> |
||||
<li>error_db.php (new)</li> |
||||
<li>error_php.php (new)</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Step 3: Update your index.php file</h2> |
||||
|
||||
<p>Please open your main <dfn>index.php</dfn> file (located at your root). At the very bottom of the file, change this:</p> |
||||
|
||||
<code>require_once BASEPATH.'libraries/Front_controller'.EXT;</code> |
||||
|
||||
<p>To this:</p> |
||||
|
||||
<code>require_once BASEPATH.'codeigniter/CodeIgniter'.EXT;</code> |
||||
|
||||
|
||||
<h2>Step 4: Update your config.php file</h2> |
||||
|
||||
<p>Open your <dfn>application/config/config.php</dfn> file and add these new items:</p> |
||||
|
||||
<pre> |
||||
/* |
||||
|------------------------------------------------ |
||||
| URL suffix |
||||
|------------------------------------------------ |
||||
| |
||||
| This option allows you to add a suffix to all URLs. |
||||
| For example, if a URL is this: |
||||
| |
||||
| example.com/index.php/products/view/shoes |
||||
| |
||||
| You can optionally add a suffix, like ".html", |
||||
| making the page appear to be of a certain type: |
||||
| |
||||
| example.com/index.php/products/view/shoes.html |
||||
| |
||||
*/ |
||||
$config['url_suffix'] = ""; |
||||
|
||||
|
||||
/* |
||||
|------------------------------------------------ |
||||
| Enable Query Strings |
||||
|------------------------------------------------ |
||||
| |
||||
| By default CodeIgniter uses search-engine and |
||||
| human-friendly segment based URLs: |
||||
| |
||||
| example.com/who/what/where/ |
||||
| |
||||
| You can optionally enable standard query string |
||||
| based URLs: |
||||
| |
||||
| example.com?who=me&what=something&where=here |
||||
| |
||||
| Options are: TRUE or FALSE (boolean) |
||||
| |
||||
| The two other items let you set the query string "words" |
||||
| that will invoke your controllers and functions: |
||||
| example.com/index.php?c=controller&m=function |
||||
| |
||||
*/ |
||||
$config['enable_query_strings'] = FALSE; |
||||
$config['controller_trigger'] = 'c'; |
||||
$config['function_trigger'] = 'm'; |
||||
</pre> |
||||
|
||||
|
||||
<h2>Step 5: Update your database.php file</h2> |
||||
|
||||
<p>Open your <dfn>application/config/database.php</dfn> file and add these new items:</p> |
||||
|
||||
<pre> |
||||
$db['default']['dbprefix'] = ""; |
||||
$db['default']['active_r'] = TRUE; |
||||
</pre> |
||||
|
||||
|
||||
<h2>Step 6: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,102 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.3 to 1.3.1 |
||||
</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>Upgrading from 1.3 to 1.3.1</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.3. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace the following directories in your "system" folder with the new versions:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<ul> |
||||
<li>drivers</li> |
||||
<li>init/init_unit_test.php (new for 1.3.1)</li> |
||||
<li>language/</li> |
||||
<li>libraries</li> |
||||
<li>scaffolding</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Step 2: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,100 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.3.1 to 1.3.2 |
||||
</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>Upgrading from 1.3.1 to 1.3.2</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.3.1. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace the following directories in your "system" folder with the new versions:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<ul> |
||||
<li>drivers</li> |
||||
<li>init</li> |
||||
<li>libraries</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Step 2: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,112 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.3.2 to 1.3.3 |
||||
</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>Upgrading from 1.3.2 to 1.3.3</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.3.2. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace the following directories in your "system" folder with the new versions:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<ul> |
||||
<li>codeigniter</li> |
||||
<li>drivers</li> |
||||
<li>helpers</li> |
||||
<li>init</li> |
||||
<li>libraries</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Step 2: Update your Models</h2> |
||||
|
||||
<p>If you are <strong>NOT</strong> using CodeIgniter's <a href="../general/models.html">Models</a> feature disregard this step.</p> |
||||
|
||||
<p>As of version 1.3.3, CodeIgniter does <strong>not</strong> connect automatically to your database when a model is loaded. This |
||||
allows you greater flexibility in determining which databases you would like used with your models. If your application is not connecting |
||||
to your database prior to a model being loaded you will have to update your code. There are several options for connecting, |
||||
<a href="../general/models.html">as described here</a>.</p> |
||||
|
||||
|
||||
<h2>Step 3: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,145 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.3.3 to 1.4.0 |
||||
</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>Upgrading from 1.3.3 to 1.4.0</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.3.3. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace the following directories in your "system" folder with the new versions:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<ul> |
||||
<li>application/config/<strong>hooks.php</strong></li> |
||||
<li>application/config/<strong>mimes.php</strong></li> |
||||
<li>codeigniter</li> |
||||
<li>drivers</li> |
||||
<li>helpers</li> |
||||
<li>init</li> |
||||
<li>language</li> |
||||
<li>libraries</li> |
||||
<li>scaffolding</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Step 2: Update your config.php file</h2> |
||||
|
||||
<p>Open your <dfn>application/config/config.php</dfn> file and add these new items:</p> |
||||
|
||||
<pre> |
||||
|
||||
/* |
||||
|-------------------------------------------------------------------------- |
||||
| Enable/Disable System Hooks |
||||
|-------------------------------------------------------------------------- |
||||
| |
||||
| If you would like to use the "hooks" feature you must enable it by |
||||
| setting this variable to TRUE (boolean). See the user guide for details. |
||||
| |
||||
*/ |
||||
$config['enable_hooks'] = FALSE; |
||||
|
||||
|
||||
/* |
||||
|-------------------------------------------------------------------------- |
||||
| Allowed URL Characters |
||||
|-------------------------------------------------------------------------- |
||||
| |
||||
| This lets you specify which characters are permitted within your URLs. |
||||
| When someone tries to submit a URL with disallowed characters they will |
||||
| get a warning message. |
||||
| |
||||
| As a security measure you are STRONGLY encouraged to restrict URLs to |
||||
| as few characters as possible. By default only these are allowed: a-z 0-9~%.:_- |
||||
| |
||||
| Leave blank to allow all characters -- but only if you are insane. |
||||
| |
||||
| DO NOT CHANGE THIS UNLESS YOU FULLY UNDERSTAND THE REPERCUSSIONS!! |
||||
| |
||||
*/ |
||||
$config['permitted_uri_chars'] = 'a-z 0-9~%.:_-'; |
||||
</pre> |
||||
|
||||
|
||||
<h2>Step 3: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,148 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.4.0 to 1.4.1 </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>Upgrading from 1.4.0 to 1.4.1</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.4.0. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace the following directories in your "system" folder with the new versions:</p> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<ul> |
||||
<li>codeigniter</li> |
||||
<li>drivers</li> |
||||
<li>helpers</li> |
||||
<li>libraries</li> |
||||
</ul> |
||||
|
||||
|
||||
<h2>Step 2: Update your config.php file</h2> |
||||
|
||||
<p>Open your <dfn>application/config/config.php</dfn> file and add this new item:</p> |
||||
|
||||
<pre> |
||||
|
||||
/* |
||||
|-------------------------------------------------------------------------- |
||||
| Output Compression |
||||
|-------------------------------------------------------------------------- |
||||
| |
||||
| Enables Gzip output compression for faster page loads. When enabled, |
||||
| the output class will test whether your server supports Gzip. |
||||
| Even if it does, however, not all browsers support compression |
||||
| so enable only if you are reasonably sure your visitors can handle it. |
||||
| |
||||
| VERY IMPORTANT: If you are getting a blank page when compression is enabled it |
||||
| means you are prematurely outputting something to your browser. It could |
||||
| even be a line of whitespace at the end of one of your scripts. For |
||||
| compression to work, nothing can be sent before the output buffer is called |
||||
| by the output class. Do not "echo" any values with compression enabled. |
||||
| |
||||
*/ |
||||
$config['compress_output'] = FALSE; |
||||
|
||||
</pre> |
||||
|
||||
|
||||
|
||||
<h2>Step 3: Rename an Autoload Item</h2> |
||||
|
||||
<p>Open the following file: <dfn>application/config/autoload.php</dfn></p> |
||||
|
||||
<p>Find this array item:</p> |
||||
|
||||
<code>$autoload['core'] = array();</code> |
||||
|
||||
<p>And rename it to this:</p> |
||||
|
||||
<code>$autoload['libraries'] = array();</code> |
||||
|
||||
<p>This change was made to improve clarity since some users were not sure that their own libraries could be auto-loaded.</p> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2>Step 4: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,178 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.4.1 to 1.5.0 |
||||
</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>Upgrading from 1.4.1 to 1.5.0</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.4.1. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace these files and directories in your "system" folder with the new versions:</p> |
||||
|
||||
<ul> |
||||
|
||||
<li><dfn>application/config/user_agents.php</dfn> (new file for 1.5)</li> |
||||
<li><dfn>application/config/smileys.php</dfn> (new file for 1.5)</li> |
||||
<li><dfn>codeigniter/</dfn></li> |
||||
<li><dfn>database/</dfn> (new folder for 1.5. Replaces the "drivers" folder)</li> |
||||
<li><dfn>helpers/</dfn></li> |
||||
<li><dfn>language/</dfn></li> |
||||
<li><dfn>libraries/</dfn></li> |
||||
<li><dfn>scaffolding/</dfn></li> |
||||
</ul> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
|
||||
<h2>Step 2: Update your database.php file</h2> |
||||
|
||||
<p>Open your <dfn>application/config/database.php</dfn> file and add these new items:</p> |
||||
|
||||
<pre> |
||||
$db['default']['cache_on'] = FALSE; |
||||
$db['default']['cachedir'] = ''; |
||||
</pre> |
||||
|
||||
|
||||
|
||||
<h2>Step 3: Update your config.php file</h2> |
||||
|
||||
<p>Open your <dfn>application/config/config.php</dfn> file and <kbd>ADD</kbd> these new items:</p> |
||||
|
||||
<pre> |
||||
/* |
||||
|-------------------------------------------------------------------------- |
||||
| Class Extension Prefix |
||||
|-------------------------------------------------------------------------- |
||||
| |
||||
| This item allows you to set the filename/classname prefix when extending |
||||
| native libraries. For more information please see the user guide: |
||||
| |
||||
| http://codeigniter.com/user_guide/general/core_classes.html |
||||
| http://codeigniter.com/user_guide/general/creating_libraries.html |
||||
| |
||||
*/ |
||||
$config['subclass_prefix'] = 'MY_'; |
||||
|
||||
/* |
||||
|-------------------------------------------------------------------------- |
||||
| Rewrite PHP Short Tags |
||||
|-------------------------------------------------------------------------- |
||||
| |
||||
| If your PHP installation does not have short tag support enabled CI |
||||
| can rewrite the tags on-the-fly, enabling you to utilize that syntax |
||||
| in your view files. Options are TRUE or FALSE (boolean) |
||||
| |
||||
*/ |
||||
$config['rewrite_short_tags'] = FALSE; |
||||
</pre> |
||||
|
||||
<p>In that same file <kbd>REMOVE</kbd> this item:</p> |
||||
|
||||
|
||||
<pre> |
||||
/* |
||||
|-------------------------------------------------------------------------- |
||||
| Enable/Disable Error Logging |
||||
|-------------------------------------------------------------------------- |
||||
| |
||||
| If you would like errors or debug messages logged set this variable to |
||||
| TRUE (boolean). Note: You must set the file permissions on the "logs" folder |
||||
| such that it is writable. |
||||
| |
||||
*/ |
||||
$config['log_errors'] = FALSE; |
||||
</pre> |
||||
|
||||
<p>Error logging is now disabled simply by setting the threshold to zero.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 4: Update your main index.php file</h2> |
||||
|
||||
<p>If you are running a stock <dfn>index.php</dfn> file simply replace your version with the new one.</p> |
||||
|
||||
<p>If your <dfn>index.php</dfn> file has internal modifications, please add your modifications to the new file and use it.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 5: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,111 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.5.0 to 1.5.2 |
||||
</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>Upgrading from 1.5.0 to 1.5.2</h1> |
||||
|
||||
<p class="important"><strong>Note:</strong> The instructions on this page assume you are running version 1.5.0 or 1.5.1. If you |
||||
have not upgraded to that version please do so first.</p> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace these files and directories in your "system" folder with the new versions:</p> |
||||
|
||||
<ul> |
||||
|
||||
<li><dfn>system/helpers/download_helper.php</dfn></li> |
||||
<li><dfn>system/helpers/form_helper.php</dfn></li> |
||||
<li><dfn>system/libraries/Table.php</dfn></li> |
||||
<li><dfn>system/libraries/User_agent.php</dfn></li> |
||||
<li><dfn>system/libraries/Exceptions.php</dfn></li> |
||||
<li><dfn>system/libraries/Input.php</dfn></li> |
||||
<li><dfn>system/libraries/Router.php</dfn></li> |
||||
<li><dfn>system/libraries/Loader.php</dfn></li> |
||||
<li><dfn>system/libraries/Image_lib.php</dfn></li> |
||||
<li><dfn>system/language/english/unit_test_lang.php</dfn></li> |
||||
<li><dfn>system/database/DB_active_rec.php</dfn></li> |
||||
<li><dfn> system/database/drivers/mysqli/mysqli_driver.php</dfn></li> |
||||
<li><dfn>codeigniter/</dfn></li> |
||||
</ul> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
|
||||
<h2>Step 2: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,100 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › Upgrading from 1.5.2 to 1.5.3 |
||||
</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>Upgrading from 1.5.2 to 1.5.3</h1> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace these files and directories in your "system" folder with the new versions:</p> |
||||
|
||||
<ul> |
||||
|
||||
<li><dfn>system/database/drivers</dfn></li> |
||||
<li><dfn>system/helpers</dfn></li> |
||||
<li><dfn>system/libraries/Input.php</dfn></li> |
||||
<li><dfn>system/libraries/Loader.php</dfn></li> |
||||
<li><dfn>system/libraries/Profiler.php</dfn></li> |
||||
<li><dfn>system/libraries/Table.php</dfn></li> |
||||
</ul> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
|
||||
<h2>Step 2: Update your user guide</h2> |
||||
|
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
@ -1,116 +0,0 @@
|
||||
<!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> |
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
||||
<title>Upgrading from 1.5.3 to 1.5.4 : 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='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_darker.jpg" width="154" height="43" 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 2.1.3</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> › |
||||
Upgrading from 1.5.3 to 1.5.4 |
||||
</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>Upgrading from 1.5.3 to 1.5.4</h1> |
||||
|
||||
<p>Before performing an update you should take your site offline by replacing the index.php file with a static one.</p> |
||||
|
||||
|
||||
|
||||
<h2>Step 1: Update your CodeIgniter files</h2> |
||||
|
||||
<p>Replace these files and directories in your "system" folder with the new versions:</p> |
||||
|
||||
<ul> |
||||
|
||||
<li><dfn>application/config/mimes.php</dfn></li> |
||||
<li><dfn>system/codeigniter</dfn></li> |
||||
<li><dfn>system/database</dfn></li> |
||||
<li><dfn>system/helpers</dfn></li> |
||||
<li><dfn>system/libraries</dfn></li> |
||||
<li><dfn>system/plugins</dfn></li> |
||||
</ul> |
||||
|
||||
<p class="important"><strong>Note:</strong> If you have any custom developed files in these folders please make copies of them first.</p> |
||||
|
||||
<h2>Step 2: Add charset to your config.php </h2> |
||||
<p>Add the following to application/config/config.php</p> |
||||
<code>/*<br /> |
||||
|--------------------------------------------------------------------------<br /> |
||||
| Default Character Set<br /> |
||||
|--------------------------------------------------------------------------<br /> |
||||
|<br /> |
||||
| This determines which character set is used by default in various methods<br /> |
||||
| that require a character set to be provided.<br /> |
||||
|<br /> |
||||
*/<br /> |
||||
$config['charset'] = "UTF-8";</code> |
||||
|
||||
<h2>Step 3: Autoloading language files </h2> |
||||
<p>If you want to autoload any language files, add this line to application/config/autoload.php</p> |
||||
<code>$autoload['language'] = array();</code> |
||||
|
||||
<h2>Step 4: Update your user guide</h2> |
||||
<p>Please also replace your local copy of the user guide with the new version.</p> |
||||
|
||||
</div> |
||||
<!-- END CONTENT --> |
||||
|
||||
|
||||
<div id="footer"> |
||||
<p> |
||||
Previous Topic: <a href="index.html">Installation Instructions</a> |
||||
· |
||||
<a href="#top">Top of Page</a> · |
||||
<a href="../index.html">User Guide Home</a> · |
||||
Next Topic: <a href="troubleshooting.html">Troubleshooting</a> |
||||
</p> |
||||
<p><a href="http://codeigniter.com">CodeIgniter</a> · Copyright © 2006 - 2012 · <a href="http://ellislab.com/">EllisLab, Inc.</a></p> |
||||
</div> |
||||
|
||||
</body> |
||||
</html> |
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue