<?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-controller-abstract.php',
    1 => 'Yaf_Controller_Abstract',
    2 => 'Yaf_Controller_Abstract 类',
  ),
  'up' => 
  array (
    0 => 'book.yaf.php',
    1 => 'Yaf',
  ),
  'prev' => 
  array (
    0 => 'yaf-config-simple.valid.php',
    1 => 'Yaf_Config_Simple::valid',
  ),
  'next' => 
  array (
    0 => 'yaf-controller-abstract.construct.php',
    1 => 'Yaf_Controller_Abstract::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yaf/yaf-controller-abstract.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.yaf-controller-abstract.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-controller-abstract" class="reference">

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

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


  <div class="section" id="yaf-controller-abstract.intro">
   <h2 class="title">简介</h2>
   <p class="para">
    <span class="classname"><strong class="classname">Yaf_Controller_Abstract</strong></span> 是 Yaf 系统的核心部分。
    MVC 是 Model-View-Controller（模型-视图-控制器）的缩写，
    是一种旨在分离应用逻辑与显示逻辑的设计模式。
   </p>
   <p class="para">
    每个自定义控制器都应当继承
    <span class="classname"><strong class="classname">Yaf_Controller_Abstract</strong></span>。
   </p>
   <p class="simpara">
    由于 <span class="methodname"><a href="yaf-controller-abstract.construct.php" class="methodname">Yaf_Controller_Abstract::__construct()</a></span>
    是由 Yaf 不带参数调用的，
    <span class="classname"><strong class="classname">Yaf_Controller_Abstract</strong></span> 提供了一个替代的
    类构造函数钩子：
    <span class="methodname"><a href="yaf-controller-abstract.init.php" class="methodname">Yaf_Controller_Abstract::init()</a></span>。
   </p>
   <p class="para">
    如果你在自定义控制器中定义了 init() 方法，
    那么当控制器被实例化时它将被调用。
   </p>
   <p class="para">
    动作（action）可以带参数。当请求到来时，如果经过路由之后
    请求参数（参见
    <span class="methodname"><a href="yaf-request-abstract.getparam.php" class="methodname">Yaf_Request_Abstract::getParam()</a></span>）中
    存在同名的变量，Yaf 将会把它们传递给动作方法
    （参见 <span class="methodname"><a href="yaf-action-abstract.execute.php" class="methodname">Yaf_Action_Abstract::execute()</a></span>）。
    <blockquote class="note"><p><strong class="note">注意</strong>: 
     <p class="simpara">
      这些参数是直接获取的，没有经过过滤，
      在使用之前应当仔细处理。
     </p>
    </p></blockquote>
   </p>
  </div>


  <div class="section" id="yaf-controller-abstract.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">abstract</span>
      <span class="modifier">class</span> <strong class="classname">Yaf_Controller_Abstract</strong>
     </span>
     {</div>

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

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-controller-abstract.php#yaf-controller-abstract.props.module">$<var class="varname">_module</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-controller-abstract.php#yaf-controller-abstract.props.name">$<var class="varname">_name</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-controller-abstract.php#yaf-controller-abstract.props.request">$<var class="varname">_request</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-controller-abstract.php#yaf-controller-abstract.props.response">$<var class="varname">_response</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-controller-abstract.php#yaf-controller-abstract.props.invoke-args">$<var class="varname">_invoke_args</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">protected</span>
      <var class="varname"><a href="class.yaf-controller-abstract.php#yaf-controller-abstract.props.view">$<var class="varname">_view</var></a></var>;</div>



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

    <div class="methodsynopsis dc-description"><span class="modifier">protected</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.display.php" class="methodname">display</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tpl</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$parameters</code><span class="initializer"> = ?</span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.forward.php" class="methodname">forward</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$action</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$parameters</code><span class="initializer"> = ?</span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getinvokearg.php" class="methodname">getInvokeArg</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"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getinvokeargs.php" class="methodname">getInvokeArgs</a></span>(): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getmodulename.php" class="methodname">getModuleName</a></span>(): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getname.php" class="methodname">getName</a></span>(): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getrequest.php" class="methodname">getRequest</a></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>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getresponse.php" class="methodname">getResponse</a></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-response-abstract.php" class="type Yaf_Response_Abstract">Yaf_Response_Abstract</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getview.php" class="methodname">getView</a></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-view-interface.php" class="type Yaf_View_Interface">Yaf_View_Interface</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.getviewpath.php" class="methodname">getViewpath</a></span>(): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.init.php" class="methodname">init</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.initview.php" class="methodname">initView</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$options</code><span class="initializer"> = ?</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-view-interface.php" class="type Yaf_View_Interface">Yaf_View_Interface</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.redirect.php" class="methodname">redirect</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$url</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">protected</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.render.php" class="methodname">render</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$tpl</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$parameters</code><span class="initializer"> = ?</span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><a href="yaf-controller-abstract.setviewpath.php" class="methodname">setViewpath</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$view_directory</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>

   }</div>


  </div>



  <div class="section" id="yaf-controller-abstract.props">
   <h2 class="title">属性</h2>
   <dl>
    
     <dt id="yaf-controller-abstract.props.actions"><var class="varname">actions</var></dt>
     <dd>
      <p class="para">
      你也可以通过使用此属性和 <span class="classname"><a href="class.yaf-action-abstract.php" class="classname">Yaf_Action_Abstract</a></span>
      在一个单独的 PHP 脚本中定义动作方法。
      <div class="example" id="example-1">
       <p><strong>示例 #1 在单独的文件中定义 action</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">IndexController </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Controller_Abstract </span><span style="color: #007700">{
    protected </span><span style="color: #0000BB">$actions </span><span style="color: #007700">= array(
        </span><span style="color: #FF8000">/** now dummyAction is defined in a separate file */
        </span><span style="color: #DD0000">"dummy" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"actions/Dummy_action.php"</span><span style="color: #007700">,
    );

    </span><span style="color: #FF8000">/* action method may have arguments */
    </span><span style="color: #007700">public function </span><span style="color: #0000BB">indexAction</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #0000BB">$id</span><span style="color: #007700">) {
       </span><span style="color: #FF8000">/* $name and $id are unsafe raw data */
       </span><span style="color: #0000BB">assert</span><span style="color: #007700">(</span><span style="color: #0000BB">$name </span><span style="color: #007700">== </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRequest</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getParam</span><span style="color: #007700">(</span><span style="color: #DD0000">"name"</span><span style="color: #007700">));
       </span><span style="color: #0000BB">assert</span><span style="color: #007700">(</span><span style="color: #0000BB">$id   </span><span style="color: #007700">== </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">_request</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getParam</span><span style="color: #007700">(</span><span style="color: #DD0000">"id"</span><span style="color: #007700">));
    }
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
        </div>

      </div>
      <div class="example" id="example-2">
       <p><strong>示例 #2 Dummy_action.php</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">DummyAction </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Action_Abstract </span><span style="color: #007700">{
    </span><span style="color: #FF8000">/* an action class shall define this method as the entry point */
    </span><span style="color: #007700">public function </span><span style="color: #0000BB">execute</span><span style="color: #007700">() {
    }
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
        </div>

      </div>
      </p>
     </dd>
    
    
     <dt id="yaf-controller-abstract.props.module"><var class="varname">_module</var></dt>
     <dd>
      <p class="simpara">
        该控制器所属的模块名。
      </p>
     </dd>
    
    
     <dt id="yaf-controller-abstract.props.name"><var class="varname">_name</var></dt>
     <dd>
      <p class="simpara">
        控制器名。
      </p>
     </dd>
    
    
     <dt id="yaf-controller-abstract.props.request"><var class="varname">_request</var></dt>
     <dd>
      <p class="simpara">
      当前的 <span class="classname"><a href="class.yaf-request-abstract.php" class="classname">Yaf_Request_Abstract</a></span> 对象。
      </p>
     </dd>
    
    
     <dt id="yaf-controller-abstract.props.response"><var class="varname">_response</var></dt>
     <dd>
      <p class="simpara">
      当前的 <span class="classname"><a href="class.yaf-response-abstract.php" class="classname">Yaf_Response_Abstract</a></span> 对象。
      </p>
     </dd>
    
    
     <dt id="yaf-controller-abstract.props.invoke-args"><var class="varname">_invoke_args</var></dt>
     <dd>
      <p class="simpara">
      通过 <span class="methodname"><a href="yaf-controller-abstract.forward.php" class="methodname">Yaf_Controller_Abstract::forward()</a></span>
      传递给动作的调用参数，是一个以参数名为键的数组。
      </p>
     </dd>
    
    
     <dt id="yaf-controller-abstract.props.view"><var class="varname">_view</var></dt>
     <dd>
      <p class="simpara">
      用于渲染视图的 <span class="classname"><a href="class.yaf-view-interface.php" class="classname">Yaf_View_Interface</a></span> 对象。
      </p>
     </dd>
    
   </dl>
  </div>



 </div>

 
















































































































<h2>目录</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-controller-abstract.construct.php">Yaf_Controller_Abstract::__construct</a> — Yaf_Controller_Abstract 的构造函数</li><li><a href="yaf-controller-abstract.display.php">Yaf_Controller_Abstract::display</a> — 渲染并直接显示视图</li><li><a href="yaf-controller-abstract.forward.php">Yaf_Controller_Abstract::forward</a> — 将当前请求转发到另一个动作</li><li><a href="yaf-controller-abstract.getinvokearg.php">Yaf_Controller_Abstract::getInvokeArg</a> — 获取一个动作调用参数</li><li><a href="yaf-controller-abstract.getinvokeargs.php">Yaf_Controller_Abstract::getInvokeArgs</a> — 获取全部动作调用参数</li><li><a href="yaf-controller-abstract.getmodulename.php">Yaf_Controller_Abstract::getModuleName</a> — 获取模块名</li><li><a href="yaf-controller-abstract.getname.php">Yaf_Controller_Abstract::getName</a> — 获取控制器名称</li><li><a href="yaf-controller-abstract.getrequest.php">Yaf_Controller_Abstract::getRequest</a> — 获取当前请求对象</li><li><a href="yaf-controller-abstract.getresponse.php">Yaf_Controller_Abstract::getResponse</a> — 获取当前响应对象</li><li><a href="yaf-controller-abstract.getview.php">Yaf_Controller_Abstract::getView</a> — 获取视图引擎</li><li><a href="yaf-controller-abstract.getviewpath.php">Yaf_Controller_Abstract::getViewpath</a> — 获取视图路径</li><li><a href="yaf-controller-abstract.init.php">Yaf_Controller_Abstract::init</a> — 控制器初始化钩子</li><li><a href="yaf-controller-abstract.initview.php">Yaf_Controller_Abstract::initView</a> — 初始化视图并返回</li><li><a href="yaf-controller-abstract.redirect.php">Yaf_Controller_Abstract::redirect</a> — 重定向到 URL</li><li><a href="yaf-controller-abstract.render.php">Yaf_Controller_Abstract::render</a> — 渲染视图模板</li><li><a href="yaf-controller-abstract.setviewpath.php">Yaf_Controller_Abstract::setViewpath</a> — 设置视图路径</li></ul>
</div>
<?php manual_footer($setup); ?>