diff options
| author | Derek Allard <derek.allard@ellislab.com> | 2008-08-21 14:46:58 +0200 |
|---|---|---|
| committer | Derek Allard <derek.allard@ellislab.com> | 2008-08-21 14:46:58 +0200 |
| commit | 928c55cbc5f3f162c10077f46d75d0bc0b1cbe53 (patch) | |
| tree | 22b9ca71872be54736e400de93cb7223cbe5ca1d /user_guide | |
| parent | 993925b47a0bfb08e79961c47bcc3d247a03a5dd (diff) | |
further whitespace fixes
Diffstat (limited to 'user_guide')
| -rw-r--r-- | user_guide/database/active_record.html | 74 | ||||
| -rw-r--r-- | user_guide/database/forge.html | 62 | ||||
| -rw-r--r-- | user_guide/database/index.html | 2 | ||||
| -rw-r--r-- | user_guide/general/helpers.html | 2 | ||||
| -rw-r--r-- | user_guide/general/views.html | 2 | ||||
| -rw-r--r-- | user_guide/helpers/form_helper.html | 12 | ||||
| -rw-r--r-- | user_guide/helpers/html_helper.html | 56 | ||||
| -rw-r--r-- | user_guide/helpers/string_helper.html | 4 | ||||
| -rw-r--r-- | user_guide/installation/upgrade_154.html | 18 | ||||
| -rw-r--r-- | user_guide/installation/upgrade_160.html | 20 | ||||
| -rw-r--r-- | user_guide/libraries/sessions.html | 155 | ||||
| -rw-r--r-- | user_guide/libraries/validation.html | 49 |
12 files changed, 202 insertions, 254 deletions
diff --git a/user_guide/database/active_record.html b/user_guide/database/active_record.html index afdc9b5ef..f3bde15e4 100644 --- a/user_guide/database/active_record.html +++ b/user_guide/database/active_record.html @@ -129,8 +129,8 @@ $query = $this->db->get('mytable');<br /> <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 />
+<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>
@@ -280,30 +280,30 @@ $this->db->or_where('id >', $id); <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>
+ $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>
-
+ $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>
+ $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>
+ $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>
@@ -327,7 +327,7 @@ $this->db->or_where('id >', $id); <code>$this->db->like('title', 'match', 'before');
<br />
// Produces: WHERE title LIKE '%match' <br />
- <br />
+ <br />
$this->db->like('title', 'match', 'after'); <br />
// Produces: WHERE title LIKE 'match%' <br />
<br />
@@ -341,7 +341,7 @@ $this->db->or_where('id >', $id); $this->db->like($array);
<br /><br />// WHERE title LIKE '%match%' AND page1 LIKE '%match%' AND page2 LIKE '%match%'</code></li>
- </ol>
+ </ol>
<h2>$this->db->or_like();</h2>
@@ -387,9 +387,9 @@ $this->db->or_not_like('body', 'match'); <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>
+ $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 syntaxe, 1 argument or 2:</p>
@@ -435,10 +435,10 @@ The second parameter lets you set the direction of the result. Options are <kbd <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>
+ $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 deprecated.</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>
@@ -543,12 +543,12 @@ $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>
+ $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 />
@@ -657,19 +657,19 @@ $this->db->delete('mytable', array('id' => $id)); 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>
+ $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 then 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 />
+<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>
diff --git a/user_guide/database/forge.html b/user_guide/database/forge.html index 12ac62f57..bc67436bb 100644 --- a/user_guide/database/forge.html +++ b/user_guide/database/forge.html @@ -116,27 +116,27 @@ already be running, since the forge class relies on it.</p> <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 />
+ '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>
+ <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 />
+ '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 />
@@ -161,22 +161,22 @@ already be running, since the forge class relies on it.</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>
+ // 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 />
+ // 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>
+ $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 />
@@ -196,7 +196,7 @@ already be running, since the forge class relies on it.</p> <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 />
+ 'preferences' => array('type' => 'TEXT')<br />
);<br />
$this->dbforge->add_column('table_name', $fields);<br />
<br />
@@ -213,8 +213,8 @@ $this->dbforge->add_column('table_name', $fields);<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>
+ <br />
+ // gives ALTER TABLE table_name CHANGE old_name new_name TEXT </code></p>
<p> </p>
</div>
<!-- END CONTENT -->
diff --git a/user_guide/database/index.html b/user_guide/database/index.html index a6854b5bb..5dcea988a 100644 --- a/user_guide/database/index.html +++ b/user_guide/database/index.html @@ -76,7 +76,7 @@ structures and Active Record patterns. The database functions offer clear, simpl <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>
+ <li><a href="utilities.html">Database Utilities Class</a></li>
</ul>
diff --git a/user_guide/general/helpers.html b/user_guide/general/helpers.html index 3c9f11950..ea794f08a 100644 --- a/user_guide/general/helpers.html +++ b/user_guide/general/helpers.html @@ -69,7 +69,7 @@ Each helper function performs one specific task, with no dependence on other fun <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>system/application/helpers </dfn>directory. CodeIgniter will look first in your <dfn>system/application/helpers</dfn>
+<p>Helpers are typically stored in your <dfn>system/helpers</dfn>, or <dfn>system/application/helpers </dfn>directory. CodeIgniter will look first in your <dfn>system/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>
diff --git a/user_guide/general/views.html b/user_guide/general/views.html index a161fa01c..bc0861509 100644 --- a/user_guide/general/views.html +++ b/user_guide/general/views.html @@ -129,7 +129,7 @@ class Page extends Controller {<br /><br /> }<br />
<br />
}<br />
- ?></code></p>
+ ?></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
diff --git a/user_guide/helpers/form_helper.html b/user_guide/helpers/form_helper.html index 83b97ab15..839f7251c 100644 --- a/user_guide/helpers/form_helper.html +++ b/user_guide/helpers/form_helper.html @@ -258,7 +258,7 @@ echo form_fieldset_close(); </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 form_fieldset('Address Information', $attributes);<br />
echo "<p>fieldset content here</p>\n";<br />
echo form_fieldset_close(); <br />
<br />
@@ -269,7 +269,7 @@ echo form_fieldset_close(); <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>
+ which will be added below the tag. For example:</p>
<code>$string = "</div></div>";<br />
<br />
echo fieldset_close($string);<br />
@@ -321,7 +321,7 @@ fourth parameter:</p> <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>
+ 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 />
@@ -329,13 +329,13 @@ fourth parameter:</p> // 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>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 />
+ 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>
diff --git a/user_guide/helpers/html_helper.html b/user_guide/helpers/html_helper.html index fcbcccdf0..62898403d 100644 --- a/user_guide/helpers/html_helper.html +++ b/user_guide/helpers/html_helper.html @@ -80,7 +80,7 @@ second the size of the heading. Example:</p> <p>The above would produce: <h3>Welcome!</h3></p>
<h2>img()</h2>
<p>Lets you create HTML <img /> tags. The first parameter contains the image source. There is data, the
- second the size of the heading. Example:</p>
+ second the size of the heading. 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>
@@ -88,17 +88,17 @@ second the size of the heading. Example:</p> // gives <img src="http://site.com/index.php/images/picture.jpg" /></code></p>
<p>Additionally, an associative array can be passed to the img() function for complete control over all attributes and values.</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>
+ '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>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 />
@@ -106,24 +106,24 @@ echo link_tag('css/mystyles.css');<br /> <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('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>
+ 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('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>
-
+ $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>nbs()</h2>
<p>Generates non-breaking spaces (&nbsp;) based on the number you submit. Example:</p>
<code>echo nbs(3);</code>
diff --git a/user_guide/helpers/string_helper.html b/user_guide/helpers/string_helper.html index 025a4329a..24a0a661e 100644 --- a/user_guide/helpers/string_helper.html +++ b/user_guide/helpers/string_helper.html @@ -122,8 +122,8 @@ echo repeater($string, 30);</code> 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 />
+ <br />
+ <code>$string = "/this/that/theother/";<br />
echo trim_slashes($string); // results in this/that/theother</code></p>
diff --git a/user_guide/installation/upgrade_154.html b/user_guide/installation/upgrade_154.html index 90bc7d3cc..01389f338 100644 --- a/user_guide/installation/upgrade_154.html +++ b/user_guide/installation/upgrade_154.html @@ -80,15 +80,15 @@ Upgrading from 1.5.3 to 1.5.4 <h2>Step 2: Add charset to your config.php </h2>
<p>Add the following to system/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>
+ |--------------------------------------------------------------------------<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 system/application/config/autoload.php</p>
diff --git a/user_guide/installation/upgrade_160.html b/user_guide/installation/upgrade_160.html index f4e703eed..b80a68816 100644 --- a/user_guide/installation/upgrade_160.html +++ b/user_guide/installation/upgrade_160.html @@ -83,16 +83,16 @@ Upgrading from 1.5.4 to 1.6.0 <h2>Step 3: Add $autoload['model']</h2>
<p>Add the following to system/application/autoload.php</p>
<p><code> /*<br />
- | -------------------------------------------------------------------<br />
- | Auto-load Model files<br />
- | -------------------------------------------------------------------<br />
- | Prototype:<br />
- |<br />
- | $autoload['model'] = array('my_model');<br />
- |<br />
- */<br />
- <br />
- $autoload['model'] = array();</code></p>
+ | -------------------------------------------------------------------<br />
+ | Auto-load Model files<br />
+ | -------------------------------------------------------------------<br />
+ | Prototype:<br />
+ |<br />
+ | $autoload['model'] = array('my_model');<br />
+ |<br />
+ */<br />
+ <br />
+ $autoload['model'] = array();</code></p>
<h2>Step 4: Add to your database.php </h2>
<p>Make the following changes to your system/application/config/database.php file:</p>
<p>Add the following variable above the database configuration options, with <dfn>$active_group</dfn></p>
diff --git a/user_guide/libraries/sessions.html b/user_guide/libraries/sessions.html index c8e64f824..7158ca764 100644 --- a/user_guide/libraries/sessions.html +++ b/user_guide/libraries/sessions.html @@ -60,35 +60,35 @@ Session Class <p>The Session class permits you maintain a user's "state" and track their activity while they browse your site.
The Session class stores session information for each user as serialized (and optionally encrypted) data in a cookie.
-It can additionally store the session data in a database table for added security, as this permits the session ID in the
+It can also store the session data in a database table for added security, as this permits the session ID in the
user's cookie to be matched against the stored session ID. By default only the cookie is saved. If you choose to
-use the database option you'll need to create the session table as indicated below.
+use the database option you'll need to create the session table as indicated below.
</p>
<p class="important"><strong>Note:</strong> The Session class does <strong>not</strong> utilize native PHP sessions. It
-generates its own session data so you are not dependent on how a particular hosting environment is set up.</p>
+generates its own session data, offering more flexibility for developers.</p>
<h2>Initializing a Session</h2>
-<p>The Session routines must happen with each page load (and before anything is outputted to the browser), so the session class must either be
+<p>Sessions will typically run globally with each page load, so the session class must either be
<a href="../general/libraries.html">initialized</a> in your
<a href="../general/controllers.html">controller</a> constructors, or it can be
<a href="../general/autoloader.html">auto-loaded</a> by the system.
-Once initialized, the Session class will run unattended in the background, reading, writing, and updating the session as needed.</p>
+For the most part the session class will run unattended in the background, so simply initializing the class
+will cause it to read, create, and update sessions.</p>
<p>To initialize the Session class manually in your controller constructor, use the <dfn>$this->load->library</dfn> function:</p>
<code>$this->load->library('session');</code>
-
-<p>You can access the Session library object using: <dfn>$this->session</dfn></p>
+<p>Once loaded, the Sessions library object will be available using: <dfn>$this->session</dfn></p>
<h2>How do Sessions work?</h2>
-<p>When a page is loaded, the Session class will check to see if valid session data exists in the user's session cookie.
+<p>When a page is loaded, the session class will check to see if valid session data exists in the user's session cookie.
If sessions data does <strong>not</strong> exist (or if it has expired) a new session will be created and saved in the cookie.
-If a session <strong>does</strong> exist, its information and cookie will be updated automatically. With each update, the session_id will be regenerated for security.</p>
+If a session does exist, its information will be updated and the cookie will be updated. With each update, the session_id will be regenerated.</p>
<p>It's important for you to understand that once initialized, the Session class runs automatically. There is nothing
you need to do to cause the above behavior to happen. You can, as you'll see below, work with session data or
@@ -141,7 +141,7 @@ will do this:</p> <h2>Adding Custom Session Data</h2>
-<p>A useful aspect of the session array is that you can add your own data to it and it will be stored in the session array.
+<p>A useful aspect of the session array is that you can add your own data to it and it will be stored in the user's cookie.
Why would you want to do this? Here's one example:</p>
<p>Let's say a particular user logs into your site. Once authenticated,
@@ -156,20 +156,16 @@ having to run a database query when you need it.</p> <p><code>$newdata = array(<br />
- 'username' => 'johndoe',<br />
- 'email' => 'johndoe@some-site.com',<br />
- 'logged_in' => TRUE<br />
- );<br />
- <br />
- $this->session->set_userdata(<samp>$newdata</samp>);</code></p>
-
+ 'username' => 'johndoe',<br />
+ 'email' => 'johndoe@some-site.com',<br />
+ 'logged_in' => TRUE<br />
+ );<br />
+ <br />
+ $this->session->set_userdata(<samp>$newdata</samp>);</code></p>
<p>If you want to add userdata one value at a time, set_userdata() also supports this syntax. </p>
<p><code>$this->session->set_userdata('some_name', 'some_value');</code></p>
-
-
-<p class="important"><strong>Note:</strong> By default, the session class stores your custom data in the session cookie. Cookies, however, can only hold
-4KB of data, so it is easily possible to exceed the capacity, particularly if you use encryption, since it produces a longer data string than the original.
-If you need to store a larger amount of data it is recommended that you store your session data in a database table. You'll find instructions for this below.</p>
+<p class="important"><strong>Note:</strong> Cookies can only hold 4KB of data, so be careful not to exceed the capacity. The
+encryption process in particular produces a longer data string than the original so keep careful track of how much data you are storing.</p>
<h2>Removing Session Data</h2>
<p>Just as set_userdata() can be used to add information into a session, unset_userdata() can be used to remove it, by passing the session key. For example, if you wanted to remove 'some_name' from your session information: </p>
@@ -194,12 +190,8 @@ unless you store session data in a database there is no way to validate it. For security, session ID validation may not be needed, but if your application requires security, validation is mandatory.</p>
<p>When session data is available in a database, every time a valid session is found in the user's cookie, a database
-query is performed to match it. If the session ID does not match, the session is destroyed.</p>
-
-<p>An additional benefit of using a database is that it permits you to store custom data along with the session. Earlier in this page we described how to add
-custom data to your session. When you use the database feature, your custom data will be stored automatically in the database <strong>instead</strong> of in
-the user's cookie.</p>
-
+query is performed to match it. If the session ID does not match, the session is destroyed. Session IDs can never
+be updated, they can only be generated when a new session is created.</p>
<p>In order to store sessions, you must first create a database table for this purpose. Here is the basic
prototype (for MySQL) required by the session class:</p>
@@ -210,15 +202,12 @@ session_id varchar(40) DEFAULT '0' NOT NULL, ip_address varchar(16) DEFAULT '0' NOT NULL,
user_agent varchar(50) NOT NULL,
last_activity int(10) unsigned DEFAULT 0 NOT NULL,
-user_data text NOT NULL,
PRIMARY KEY (session_id)
);</textarea>
-<p><strong>Note:</strong> By default the table is named <dfn>ci_sessions</dfn>, but you can name it anything you want
-as long as you update the <kbd>application/config/config.php</kbd> file so that it contains the name you have chosen. The Session class, however,
-expects the column names to be identical to the ones indicated above.</p>
-
-<p>Once you have created your database table you can enable the database option in your config.php file as follows:</p>
+<p><strong>Note:</strong> By default the table is called <dfn>ci_sessions</dfn>, but you can name it anything you want
+as long as you update the <kbd>application/config/config.php</kbd> file so that it contains the name you have chosen.
+Once you have created your database table you can enable the database option in your config.php file as follows:</p>
<code>$config['sess_use_database'] = TRUE;</code>
@@ -228,7 +217,7 @@ expects the column names to be identical to the ones indicated above.</p> <code>$config['sess_table_name'] = 'ci_sessions";</code>
-<p class="important"><strong>Note:</strong> The Session class has a built-in garbage collection routine which clears out expired sessions periodically so you
+<p class="important"><strong>Note:</strong> The Session class has built-in garbage collection which clears out expired sessions so you
do not need to write your own routine to do it.</p>
@@ -240,84 +229,64 @@ do not need to write your own routine to do it.</p> <h2>Session Preferences</h2>
-<p>Normally you will set the Session preferences in your <kbd>application/config/config.php</kbd> file.</p>
-
-<p>If you prefer to set any of the preferences manually you can do so when you load the session class, by passing an array of values you
-wish to set in the second parameter as follows:</p>
-
-<code>
-$session_vals = array(<br />
- 'sess_expiration' = 10800,<br />
- 'sess_match_ip' = TRUE<br />
- );<br />
-<br />
-$this->load->library('session', $session_vals);
-</code>
-
-<p>The following table lists the available preferences:</p>
+<p>You'll find the following Session related preferences in your <kbd>application/config/config.php</kbd> file:</p>
<table cellpadding="0" cellspacing="1" border="0" style="width:100%" class="tableborder">
<tr>
- <th>Preference</th>
- <th>Default</th>
- <th>Options</th>
- <th>Description</th>
-</tr>
-<tr>
- <td class="td"><strong>sess_cookie_name</strong></td>
- <td class="td">ci_session</td>
- <td class="td">None</td>
- <td class="td">The name you want the session cookie saved as.</td>
+ <th>Preference</th>
+ <th>Default</th>
+ <th>Options</th>
+ <th>Description</th>
</tr>
<tr>
- <td class="td"><strong>sess_expiration</strong></td>
- <td class="td">7200</td>
- <td class="td">None</td>
- <td class="td">The number of seconds you would like the session to last. The default value is 2 hours (7200 seconds). If you would like a non-expiring session set the value to zero: 0</td>
+ <td class="td"><strong>sess_cookie_name</strong></td>
+ <td class="td">ci_session</td>
+ <td class="td">None</td>
+ <td class="td">The name you want the session cookie saved as.</td>
</tr>
<tr>
- <td class="td"><strong>sess_encrypt_cookie</strong></td>
- <td class="td">FALSE</td>
- <td class="td">TRUE/FALSE (boolean)</td>
- <td class="td">Whether to encrypt the session data.</td>
+ <td class="td"><strong>sess_expiration</strong></td>
+ <td class="td">7200</td>
+ <td class="td">None</td>
+ <td class="td">The number of seconds you would like the session to last. The default value is 2 hours (7200 seconds). If you would like a non-expiring session set the value to zero: 0</td>
</tr>
<tr>
- <td class="td"><strong>sess_use_database</strong></td>
- <td class="td">FALSE</td>
- <td class="td">TRUE/FALSE (boolean)</td>
- <td class="td">Whether to save the session data to a database. You must create the table before enabling this option.</td>
+ <td class="td"><strong>sess_encrypt_cookie</strong></td>
+ <td class="td">FALSE</td>
+ <td class="td">TRUE/FALSE (boolean)</td>
+ <td class="td">Whether to encrypt the session data.</td>
</tr>
<tr>
- <td class="td"><strong>sess_table_name</strong></td>
- <td class="td">ci_sessions</td>
- <td class="td">Any valid SQL table name</td>
- <td class="td">The name of the session database table.</td>
+ <td class="td"><strong>sess_use_database</strong></td>
+ <td class="td">FALSE</td>
+ <td class="td">TRUE/FALSE (boolean)</td>
+ <td class="td">Whether to save the session data to a database. You must create the table before enabling this option.</td>
</tr>
<tr>
- <td class="td"><strong>sess_time_to_update</strong></td>
- <td class="td">300</td>
- <td class="td">Time in seconds</td>
- <td class="td">This options controls how often the session class will regenerate itself and create a new session id.</td>
+ <td class="td"><strong>sess_table_name</strong></td>
+ <td class="td">ci_sessions</td>
+ <td class="td">Any valid SQL table name</td>
+ <td class="td">The name of the session database table.</td>
</tr>
<tr>
- <td class="td"><strong>sess_match_ip</strong></td>
- <td class="td">FALSE</td>
- <td class="td">TRUE/FALSE (boolean)</td>
- <td class="td">Whether to match the user's IP address when reading the session data. Note that some ISPs dynamically
- changes the IP, so if you want a non-expiring session you will likely set this to FALSE.</td>
+ <td class="td"><strong>sess_time_to_update</strong></td>
+ <td class="td">300</td>
+ <td class="td">Time in seconds</td>
+ <td class="td">This options controls how often the session class will regenerate itself and create a new session id.</td>
</tr>
<tr>
- <td class="td"><strong>sess_match_useragent</strong></td>
- <td class="td">TRUE</td>
- <td class="td">TRUE/FALSE (boolean)</td>
- <td class="td">Whether to match the User Agent when reading the session data.</td>
+ <td class="td"><strong>sess_match_ip</strong></td>
+ <td class="td">FALSE</td>
+ <td class="td">TRUE/FALSE (boolean)</td>
+ <td class="td">Whether to match the user's IP address when reading the session data. Note that some ISPs dynamically
+ changes the IP, so if you want a non-expiring session you will likely set this to FALSE.</td>
</tr>
<tr>
- <td class="td"><strong>sess_cookie_name</strong></td>
- <td class="td">ci_session</td>
- <td class="td">None</td>
- <td class="td">The name of the session cookie</td>
+ <td class="td"><strong>sess_match_useragent</strong></td>
+ <td class="td">TRUE</td>
+ <td class="td">TRUE/FALSE (boolean)</td>
+ <td class="td">Whether to match the User Agent when reading the session data.</td>
</tr>
</table>
diff --git a/user_guide/libraries/validation.html b/user_guide/libraries/validation.html index 8b36e09ba..55443060c 100644 --- a/user_guide/libraries/validation.html +++ b/user_guide/libraries/validation.html @@ -576,64 +576,43 @@ For example, your "username" error will be available at:<br /><dfn>$this->valida <td class="td">Returns FALSE if the form element contains anything other than alpha-numeric characters, underscores or dashes.</td>
<td class="td"> </td>
</tr>
-
<tr>
-<td class="td"><strong>numeric</strong></td>
-<td class="td">No</td>
-<td class="td">Returns FALSE if the form element contains anything other than numeric characters.</td>
-<td class="td"> </td>
+ <td class="td"><strong>numeric</strong></td>
+ <td class="td">No</td>
+ <td class="td">Returns FALSE if the form element contains anything other than numeric characters.</td>
+ <td class="td"> </td>
</tr>
-
<tr>
+
<td class="td"><strong>integer</strong></td>
<td class="td">No</td>
<td class="td">Returns FALSE if the form element contains anything other than an integer.</td>
<td class="td"> </td>
-</tr>
-
-<tr>
-<td class="td"><strong>is_natural</strong></td>
-<td class="td">No</td>
-<td class="td">Returns FALSE if the form element contains anything other than a natural number: 0, 1, 2, 3, etc.</td>
-<td class="td"> </td>
-</tr>
-
-<tr>
-<td class="td"><strong>is_natural_no_zero</strong></td>
-<td class="td">No</td>
-<td class="td">Returns FALSE if the form element contains anything other than a natural number, but not zero: 1, 2, 3, etc.</td>
-<td class="td"> </td>
-</tr>
+</tr><tr>
-<tr>
<td class="td"><strong>valid_email</strong></td>
<td class="td">No</td>
<td class="td">Returns FALSE if the form element does not contain a valid email address.</td>
<td class="td"> </td>
</tr>
-
<tr>
-<td class="td"><strong>valid_emails</strong></td>
-<td class="td">No</td>
-<td class="td">Returns FALSE if any value provided in a comma separated list is not a valid email.</td>
-<td class="td"> </td>
+ <td class="td"><strong>valid_emails</strong></td>
+ <td class="td">No</td>
+ <td class="td">Returns FALSE if any value provided in a comma separated list is not a valid email.</td>
+ <td class="td"> </td>
</tr>
-
<tr>
<td class="td"><strong>valid_ip</strong></td>
<td class="td">No</td>
<td class="td">Returns FALSE if the supplied IP is not valid.</td>
<td class="td"> </td>
</tr>
-
<tr>
-<td class="td"><strong>valid_base64</strong></td>
-<td class="td">No</td>
-<td class="td">Returns FALSE if the supplied string contains anything other than valid Base64 characters.</td>
-<td class="td"> </td>
+ <td class="td"><strong>valid_base64</strong></td>
+ <td class="td">No</td>
+ <td class="td">Returns FALSE if the supplied string contains anything other than valid Base64 characters.</td>
+ <td class="td"> </td>
</tr>
-
-
</table>
<p><strong>Note:</strong> These rules can also be called as discrete functions. For example:</p>
|