<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Add new Route into Router</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-router.addconfig.html">Yaf_Router::addConfig</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-router.construct.html">Yaf_Router::__construct</a></div>
<div class="up"><a href="class.yaf-router.html">Yaf_Router</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="yaf-router.addroute" class="refentry">
<div class="refnamediv">
<h1 class="refname">Yaf_Router::addRoute</h1>
<p class="verinfo">(Yaf >=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Router::addRoute</span> — <span class="dc-title">Add new Route into Router</span></p>
</div>
<div class="refsect1 description" id="refsect1-yaf-router.addroute-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Yaf_Router::addRoute</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type"><span class="type Yaf_Route_Abstract">Yaf_Route_Abstract</span></span> <code class="parameter">$route</code></span>
)</div>
<p class="para rdfs-comment">
defaultly, Yaf_Router using a <a href="class.yaf-route-static.html" class="classname">Yaf_Route_Static</a> as its defualt route. you
can add new routes into router's route stack by calling this method.
</p>
<p class="para">
the newer route will be called before the older(route stack), and if the newer router return
<strong><code>TRUE</code></strong>, the router process will be end. otherwise, the older one will be
called.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-yaf-router.addroute-parameters">
<h3 class="title">Parameters</h3>
<p class="para">This function has no parameters.</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-yaf-router.addroute-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 examples" id="refsect1-yaf-router.addroute-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4177">
<p><strong>Example #1 <span class="function"><a href="yaf-dispatcher.autorender.html" class="function">Yaf_Dispatcher::autoRender()</a></span>example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">Bootstrap </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Bootstrap_Abstract</span><span style="color: #007700">{<br /> public function </span><span style="color: #0000BB">_initConfig</span><span style="color: #007700">() {<br /> </span><span style="color: #0000BB">$config </span><span style="color: #007700">= </span><span style="color: #0000BB">Yaf_Application</span><span style="color: #007700">::</span><span style="color: #0000BB">app</span><span style="color: #007700">()-></span><span style="color: #0000BB">getConfig</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">Yaf_Registry</span><span style="color: #007700">::</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">"config"</span><span style="color: #007700">, </span><span style="color: #0000BB">$config</span><span style="color: #007700">);<br /> }<br /><br /> public function </span><span style="color: #0000BB">_initRoute</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Dispatcher $dispatcher</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$router </span><span style="color: #007700">= </span><span style="color: #0000BB">$dispatcher</span><span style="color: #007700">-></span><span style="color: #0000BB">getRouter</span><span style="color: #007700">();<br /> </span><span style="color: #FF8000">/**<br /> * we can add some pre-defined routes in application.ini<br /> */<br /> </span><span style="color: #0000BB">$router</span><span style="color: #007700">-></span><span style="color: #0000BB">addConfig</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Registry</span><span style="color: #007700">::</span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"config"</span><span style="color: #007700">)-></span><span style="color: #0000BB">routes</span><span style="color: #007700">);<br /> </span><span style="color: #FF8000">/**<br /> * add a Rewrite route, then for a request uri: <br /> * http://***/</span><span style="color: #0000BB">product</span><span style="color: #007700">/list/</span><span style="color: #0000BB">22</span><span style="color: #007700">/</span><span style="color: #0000BB">foo<br /> </span><span style="color: #007700">* </span><span style="color: #0000BB">will be matched by this route</span><span style="color: #007700">, and </span><span style="color: #0000BB">result</span><span style="color: #007700">:<br /> *<br /> * [</span><span style="color: #0000BB">module</span><span style="color: #007700">] => <br /> * [</span><span style="color: #0000BB">controller</span><span style="color: #007700">] => </span><span style="color: #0000BB">product<br /> </span><span style="color: #007700">* [</span><span style="color: #0000BB">action</span><span style="color: #007700">] => </span><span style="color: #0000BB">info<br /> </span><span style="color: #007700">* [</span><span style="color: #0000BB">method</span><span style="color: #007700">] => </span><span style="color: #0000BB">GET<br /> </span><span style="color: #007700">* [</span><span style="color: #0000BB">params</span><span style="color: #007700">:protected] => Array<br /> * (<br /> * [</span><span style="color: #0000BB">id</span><span style="color: #007700">] => </span><span style="color: #0000BB">22<br /> </span><span style="color: #007700">* [</span><span style="color: #0000BB">name</span><span style="color: #007700">] => </span><span style="color: #0000BB">foo<br /> </span><span style="color: #007700">* )<br /> * <br /> */<br /> </span><span style="color: #0000BB">$route </span><span style="color: #007700">= new </span><span style="color: #0000BB">Yaf_Route_Rewrite</span><span style="color: #007700">(<br /> </span><span style="color: #DD0000">"/product/list/:id/:name"</span><span style="color: #007700">,<br /> array(<br /> </span><span style="color: #DD0000">"controller" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"product"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"action" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"info"</span><span style="color: #007700">,<br /> )<br /> ); <br /> <br /> </span><span style="color: #0000BB">$router</span><span style="color: #007700">-></span><span style="color: #0000BB">addRoute</span><span style="color: #007700">(</span><span style="color: #DD0000">'dummy'</span><span style="color: #007700">, </span><span style="color: #0000BB">$route</span><span style="color: #007700">);<br /> }<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-yaf-router.addroute-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="yaf-router.addconfig.html" class="methodname" rel="rdfs-seeAlso">Yaf_Router::addConfig()</a> - Add config-defined routes into Router</span></li>
<li class="member"><a href="class.yaf-route-static.html" class="classname">Yaf_Route_Static</a></li>
<li class="member"><a href="class.yaf-route-supervar.html" class="classname">Yaf_Route_Supervar</a></li>
<li class="member"><a href="class.yaf-route-simple.html" class="classname">Yaf_Route_Simple</a></li>
<li class="member"><a href="class.yaf-route-regex.html" class="classname">Yaf_Route_Regex</a></li>
<li class="member"><a href="class.yaf-route-rewrite.html" class="classname">Yaf_Route_Rewrite</a></li>
<li class="member"><a href="class.yaf-route-map.html" class="classname">Yaf_Route_Map</a></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-router.addconfig.html">Yaf_Router::addConfig</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-router.construct.html">Yaf_Router::__construct</a></div>
<div class="up"><a href="class.yaf-router.html">Yaf_Router</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
