Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / 35bee2787e2267a570ec2cd65dc61ba1162c9c23 / . / user_guide / general / routing.html
blob: a2c5a9676b77e0ca03fa299ecfb56cbf023e7040 [file] [log] [blame]
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
3<head>
4
5<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6<title>URI Routing : CodeIgniter User Guide</title>
7
8<style type='text/css' media='all'>@import url('../userguide.css');</style>
9<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
10
11<script type="text/javascript" src="../nav/nav.js"></script>
12<script type="text/javascript" src="../nav/prototype.lite.js"></script>
13<script type="text/javascript" src="../nav/moo.fx.js"></script>
14<script type="text/javascript" src="../nav/user_guide_menu.js"></script>
15
16<meta http-equiv='expires' content='-1' />
17<meta http-equiv= 'pragma' content='no-cache' />
18<meta name='robots' content='all' />
19<meta name='author' content='ExpressionEngine Dev Team' />
20<meta name='description' content='CodeIgniter User Guide' />
21
22</head>
23<body>
24
25<!-- START NAVIGATION -->
26<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
27<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>
28<div id="masthead">
29<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
30<tr>
Derek Jones733310d2009-02-11 01:13:43 +0000[diff] [blame]31<td><h1>CodeIgniter User Guide Version 1.7.1</h1></td>
Derek Allard2067d1a2008-11-13 22:59:24 +0000[diff] [blame]32<td id="breadcrumb_right"><a href="../toc.html">Table of Contents Page</a></td>
33</tr>
34</table>
35</div>
36<!-- END NAVIGATION -->
37
38
39<!-- START BREADCRUMB -->
40<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
41<tr>
42<td id="breadcrumb">
43<a href="http://codeigniter.com/">CodeIgniter Home</a> &nbsp;&#8250;&nbsp;
44<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
45URI Routing
46</td>
47<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&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
48</tr>
49</table>
50<!-- END BREADCRUMB -->
51
52<br clear="all" />
53
54
55<!-- START CONTENT -->
56<div id="content">
57
58<h1>URI Routing</h1>
59
60<p>Typically there is a one-to-one relationship between a URL string and its corresponding controller class/method.
61The segments in a URI normally follow this pattern:</p>
62
63<code>example.com/<dfn>class</dfn>/<samp>function</samp>/<var>id</var>/</code>
64
65<p>In some instances, however, you may want to remap this relationship so that a different class/function can be called
66instead of the one corresponding to the URL.</p>
67
68<p>For example, lets say you want your URLs to have this prototype:</p>
69
70<p>
71example.com/product/1/<br />
72example.com/product/2/<br />
73example.com/product/3/<br />
74example.com/product/4/
75</p>
76
77<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.
78To overcome this, CodeIgniter allows you to remap the URI handler.</p>
79
80
81<h2>Setting your own routing rules</h2>
82
83<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
84permits you to specify your own routing criteria. Routes can either be specified using <dfn>wildcards</dfn> or <dfn>Regular Expressions</dfn></p>
85
86
87<h2>Wildcards</h2>
88
89<p>A typical wildcard route might look something like this:</p>
90
91<code>$route['product/:num'] = "catalog/product_lookup";</code>
92
93<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.
94In 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,
95the "catalog" class and the "product_lookup" method are instead used.</p>
96
97<p>You can match literal values or you can use two wildcard types:</p>
98
99<p>
100:num<br />
101:any
102</p>
103
104<p><strong>:num</strong> will match a segment containing only numbers.<br />
105<strong>:any</strong> will match a segment containing any character.
106</p>
107
108<p class="important"><strong>Note:</strong> Routes will run in the order they are defined.
109Higher routes will always take precedence over lower ones.</p>
110
111<h2>Examples</h2>
112
113<p>Here are a few routing examples:</p>
114
115<code>$route['journals'] = "blogs";</code>
116<p>A URL containing the word "journals" in the first segment will be remapped to the "blogs" class.</p>
117
118<code>$route['blog/joe'] = "blogs/users/34";</code>
119<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>
120
121<code>$route['product/:any'] = "catalog/product_lookup";</code>
122<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>
123
124<code>$route['product/(:num)'] = "catalog/product_lookup_by_id/$1";</code>
125<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>
126
127<p class="important"><strong>Important:</strong> Do not use leading/trailing slashes.</p>
128
129<h2>Regular Expressions</h2>
130
131<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>
132
133<p class="important"><strong>Note:</strong>&nbsp; If you use back-references you must use the dollar syntax rather than the double backslash syntax.</p>
134
135<p>A typical RegEx route might look something like this:</p>
136
137<code>$route['products/([a-z]+)/(\d+)'] = "$1/id_$2";</code>
138
139<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>
140
141<p>You can also mix and match wildcards with regular expressions.</p>
142
143<h2>Reserved Routes</h2>
144
145<p>There are two reserved routes:</p>
146
147<code>$route['default_controller'] = 'welcome';</code>
148
149<p>This route indicates which controller class should be loaded if the URI contains no data, which will be the case
150when people load your root URL. In the above example, the "welcome" class would be loaded. You
151are encouraged to always have a default route otherwise a 404 page will appear by default.</p>
152
153<code>$route['scaffolding_trigger'] = 'scaffolding';</code>
154
155<p>This route lets you set a secret word, which when present in the URL, triggers the scaffolding feature.
156Please read the <a href="scaffolding.html">Scaffolding</a> page for details.</p>
157
158<p class="important"><strong>Important:</strong>&nbsp; The reserved routes must come before any wildcard or regular expression routes.</p>
159
160</div>
161<!-- END CONTENT -->
162
163
164<div id="footer">
165<p>
166Previous Topic:&nbsp;&nbsp;<a href="scaffolding.html">Scaffolding</a>
167&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
168<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
169<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
170Next Topic:&nbsp;&nbsp;<a href="errors.html">Error Handling</a>
171</p>
172<p><a href="http://codeigniter.com">CodeIgniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006-2008 &nbsp;&middot;&nbsp; <a href="http://ellislab.com/">Ellislab, Inc.</a></p>
173</div>
174
175</body>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]176</html>