這篇文章主要介紹了Zend Framework教程之前端控制器Zend_Controller_Front用法,詳細分析了前端控制器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();擷取執行個體即可。
以上就是本文的全部內容,希望對大家的學習有所協助,更多相關內容請關注topic.alibabacloud.com!