diff options
Diffstat (limited to 'user_guide/general/routing.html')
| -rw-r--r-- | user_guide/general/routing.html | 350 |
1 files changed, 175 insertions, 175 deletions
diff --git a/user_guide/general/routing.html b/user_guide/general/routing.html index 80c8ab0d5..062dc193b 100644 --- a/user_guide/general/routing.html +++ b/user_guide/general/routing.html @@ -1,176 +1,176 @@ -<!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 1.7</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>
-: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>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 anything 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['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>
-
-<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="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://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
-</div>
-
-</body>
+<!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 1.7</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> +: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>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 anything 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['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> + +<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="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://codeigniter.com">CodeIgniter</a> · Copyright © 2006-2008 · <a href="http://ellislab.com/">Ellislab, Inc.</a></p> +</div> + +</body> </html>
\ No newline at end of file |