ZendFramework教程之前端控制器Zend_Controller_Front用法详解

本文实例讲述了Zend Framework教程之前端控制器Zend_Controller_Front用法。分享给大家供大家参考，具体如下：

主要功能

ZendFramework的MVC实现的核心机制是通过Zend_Controller_Front前端控制器，用于初始化请求环境，处理请求，路由分发，完成响应操作，Zend_Controller_Front采用的单例模式，所以一个应用只有一个前端控制器。如果需要前端控制器提供一些特殊功能，可以继承Zend_Controller_Front自定义前端控制器。

主要方法

getInstance()

用来获取前端控制器实例。创建前端控制器对象的唯一方法。

$frOnt= Zend_Controller_Front::getInstance();

setControllerDirectory() 和 addControllerDirectory()

setControllerDirectory()设置动作控制器action controller类文件的存放位置。参数可以是路径字符串或者关联数组。

例如：

//路径是相对于应用的/application目录下
// 字符串
$front->setControllerDirectory(&＃39;../application/controllers&＃39;);
// 关联数组
$front->setControllerDirectory(array(
  &＃39;default&＃39; => &＃39;../application/controllers&＃39;,
  &＃39;blog&＃39;  => &＃39;../modules/blog/controllers&＃39;,
  &＃39;news&＃39;  => &＃39;../modules/news/controllers&＃39;,
));
// Add a &＃39;foo&＃39; module directory:
$front->addControllerDirectory(&＃39;../modules/foo/controllers&＃39;, &＃39;foo&＃39;);

Note: 如果使用addControllerDirectory()时不带模块名，将会为default模块设定目录——如果目录已设定，就覆盖掉。

可以通过getControllerDirectory()获取控制器目录的当前设置；它将返回一个模块/目录对关联数组。

addModuleDirectory() 和 getModuleDirectory()

前端控制器的一个功能是你可以 定义一个模块目录结构 来创建独立的组件，被叫做“模块”。

每个模块位于自己的目录并和缺省模块的目录结构一样 － 例如，它至少 有个 "controllers" 字目录和 "views" 子目录以及其它应用子目录。

addModuleDirectory() 让你传递一个包含一个或多个模块目录的目录名。 然后进行扫描并把它们作为控制器目录添加到前端控制器。

然后，如果你想确定特定模块或当前模块路径，调用 getModuleDirectory()， 可选地传递模块名来获得模块目录。

dispatch()

dispatch(Zend_Controller_Request_Abstract $request = null, Zend_Controller_Response_Abstract $respOnse= null)完成前端控制器最繁重的工作。该方法带有可选的参数请求对象和/或响应对象，允许开发人员为每一个传入定制的对象。

如果没有请求或者响应对象传入，dispatch()将检查先前注册的对象并使用，如果没有发现则创建默认的对象版本（它们两个都默认使用HTTP对象）。

类似的，dispatch()先检查已注册的路由器（router）和分发器（dispatcher）对象，如果没有发现则实例化它们的默认版本。

分发过程有三个不同的事件：路由（Routing）、分发（Dispatching）、响应（Response）

路由只发生一次，当调用dispatch()时利用请求对象中的值。分发发生在一个循环中;请求可能指示分发多个动作，或者控制器或插件可能重置请求对象，强制分发附加的动作。所有都完成后，前端控制器返回响应对象。

run()

Zend_Controller_Front::run($path)是静态方法，只带一个参数，就是指向包含控制器的目录的路径。它首先通过getInstance()获取前端控制器实例，然后通过setControllerDirectory()注册传入的路径，最后分发。

基本上，如果不要求定制前端控制器环境，run()是一个很方便的建立前端控制器环境的方法。

Zend_Controller_Front::run(&＃39;../application/controllers&＃39;);

环境访问器方法

除了上面所列的方法以外，还有很多访问器方法可以影响前端控制器环境 —— 因而也影响前端控制器代理（delegate）的类的环境。

resetInstance()方法清除当前的所有设置。主要用来测试，不过，在希望将几个前端控制器连锁的地方也是很有用的（but it can also be used for instances where you wish to chain together multiple front controllers）。

(set|get)DefaultControllerName()方法可以为默认的控制器指定另外一个名字（否则使用&＃39;index&＃39;），以及获取当前值。它们将代理分发器。

(set|get)DefaultAction()方法可以为默认的动作指定另外一个名字（否则使用&＃39;index&＃39;）,以及获取当前值。它们将代理分发器。

