| Current Path : /home/rtorresani/www/vendor/laminas/laminas-mvc/src/ |
| Current File : //home/rtorresani/www/vendor/laminas/laminas-mvc/src/SendResponseListener.php |
<?php
namespace Laminas\Mvc;
use Laminas\EventManager\AbstractListenerAggregate;
use Laminas\EventManager\EventManager;
use Laminas\EventManager\EventManagerAwareInterface;
use Laminas\EventManager\EventManagerInterface;
use Laminas\Mvc\ResponseSender\HttpResponseSender;
use Laminas\Mvc\ResponseSender\PhpEnvironmentResponseSender;
use Laminas\Mvc\ResponseSender\SendResponseEvent;
use Laminas\Mvc\ResponseSender\SimpleStreamResponseSender;
use Laminas\Stdlib\ResponseInterface as Response;
class SendResponseListener extends AbstractListenerAggregate implements
EventManagerAwareInterface
{
/**
* @var SendResponseEvent
*/
protected $event;
/**
* @var EventManagerInterface
*/
protected $eventManager;
/**
* Inject an EventManager instance
*
* @param EventManagerInterface $eventManager
* @return SendResponseListener
*/
public function setEventManager(EventManagerInterface $eventManager)
{
$eventManager->setIdentifiers([
self::class,
$this::class,
]);
$this->eventManager = $eventManager;
$this->attachDefaultListeners();
return $this;
}
/**
* Retrieve the event manager
*
* Lazy-loads an EventManager instance if none registered.
*
* @return EventManagerInterface
*/
public function getEventManager()
{
if (! $this->eventManager instanceof EventManagerInterface) {
$this->setEventManager(new EventManager());
}
return $this->eventManager;
}
/**
* Attach the aggregate to the specified event manager
*
* @param EventManagerInterface $events
* @param int $priority
* @return void
*/
public function attach(EventManagerInterface $events, $priority = 1)
{
$this->listeners[] = $events->attach(MvcEvent::EVENT_FINISH, [$this, 'sendResponse'], -10000);
}
/**
* Send the response
*
* @return void
*/
public function sendResponse(MvcEvent $e)
{
$response = $e->getResponse();
if (! $response instanceof Response) {
return; // there is no response to send
}
$event = $this->getEvent();
$event->setResponse($response);
$event->setTarget($this);
$this->getEventManager()->triggerEvent($event);
}
/**
* Get the send response event
*
* @return SendResponseEvent
*/
public function getEvent()
{
if (! $this->event instanceof SendResponseEvent) {
$this->setEvent(new SendResponseEvent());
}
return $this->event;
}
/**
* Set the send response event
*
* @return SendResponseEvent
*/
public function setEvent(SendResponseEvent $e)
{
$this->event = $e;
return $this;
}
/**
* Register the default event listeners
*
* The order in which the response sender are listed here, is by their usage:
* PhpEnvironmentResponseSender has highest priority, because it's used most often.
* SimpleStreamResponseSender is not used that often, so has a lower priority.
* You can attach your response sender before or after every default response sender implementation.
* All default response sender implementation have negative priority.
* You are able to attach listeners without giving a priority and your response sender would be first to try.
*
* @return SendResponseListener
*/
protected function attachDefaultListeners()
{
$events = $this->getEventManager();
$events->attach(SendResponseEvent::EVENT_SEND_RESPONSE, new PhpEnvironmentResponseSender(), -1000);
$events->attach(SendResponseEvent::EVENT_SEND_RESPONSE, new SimpleStreamResponseSender(), -3000);
$events->attach(SendResponseEvent::EVENT_SEND_RESPONSE, new HttpResponseSender(), -4000);
}
}