Reference

In This Article

The SendResponse Event

zend-mvc defines and utilizes a custom Zend\EventManager\Event for updating the response object prior to emitting it, Zend\Mvc\ResponseSender\SendResponseEvent. The event allows listeners to set response headers and content.

The methods it defines are:

  • setResponse($response)
  • getResponse()
  • setContentSent()
  • contentSent()
  • setHeadersSent()
  • headersSent()

Listeners

Currently, three listeners are listening to this event at different priorities based on which listener is used most.

Class Priority Method Called Description
Zend\Mvc\SendResponseListener\PhpEnvironmentResponseSender -1000 __invoke This is used in HTTP contexts (this is the most often used).
Zend\Mvc\SendResponseListener\ConsoleResponseSender -2000 __invoke This is used in console contexts.
Zend\Mvc\SendResponseListener\SimpleStreamResponseSender -3000 __invoke

Because each listener has negative priority, adding your own logic to modify the Response involves adding a new listener without priority (as priority defaults to 1); thus, your own listener will execute before any of the defaults.

Triggered By

This event is executed when the MvcEvent::FINISH event is triggered, with a priority of -10000.

Found a mistake or want to contribute to the documentation? Edit this page on GitHub!