(set|get)Request()方法指定分发过程中使用的请求类或对象，以及获取当前的请求对象。设置请求对象时，可以传入一个请求类的名字，该方法将加载类文件并创建实例。

(set|get)Router()方法指定分发过程中使用的路由器类或对象，以及获取当前对象。设置路由器时，可以传入一个路由器类的名字，该方法将加载类文件并创建实例。

获取路由器对象的时候，首先检查是否已有一个，如果没有，创建默认的路由器实例（rewrite路由器）。

(set|get)BaseUrl()方法指定路由请求时剥离（strip）的基地址（base URL），以及获取当前值。这个值将在路由前提供给路由器。

(set|get)Dispatcher()方法指定分发过程中使用的分发器类或对象，以及获取当前对象。设定分发器对象时，可以传入一个分发器类的名字，该方法将加载类文件并创建实例。

获取分发器对象时，首先检查是否已有一个存在，如果没有，将创建一个默认的分发器实例。

(set|get)Response()方法指定分发过程中使用的响应类或对象，已经获取当前对象。设定响应对象时，可以传入一个响应类的名字，该方法将加载类文件并创建实例。

registerPlugin(Zend_Controller_Plugin_Abstract $plugin, $stackIndex = null)方法允许注册一个插件对象。通过设置可选参数$stackIndex，插件执行的顺序。

unregisterPlugin($plugin)方法移除插件对象。$plugin可以是一个插件对象或者代表移除插件类的字符串。

throwExceptions($flag)方法用来开启或者关闭分发过程中抛出异常的能力。默认的，异常引起并放置在响应对象中；开启throwExceptions()将覆盖这一行为。

returnResponse($flag)方法通知前端控制器是否从dispatch()中返回请求对象（true），否则自动发送响应对象（false—）。默认的，响应对象被自动发送（通过调用Zend_Controller_Response_Abstract::sendResponse()）；开启returnResponse()将覆盖这一行为。

返回响应对象的原因包括希望在发送响应前检查异常，记录响应的各种属性（例如消息头）等等。

前端控制器参数

介绍里曾提到前端控制器可以用作各种控制器组件的注册表。它通过一个"param"家族的方法来做到这些。这些方法允许通过前端控制器注册任意类型的数据 —— 对象和变量，可以在分发链中的任何时候获取。这些变量被传递到路由器，分发器，以及动作控制器。这些方法包括：

setParam($name, $value)方法设定值为$value的单个参数$name。
setParams(array $params)方法通过关联数组一次设定多个参数。
getParam($name)方法通过$name标识符获取单个参数。
getParams()方法一次获取整个参数列表。
clearParams()方法可以清空一个参数（传入单个字符串标识符），清空多个参数（传入字符串标识符数组），清空整个参数栈（不传入参数）。

有几个预定义的参数可供设定，它们在分发链中有特别的用途：

useDefaultControllerAlways用来提示 分发器遇到无法分发的请求时使用默认模块的默认控制器。这默认是关闭的。

阅读可能遭遇的MVC异常获得使用该设定的更详尽信息。

disableOutputBuffering用来提示 is used to hint to 分发器不使用输出缓冲来捕捉动作控制器产生的输出。默认的，分发器捕捉任何输出并追加到响应对象的主体内容。

noViewRenderer用来禁用ViewRenderer。设定该参数为true可以禁用该助手。

noErrorHandler 用来禁用错误处理器插件。设定该参数为true可以禁用该插件。

自定义前端控制器

要继承前端控制器，至少需要覆盖getInstance()方法：

class My_Controller_Front extends Zend_Controller_Front
{
  public static function getInstance()
  {
    if (null === self::$_instance) {
      self::$_instance = new self();
    }
    return self::$_instance;
  }
}

覆盖getInstance()保证后面调用Zend_Controller_Front::getInstance()会返回子类的实例，而不是Zend_Controller_Front实例，这对于一些可替换的路由器和视图助手非常有用。

通常不需要继承前端控制器，除非你需要增加新的功能（比如，一个插件自动加载器，或者一个方法来指定动作助手路径）。你想要改动的地方可能包括修改控制器目录的存储方式，使用的默认路由器以及分发器。

ZendFramewrok提供的默认前端控制器已经足够我们使用了，通过Bootstrap功能，完全没有必要手动编写代码改变Zend_Controller_Front的默认机制。所以通常情况下Zend_Controller_Front对于应用来说是不存在。如果需要使用Zend_Controller_Front提供的功能，通过Zend_Controller_Front::getInstance();获取实例即可。