<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.yaf.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'class.yaf-router.php',
    1 => 'Yaf_Router',
    2 => 'Yaf_Router 类',
  ),
  'up' => 
  array (
    0 => 'book.yaf.php',
    1 => 'Yaf',
  ),
  'prev' => 
  array (
    0 => 'yaf-route-rewrite.route.php',
    1 => 'Yaf_Route_Rewrite::route',
  ),
  'next' => 
  array (
    0 => 'yaf-router.addconfig.php',
    1 => 'Yaf_Router::addConfig',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yaf/yaf-router.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.yaf-router.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.yaf-router" class="reference">

 <h1 class="title">Yaf_Router 类</h1>
 

 <div class="partintro"><p class="verinfo">(Yaf &gt;=1.0.0)</p>


  <div class="section" id="yaf-router.intro">
   <h2 class="title">简介</h2>
   <p class="para">
    <span class="classname"><strong class="classname">Yaf_Router</strong></span> 是标准的框架路由。路由是获取 URI 端点（位于基本 URI 之后的 URI 部分：参考
    <span class="methodname"><a href="yaf-request-abstract.setbaseuri.php" class="methodname">Yaf_Request_Abstract::setBaseUri()</a></span>）并将其分解为参数得到哪个 module、controller 和
    action 需要接收请求。module、controller、action 和其它参数打包到 <span class="classname"><a href="class.yaf-request-abstract.php" class="classname">Yaf_Request_Abstract</a></span>
    对象中，然后由 <span class="classname"><a href="class.yaf-dispatcher.php" class="classname">Yaf_Dispatcher</a></span> 处理。路由只发生一次：最初接到请求和在第一个 controller
    分发之前。

    <span class="classname"><strong class="classname">Yaf_Router</strong></span> 是设计来允许使用纯 PHP 结构的类似 mod_rewrite 的功能。它非常松散的基于 Ruby on
    Rails 的路由，并且不需要提前知悉 webserver URL 重写的相关知识。它设计为跟单个 Apache mod_rewrite（或其中之一个）
    规则一起使用：
   <div class="example" id="example-1">
    <p><strong>示例 #1 Apache 重写规则</strong></p>
   <div class="example-contents">
<div class="confcode"><pre class="confcode">RewriteEngine on
RewriteRule !\.(js|ico|gif|jpg|png|css|html)$ index.php</pre>
</div>
   </div>

   </div>
   或者（首选）：
   <div class="example" id="example-2">
   <p><strong>示例 #2 Apache 重写规则</strong></p>
   <div class="example-contents">
<div class="confcode"><pre class="confcode">RewriteEngine On
RewriteCond %{REQUEST_FILENAME} -s [OR]
RewriteCond %{REQUEST_FILENAME} -l [OR]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^.*$ - [NC,L]
RewriteRule ^.*$ index.php [NC,L]</pre>
</div>
   </div>

  </div>
   如果使用 Lighttpd，以下重写规则有效：
   <div class="example" id="example-3">
    <p><strong>示例 #3 Lighttpd 重写规则</strong></p>
   <div class="example-contents">
<div class="confcode"><pre class="confcode">url.rewrite-once = (
  &quot;.*\?(.*)$&quot; =&gt; &quot;/index.php?$1&quot;,
  &quot;.*\.(js|ico|gif|jpg|png|css|html)$&quot; =&gt; &quot;$0&quot;,
  &quot;&quot; =&gt; &quot;/index.php&quot;
)</pre>
</div>
   </div>

  </div>
   如果使用 Nginx，以下重写规则有效：
   <div class="example" id="example-4">
    <p><strong>示例 #4 Nginx 重写规则</strong></p>
   <div class="example-contents">
<div class="confcode"><pre class="confcode">server {
  listen ****;
  server_name  yourdomain.com;
  root   document_root;
  index  index.php index.html;

  if (!-e $request_filename) {
    rewrite ^/(.*)  /index.php/$1 last;
  }
}</pre>
</div>
   </div>

  </div>
   </p>
  </div>


  <div class="section" id="yaf-router.default">
   <h2 class="title">默认路由</h2>
   <p class="para">
    <span class="classname"><strong class="classname">Yaf_Router</strong></span> 预设了默认路由 <span class="classname"><a href="class.yaf-route-static.php" class="classname">Yaf_Route_Static</a></span>，将以 controller/action
    的形式匹配 URI。此外，module 名可以被指定为第一个路径元素，允许 URI 设置为 module/controller/action 形式的
    URI。最后，它也会匹配默认追加到 URI 中所有附加参数——controller/action/var1/value1/var2/value2。
    <blockquote class="note"><p><strong class="note">注意</strong>: 
     <p class="para">
      Module 名必须在配置中定义，就 application.module=&quot;Index,Foo,Bar&quot; 而言，在这种情况下，仅 index、foo 和 bar 可以认做
      module 名。如果没有配置，那么 Yaf 使用默认 module 名“Index”。
     </p>
    </p></blockquote>
   </p>

   <p class="para">
    如何匹配这些路由的一些例子：
   <div class="example" id="example-5">
    <p><strong>示例 #5 <span class="classname"><a href="class.yaf-route-static.php" class="classname">Yaf_Route_Static</a></span>（默认路由）示例</strong></p>
   <div class="example-contents">
<div class="confcode"><pre class="confcode">// Assuming the following configure:
$conf = array(
   &quot;application&quot; =&gt; array(
      &quot;modules&quot; =&gt; &quot;Index,Blog&quot;,
   ),
);

Controller only:
http://example/news
    controller == news
Action only(when defined yaf.action_prefer=1 in php.ini)
    action  == news
 
Invalid module maps to controller name:
http://example/foo
    controller == foo
 
Module + controller:
http://example/blog/archive
    module     == blog
    controller == archive
 
Module + controller + action:
http://example/blog/archive/list
    module     == blog
    controller == archive
    action     == list
 
Module + controller + action + params:
http://example/blog/archive/list/sort/alpha/date/desc
    module     == blog
    controller == archive
    action     == list
    sort       == alpha
    date       == desc</pre>
</div>
   </div>

  </div>

  </p>
  </div>

  <div class="section" id="yaf-router.synopsis">
   <h2 class="title">类摘要</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">Yaf_Router</strong>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 属性 */</div>
    <div class="fieldsynopsis">
     <span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-router.php#yaf-router.props.routes">$<var class="varname">_routes</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-router.php#yaf-router.props.current">$<var class="varname">_current</var></a></var>;</div>


    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 方法 */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="yaf-router.construct.php" class="methodname">__construct</a></span>()</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-router.addconfig.php" class="methodname">addConfig</a></span>(<span class="methodparam"><span class="type"><a href="class.yaf-config-abstract.php" class="type Yaf_Config_Abstract">Yaf_Config_Abstract</a></span> <code class="parameter">$config</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-router.addroute.php" class="methodname">addRoute</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type">Yaf_Route_Abstract</span> <code class="parameter">$route</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-router.getcurrentroute.php" class="methodname">getCurrentRoute</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-router.getroute.php" class="methodname">getRoute</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>): <span class="type"><a href="class.yaf-route-interface.php" class="type Yaf_Route_Interface">Yaf_Route_Interface</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-router.getroutes.php" class="methodname">getRoutes</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-router.route.php" class="methodname">route</a></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>

   }</div>


  </div>

  

  <div class="section" id="yaf-router.props">
   <h2 class="title">属性</h2>
   <dl>
    
     <dt id="yaf-router.props.routes"><var class="varname">_routes</var></dt>
     <dd>
      <p class="para">
       已注册路由栈
      </p>
     </dd>
    
    
     <dt id="yaf-router.props.current"><var class="varname">_current</var></dt>
     <dd>
      <p class="para">
       在路由阶段后，这用于指示当前请求的路由名称。

       可以通过 <span class="methodname"><a href="yaf-router.getcurrentroute.php" class="methodname">Yaf_Router::getCurrentRoute()</a></span> 获取此名称。
      </p>
     </dd>
    
   </dl>
  </div>



 </div>

 

















































<h2>目录</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-router.addconfig.php">Yaf_Router::addConfig</a> — 向 Router 中添加配置文件中定义的路由</li><li><a href="yaf-router.addroute.php">Yaf_Router::addRoute</a> — 往 Router 中添加新的路由</li><li><a href="yaf-router.construct.php">Yaf_Router::__construct</a> — Yaf_Router 构造方法</li><li><a href="yaf-router.getcurrentroute.php">Yaf_Router::getCurrentRoute</a> — 取得当前有效的路由名</li><li><a href="yaf-router.getroute.php">Yaf_Router::getRoute</a> — 通过名称检索路由</li><li><a href="yaf-router.getroutes.php">Yaf_Router::getRoutes</a> — 检索已注册的路由</li><li><a href="yaf-router.route.php">Yaf_Router::route</a> — The route purpose</li></ul>
</div>
<?php manual_footer($setup); ?>