<!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>route a request</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.yaf-route-interface.html">Yaf_Route_Interface</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.yaf-route-map.html">Yaf_Route_Map</a></div>
<div class="up"><a href="class.yaf-route-interface.html">Yaf_Route_Interface</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="yaf-route-interface.route" class="refentry">
<div class="refnamediv">
<h1 class="refname">Yaf_Route_Interface::route</h1>
<p class="verinfo">(Yaf >=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Route_Interface::route</span> — <span class="dc-title">route a request</span></p>
</div>
<div class="refsect1 description" id="refsect1-yaf-route-interface.route-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">abstract</span> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Yaf_Route_Interface::route</strong></span>
( <span class="methodparam"><span class="type"><a href="class.yaf-request-abstract.html" class="type Yaf_Request_Abstract">Yaf_Request_Abstract</a></span> <code class="parameter">$request</code></span>
)</div>
<p class="para rdfs-comment">
<span class="methodname"><strong>Yaf_Route_Interface::route()</strong></span> is the only method
that a custom route should implement.
</p>
<p class="para">
if this method return <strong><code>TRUE</code></strong>, then the route process will be end. otherwise,
<a href="class.yaf-router.html" class="classname">Yaf_Router</a> will call next route in the route stack
to route request.
</p>
<p class="para">
This method would set the route result to the parameter request, by
calling <span class="methodname"><a href="yaf-request-abstract.setcontrollername.html" class="methodname">Yaf_Request_Abstract::setControllerName()</a></span>,
<span class="methodname"><a href="yaf-request-abstract.setactionname.html" class="methodname">Yaf_Request_Abstract::setActionName()</a></span> and
<span class="methodname"><a href="yaf-request-abstract.setmodulename.html" class="methodname">Yaf_Request_Abstract::setModuleName()</a></span>.
</p>
<p class="para">
This method should also call
<span class="methodname"><a href="yaf-request-abstract.setrouted.html" class="methodname">Yaf_Request_Abstract::setRouted()</a></span> to make the
request routed at last.
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-yaf-route-interface.route-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">request</code></em></span>
<dd>
<p class="para">
A <a href="class.yaf-request-abstract.html" class="classname">Yaf_Request_Abstract</a> instance.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-yaf-route-interface.route-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.yaf-route-interface.html">Yaf_Route_Interface</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.yaf-route-map.html">Yaf_Route_Map</a></div>
<div class="up"><a href="class.yaf-route-interface.html">Yaf_Route_Interface</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
