<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-route-interface.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'fr',
  ),
  'this' => 
  array (
    0 => 'yaf-route-interface.route.php',
    1 => 'Yaf_Route_Interface::route',
    2 => 'Route une requ&ecirc;te',
  ),
  'up' => 
  array (
    0 => 'class.yaf-route-interface.php',
    1 => 'Yaf_Route_Interface',
  ),
  'prev' => 
  array (
    0 => 'yaf-route-interface.assemble.php',
    1 => 'Yaf_Route_Interface::assemble',
  ),
  'next' => 
  array (
    0 => 'class.yaf-route-map.php',
    1 => 'Yaf_Route_Map',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'fr',
    'path' => 'reference/yaf/yaf_route_interface/route.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-route-interface.route" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yaf_Route_Interface::route</h1>
  <p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Route_Interface::route</span> &mdash; <span class="dc-title">Route une requête</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="methodname"><strong>Yaf_Route_Interface::route</strong></span>(<span class="methodparam"><span class="type"><a href="class.yaf-request-abstract.php" class="type Yaf_Request_Abstract">Yaf_Request_Abstract</a></span> <code class="parameter">$request</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   <span class="methodname"><strong>Yaf_Route_Interface::route()</strong></span> est la seule
   méthode qu&#039;une route personnalisée doit implémenter.
   <blockquote class="note"><p><strong class="note">Note</strong>: 
    <p class="para">
     Depuis 2.3.0, il y a une autre méthode à implémenter :
     <span class="methodname"><a href="yaf-route-interface.assemble.php" class="methodname">Yaf_Route_Interface::assemble()</a></span>.
    </p>
   </p></blockquote>
  </p>
  <p class="para">
   Si cette méthode retourne <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, alors le processus route se terminera.
   Sinon, <span class="classname"><a href="class.yaf-router.php" class="classname">Yaf_Router</a></span> appellera la prochaine route de la
   pile des routes.
  </p>
  
  <p class="para">
   Cette méthode définira le résultat de la route au paramètre de la
   requête, en appelant les méthodes 
   <span class="methodname"><a href="yaf-request-abstract.setcontrollername.php" class="methodname">Yaf_Request_Abstract::setControllerName()</a></span>,
   <span class="methodname"><a href="yaf-request-abstract.setactionname.php" class="methodname">Yaf_Request_Abstract::setActionName()</a></span> et
   <span class="methodname"><a href="yaf-request-abstract.setmodulename.php" class="methodname">Yaf_Request_Abstract::setModuleName()</a></span>.
  </p>
  
  <p class="para">
   Cette méthode doit également appeler la méthode
   <span class="methodname"><a href="yaf-request-abstract.setrouted.php" class="methodname">Yaf_Request_Abstract::setRouted()</a></span> en dernier
   pour router la requête.
  </p>
  
 </div>

 
 <div class="refsect1 parameters" id="refsect1-yaf-route-interface.route-parameters">
  <h3 class="title">Liste de paramètres</h3>
  <dl>
   
    <dt><code class="parameter">request</code></dt>
    <dd>
     <p class="para">
      Une instance de la classe <span class="classname"><a href="class.yaf-request-abstract.php" class="classname">Yaf_Request_Abstract</a></span>.
     </p>
    </dd>
   
  </dl>
 </div>

 
 <div class="refsect1 returnvalues" id="refsect1-yaf-route-interface.route-returnvalues">
  <h3 class="title">Valeurs de retour</h3>
  <p class="para">
   
  </p>
 </div>

 
 
</div><?php manual_footer($setup); ?>