Zend Framework教學之前端控制器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('../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');

   

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('../application/controllers');

   

環境存取器方法

除了上面所列的方法以外，還有很多訪問器方法可以影響前端控制器環境 —— 因而也影響前端控制器代理（delegate）的類別的環境。

resetInstance()方法清除目前的所有設定。主要用來測試，不過，在希望將幾個前端控制器連鎖的地方也是很有用的（but it can also be used for instances where you wish to chain together multiple front controllers）。

(set|get)DefaultControllerName()方法可以為預設的控制器指定另外一個名字（否則使用'index'），以及取得目前值。它們將代理分發器。

(set|get)DefaultAction()方法可以為預設的動作指定另外一個名字（否則使用'index'）,以及取得目前值。它們將代理分發器。

(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();获取实例即可。

希望本文所述对大家PHP程序设计有所帮助。

更多Zend Framework教程之前端控制器Zend_Controller_Front用法详解相关文章请关注PHP中文网！