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