diff options
| author | admin <devnull@localhost> | 2006-08-25 19:25:49 +0200 |
|---|---|---|
| committer | admin <devnull@localhost> | 2006-08-25 19:25:49 +0200 |
| commit | b0dd10f8171945e0c1f3527dd1e9d18b043e01a7 (patch) | |
| tree | c3583ba09e72217683c4304f4690df6ce39ba731 /user_guide/general/routing.html | |
Initial Import
Diffstat (limited to 'user_guide/general/routing.html')
| -rw-r--r-- | user_guide/general/routing.html | 163 |
1 files changed, 163 insertions, 0 deletions
diff --git a/user_guide/general/routing.html b/user_guide/general/routing.html new file mode 100644 index 000000000..c6e8bd9cf --- /dev/null +++ b/user_guide/general/routing.html @@ -0,0 +1,163 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+<head>
+
+<title>Code Igniter 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="../scripts/nav.js"></script>
+<script type="text/javascript" src="../scripts/prototype.lite.js"></script>
+<script type="text/javascript" src="../scripts/moo.fx.js"></script>
+<script type="text/javascript">
+window.onload = function() {
+ myHeight = new fx.Height('nav', {duration: 400});
+ myHeight.hide();
+}
+</script>
+
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta http-equiv='expires' content='-1' />
+<meta http-equiv= 'pragma' content='no-cache' />
+<meta name='robots' content='all' />
+<meta name='author' content='Rick Ellis' />
+<meta name='description' content='Code Igniter User Guide' />
+
+</head>
+<body>
+
+<!-- START NAVIGATION -->
+<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
+<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
+<div id="masthead">
+<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
+<tr>
+<td><h1>Code Igniter User Guide Version 1.4.0</h1></td>
+<td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</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://www.codeigniter.com/">Code Igniter 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="www.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>www.your-site.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>
+www.your-site.com/product/1/<br />
+www.your-site.com/product/2/<br />
+www.your-site.com/product/3/<br />
+www.your-site.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, Code Igniter 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
+you can use to specify your own routing criteria. A typical 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>
+:num<br />
+:any
+</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>Any 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>Any 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>Any 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>
+
+<p class="important"><strong>Important:</strong> Do not use leading/trailing slashes.</p>
+
+
+<h2>Reserved Route</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['scaffolding_trigger'] = 'scaffolding';</code>
+
+<p>This route lets you set a secret word, which when present in the URL, triggers the scaffolding feature.
+Please read the <a href="scaffolding.html">Scaffolding</a> page for details.</p>
+
+
+
+
+</div>
+<!-- END CONTENT -->
+
+
+<div id="footer">
+<p>
+Previous Topic: <a href="scaffolding.html">Scaffolding</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://www.codeigniter.com">Code Igniter</a> · Copyright © 2006 · <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
+</div>
+
+</body>
+</html>
\ No newline at end of file |