响应对象逻辑上是请求对象的搭档.目的在于收集消息体和/或消息头,因而可能返回大批的结果。另外前端控制器可能传递任何异常到响应对象,允许开发人员优美的处理异常。可以通过设置 Zend_Controller_Front::throwExceptions(true)
覆盖这项功能:
$front->throwExceptions(true);
如果要发送响应输出包括消息头,使用sendResponse()
。
$response->sendResponse();
注意 | |
---|---|
默认地,前端控制器完成分发请求后调用 $front->returnResponse(true); $response = $front->dispatch(); // do some more processing, such as logging... // and then send the output: $response->sendResponse(); |
开发人员可以在动作控制器中使用响应对象。把结果写进响应对象,而不是直接渲染输出和发送消息头:
// Within an action controller action: // Set a header $this->getResponse() ->setHeader('Content-Type', 'text/html') ->appendBody($content);
这样做,可以在显示内容之前,将所有消息头一次发送。
注意 | |
---|---|
如果使用动作控制器的 视图集成(view integration),你不需要在相应对象中设置渲染的视图脚本,因为 |
如果程序中发生了异常,检查响应对象的isException()
标志,使用getException()
获取异常。此外,可以创建定制的响应对象重定向到错误页面,记录异常消息,漂亮的格式化异常消息等。
在前端控制器执行dispatch()后可以获得响应对象,或者请求前端控制器返回响应对象代替渲染输出。
// retrieve post-dispatch: $front->dispatch(); $response = $front->getResponse(); if ($response->isException()) { // log, mail, etc... } // Or, have the front controller dispatch() process return it $front->returnResponse(true); $response = $front->dispatch(); // do some processing... // finally, echo the response $response->sendResponse();
默认地,异常消息是不显示的。可以通过调用renderExceptions()
覆盖默认设置。或者启用前端控制器的throwExceptions():
$response->renderExceptions(true); $front->dispatch($request, $response); // or: $front->returnResponse(true); $response = $front->dispatch(); $response->renderExceptions(); $response->sendResponse(); // or: $front->throwExceptions(true); $front->dispatch();
如上文所述,响应对象的一项重要职责是收集和发出HTTP响应消息头,相应地存在大量的方法:
canSendHeaders()
用来判别消息头是否已发送,该方法带有一个可选的标志指示消息头已发出时是否抛出异常。可以通过设置headersSentThrowsException
属性为false
来覆盖默认设置。
setHeader($name, $value, $replace = false)
用来设置单独的消息头。默认的不会替换已经存在的同名消息头,但可以设置$replace
为true强制替换.
设置消息头前,该方法先检查canSendHeaders()
看操作是否允许,并请求抛出异常。
setRedirect($url, $code = 302)
设置HTTP定位消息头准备重定向,如果提供HTTP状态码,重定向将会使用该状态码。
其内部调用setHeader()
并使$replace
标志呈打开状态确保只发送一次定位消息头。
getHeaders()
返回一个消息头数组,每个元素都是一个带有'name'和'value'键的数组。
clearHeaders()
清除所有注册的键值消息头。
setRawHeader()
设置没有键值对的原始消息头,比如HTTP状态消息头。
getRawHeaders()
返回所有注册的原始消息头。
clearRawHeaders()
清除所有的原始消息头。
clearAllHeaders()
清除所有的消息头,包括原始消息头和键值消息头。
除了上述方法,还有获取和设置当前请求HTTP响应码的访问器, setHttpResponseCode()
和 getHttpResponseCode()
.
相应对象支持“命名片段”。允许你将消息体分割成不同的片段,并呈一定顺序排列。因此输出的是以特定次序返回的。在其内部,主体内容被存储为一个数组,大量的访问器方法可以用来指示数组内位置和名称。
举例来说,你可以使用preDispatch()
钩子来向响应对象中加入页头,然后在动作控制器中加入主体内容,最后在postDispatch()
钩子中加入页脚。
// Assume that this plugin class is registered with the front controller class MyPlugin extends Zend_Controller_Plugin_Abstract { public function preDispatch(Zend_Controller_Request_Abstract $request) { $response = $this->getResponse(); $view = new Zend_View(); $view->setBasePath('../views/scripts'); $response->prepend('header', $view->render('header.phtml')); } public function postDispatch(Zend_Controller_Request_Abstract $request) { $response = $this->getResponse(); $view = new Zend_View(); $view->setBasePath('../views/scripts'); $response->append('footer', $view->render('footer.phtml')); } } // a sample action controller class MyController extends Zend_Controller_Action { public function fooAction() { $this->render(); } }
上面的例子中,调用/my/foo
会使得最终响应对象中的内容呈现下面的结构:
array( 'header' => ..., // header content 'default' => ..., // body content from MyController::fooAction() 'footer' => ... // footer content );
渲染响应时,会按照数组中元素顺序来渲染。
大量的方法可以用来处理命名片段:
setBody()
和 appendBody()
都允许传入一个$name
参数,指示一个命名片段。如果提供了这个参数,将会覆盖指定的命名片段,如果该片段不存在就创建一个。如果没有传入$name
参数到setBody()
,将会重置整个主体内容。如果没有传入$name
参数到appendBody()
,内容被附加到'default'命名片段。
prepend($name, $content)
将创建一个$name
命名片段并放置在数组的开始位置。如果该片段存在,将首先移除。
append($name, $content)
将创建一个$name
命名片段,并放置在数组的结尾位置。 如果该片段存在,将首先移除。
insert($name, $content, $parent = null, $before = false)
将创建一个$name
命名片段。如果提供$parent
参数,新的片段视$before
的值决定放置在 $parent
的前面或者后面。如果该片段存在,将首先移除。
clearBody($name = null)
如果$name
参数提供,将删除该片段,否则删除全部。
getBody($spec = false)
如果$spec
参数为一个片段名称,将可以获取到该字段。若$spec
参数为false,将返回字符串格式的命名片段顺序链。如果$spec
参数为true,返回主体内容数组。
如上文所述,默认的,分发过程中的异常发生会在响应对象中注册。异常会注册在一个堆中,允许你抛出所有异常--程序异常,分发异常,插件异常等。如果你要检查或者记录特定的异常,你可能想要使用响应对象的异常API:
setException(Exception $e)
注册一个异常。
isException()
判断该异常是否注册。
getException()
返回整个异常堆。
hasExceptionOfType($type)
判断特定类的异常是否在堆中。
hasExceptionOfMessage($message)
判断带有指定消息的异常是否在堆中。
hasExceptionOfCode($code)
判断带有指定代码的异常是否在堆中。
getExceptionByType($type)
获取堆中特定类的所有异常。如果没有则返回false,否则返回数组。
getExceptionByMessage($message)
获取堆中带有特定消息的所有异常。如果没有则返回false,否则返回数组。
getExceptionByCode($code)
获取堆中带有特定编码的所有异常。如果没有则返回false,否则返回数组。
renderExceptions($flag)
设置标志指示当发送响应时是否发送其中的异常。