<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-request-abstract.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'yaf-request-abstract.setcontrollername.php',
    1 => 'Yaf_Request_Abstract::setControllerName',
    2 => '设置控制器名',
  ),
  'up' => 
  array (
    0 => 'class.yaf-request-abstract.php',
    1 => 'Yaf_Request_Abstract',
  ),
  'prev' => 
  array (
    0 => 'yaf-request-abstract.setbaseuri.php',
    1 => 'Yaf_Request_Abstract::setBaseUri',
  ),
  'next' => 
  array (
    0 => 'yaf-request-abstract.setdispatched.php',
    1 => 'Yaf_Request_Abstract::setDispatched',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yaf/yaf_request_abstract/setcontrollername.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-request-abstract.setcontrollername" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yaf_Request_Abstract::setControllerName</h1>
  <p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Request_Abstract::setControllerName</span> &mdash; <span class="dc-title">设置控制器名</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-request-abstract.setcontrollername-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaf_Request_Abstract::setControllerName</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$controller</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$format_name</code><span class="initializer"> = true</span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.yaf-request-abstract.php" class="type Yaf_Request_Abstract">Yaf_Request_Abstract</a></span></span></div>

  <p class="para rdfs-comment">
    设置请求对象的控制器名，通常由自定义路由器用于设置路由结果的控制器名。
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-request-abstract.setcontrollername-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">controller</code></dt>
    <dd>
     <p class="para">
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span>，控制器名，应该是骆驼（camel）风格，比如 &quot;Index&quot; 或 &quot;Foo_Bar&quot; 
     </p>
    </dd>
   
   
    <dt><code class="parameter">format_name</code></dt>
    <dd>
     <p class="para">
      该参数自 Yaf 3.2.0 引入，默认情况下 Yaf 会将名称格式化为骆驼风格，
      如果设置为 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>，Yaf 将直接使用原始名称。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yaf-request-abstract.setcontrollername-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   成功时返回请求对象自身，失败时返回 <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-request-abstract.setcontrollername-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="methodname"><strong>Yaf_Request_Abstract::setControllerName()</strong></span> 示例</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #007700">class </span><span style="color: #0000BB">RestRouter </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Route_Interface
</span><span style="color: #007700">{
    public function </span><span style="color: #0000BB">route</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Request_Abstract $request</span><span style="color: #007700">)
    {
        if (</span><span style="color: #0000BB">0 </span><span style="color: #007700">=== </span><span style="color: #0000BB">strpos</span><span style="color: #007700">(</span><span style="color: #0000BB">$request</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRequestUri</span><span style="color: #007700">(), </span><span style="color: #DD0000">"/api"</span><span style="color: #007700">)) {
            </span><span style="color: #FF8000">// 默认情况下名称会被格式化为骆驼风格，
            // 因此 "order_item" 会变成 "Order_Item"
            </span><span style="color: #0000BB">$request</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setControllerName</span><span style="color: #007700">(</span><span style="color: #DD0000">"order_item"</span><span style="color: #007700">)
                    -&gt;</span><span style="color: #0000BB">setActionName</span><span style="color: #007700">(</span><span style="color: #DD0000">"list"</span><span style="color: #007700">);
            return </span><span style="color: #0000BB">true</span><span style="color: #007700">;
        }

        return </span><span style="color: #0000BB">false</span><span style="color: #007700">;
    }

    public function </span><span style="color: #0000BB">assemble</span><span style="color: #007700">(array </span><span style="color: #0000BB">$info</span><span style="color: #007700">, array </span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">) {}
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-request-abstract.setcontrollername-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yaf-request-abstract.setmodulename.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::setModuleName()</a> - 设置模块名</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.setactionname.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::setActionName()</a> - 设置 action 名</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.getcontrollername.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::getControllerName()</a> - 获取控制器名称</span></li>
  </ul>
 </div>

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