Zend\Mvc\MvcEvent繼承自Zend\EventManager\Event,在Zend\Mvc\Application::bootstrap()執行時觸發。如果你的控制器實現了Zend\Mvc\InjectApplicationEventInterface,MvcEvent將會被注入到這些控制器中。
MvcEvent會為下列對象添加獲取器和規則:Application、Request、Response、Router、RouterMatch、Result(通常為調度控制器的結果)、ViewModel(一般展示了視圖模型布局)。Application、Request、Response、Router和ViewModel都是在bootstrap事件過程中注入。接下來的route事件會被注入RouteMatch對象,用來封裝routing的結果。RouteMatch對象在整個MVC中都會使用,所以通常會通過RouteMatch獲取Route、Request、Response對象。
MvcEvent還定義了如下方法:
setApplication($application) getApplication() setRequest($request) getRequest() setResponse($reponse) getResponse() setRouter($router) getRouter() setRouteMatch($routeMatch) getRouteMatch() setResult() getResult() setViewModel($viewModel) getViewModel() isError() setError() getError() getController() setController($name) getControllerClass() setControllerClass($class)
事件被觸發的順序:
Name Constant Description bootstrap MvcEvent::EVENT_BOOTSTRAP 通過創建ViewManager來引導application route MvcEvent::EVENT_ROUTE 執行路由(或者路由相關的行為) dispatch MvcEvent::EVENT_DISPATCH 將匹配到的路由調度給相應的控制器/行為 dispatch.error MvcEvent::EVENT_DISPATCH_ERROR 當調度過程中發生錯誤時會被觸發 render MvcEvent::EVENT_RENDER 准備數據並將渲染任務委托給視圖層 render.error MvcEvent::EVENT_RENDER_ERROR render過程錯誤發生時觸發 finish MvcEvent::EVENT_FINISH 一旦所有的事情完成後,本事件觸發完成相應的任務
詳細介紹:
MvcEvent::EVENT_BOOTSTRAP("bootstrap")
監聽器:Zend\Mvc\View\Http\ViewManager,onBootstrap方法會被調用。
作用:准備好視圖層(也就是實例化Zend\Mvc\View\Http\ViewManager)。
觸發方式:Zend\Mvc\Application bootstrap()方法。
MvcEvent::EVENT_ROUTE("route")
監聽器1:Zend\Mvc\ModuleRouteListener::onRoute
作用:決定了模塊命名空間是否應該添加在控制器名字前面,主要是防止路由匹配包含的參數鍵匹配到了MODULE_NAMESPACE常量
監聽器2:Zend\Mvc\RouteListener::onRoute 如果沒有路由沒有匹配到MvcEvent::EVENT_DISPATCH_ERROR會被觸發。
作用:嘗試將request匹配到路由器,並返回一個RouteMatch對象。
觸發方式:Zend\Mvc\Application::run
作用:如果路由過程中有錯誤發生,將會使用一個短回路的回調來停止事件持續傳播。
MvcEvent::EVENT_DISPATCH("dispatch")
監聽器分為兩類:一類時只限於控制台環境,還有一類只限於HTTP環境,還有全壞境適用的監聽器。本文不介紹CONSOLE環境。console環境可以查看官方文檔。
類Zend\Mvc\View\Http\CreateViewModelListener裡面有兩個函數作為本事件的監聽器:
1、createViewModelFromArray(如果控制器行為返回一個關聯數組,該監聽器將數組轉化為一個ViewModel對象。
2、createViewModelFromNull(控制器返回的時一個空值,則該方法將其轉化為一個ViewModel對象)
類Zend\Mvc\View\Http\RouteNotFoundStrategy::prepareNotFoundViewModel 創建並返回一個404ViewModel
類Zend\Mvc\View\Http\InjectTemplateListener::injectTemplate 把一個模版注入到視圖模型中。模版名繼承自路由匹配的控制器名(或是控制器裡的action)
類Zend\Mvc\View\Http\InjectViewModelListener::injectViewModel 插入一個ViewModel並添加至MvcEvent對象。有兩種情況:a)作為子對象加入,包含view model。b)結果可終止的情況下替換掉默認情況
類Zend\Mvc\MiddlewareListener::onDispatch會觸發MvcEvent::EVENT_DISPATCH_ERROR,從service manager裡面加載並調度匹配到的PSR-7中間件。
類Zend\Mvc\DispatchListener::onDispatch會觸發MvcEvent::EVENT_DISPATCH_ERROR作用同上。
類Zend\Mvc\Controller\AbstractController::onDispatch本方法是一個抽象類。
觸發方式:
Zend\Mvc\Application::run使用短回路的回調來終止事件的傳播。(路由時有錯誤發生時)
Zend\Mvc\Controller\AbstractController::dispatch如果有監聽器返回一個Response對象,將終止事件傳播。每當AbstractController監聽本事件的時候,被觸發時都會調用onDispatch方法。
MvcEvent::EVENT_RENDER("render")
監聽器:
Zend\Mvc\View\Console\DefaultRenderingStrategy::render 用來渲染視圖
Zend\Mvc\View\Http\DefaultRenderingStrategy::render同樣渲染視圖,注意和上面的環境區別
觸發方式:
Zend\Mvc\Application::competeRequest本事件在MvcEvent::FINISH觸發前觸發。
MvcEvent::EVENT_FINISH("finish")
監聽器:
Zend\Mvc\SendResponseListener::sendResponse觸發SendResponseEvent來准備response。
觸發方式:
Zend\Mvc\Application::run 一旦MvcEvent::ROUTE或MvcEvent::DISPATCH事件返回了一個正確的ResponseInterface就會觸發本事件
Zend\Mvc\Application::completeRequest觸發在MvcEvent::RENDER之後(也就是說,此時視圖已經被渲染了)。
關於SendResponse事件
Zend\Mvc\ResponseSender\SendResponseEvent定義了如下方法:
setResponse($response)
getResponse()
setContentSent()
contentSent()
setHeadersSent()
headersSent()
這些方法用來設置應答頭和應答內容。
監聽器:
Zend\Mvc\SendResponseListener\PhpEnvironmentResponseSender::__invoke 使用環境HTTP
Zend\Mvc\SendResponseListener\ConsoleResponseSender::__invoke使用環境為console。
Zend\Mvc\SendResponseListener\SimpleStreamResponseSender::__invoke
MvcEvent::FINISH事件被觸發後本事件執行