Zend_Controller_Front实现了» 模型-视图-控制器 (MVC)应用程序的» 前端控制器模式。目的在于初始化请求环境,并路由到来的请求,接着分发任何发现的动作;收集所有的响应,在整个过程完成时就其返回。

Zend_Controller_Front也实现了» 单件(Singleton)模式,意味着任何时候,都只可能有一个有效实例。这使得它可以作为注册表,供分发过程中的其他对象引用。

Zend_Controller_Front自己注册了一个插件经纪人(plugin broker),允许插件观测它所触发的各种事件。大多数情况下,这将使得开发人员有机会裁剪站点的分发过程,而无需通过扩展前端控制器增加功能。

前端控制器最至少需要一个或多个包含动作控制器的目录的路径来完成工作。还有大量的方法可供调用,进一步裁剪前端控制器以及它的助手类环境。

主要方法

前端控制器有很多建立其环境的访问器。但是,有三个是开启前端控制器功能的主要方法:

getInstance()

getInstance()方法用来获取前端控制器实例。因为前端控制器实现了单件模式,这可能是唯一创建前端控制器对象的方法。

$front = Zend_Controller_Front::getInstance();

setControllerDirectory() 和 addControllerDirectory()

setControllerDirectory()通知分发器到哪查找动作控制器action controller类文件。参数接受单一路径和模块/路径对关联数组。

例如:

$front->setControllerDirectory('../application/controllers');
$front->setControllerDirectory(array(
    'default' => '../application/controllers',
    'blog'    => '../modules/blog/controllers',
    'news'    => '../modules/news/controllers',
));

// Add a 'foo' module directory:
$front->addControllerDirectory('../modules/foo/controllers', 'foo');

addModuleDirectory() and getModuleDirectory()

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

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

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

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

dispatch()

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

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

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

分发过程有三个不同的事件:

1) 路由(Routing)

2) 分发(Dispatching)

3) 响应(Response)

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

run()

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

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

// Instantiate front controller, set controller directory, and dispatch in one
// easy step:
Zend_Controller_Front::run('../application/controllers');

前端控制器参数

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

1) setParam($name, $value)方法设定值为$value的单个参数$name

2) setParams(array $params)方法通过关联数组一次设定多个参数。

3) getParam($name)方法通过$name标识符获取单个参数。

4) getParams()方法一次获取整个参数列表。

5) clearParams()方法可以清空一个参数(传入单个字符串标识符),清空多个参数(传入字符串标识符数组),清空整个参数栈(不传入参数)。

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

1) useDefaultControllerAlways用来提示 分发器遇到无法分发的请求时使用默认模块的默认控制器。这默认是关闭的。阅读可能遭遇的MVC异常获得使用该设定的更详尽信息。

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

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

4) 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实例 —— 这对于一些可替换的路由器和视图助手非常有用。

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