annotate vendor/symfony/http-kernel/Event/GetResponseEvent.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\HttpKernel\Event;
Chris@0 13
Chris@0 14 use Symfony\Component\HttpFoundation\Response;
Chris@0 15
Chris@0 16 /**
Chris@0 17 * Allows to create a response for a request.
Chris@0 18 *
Chris@0 19 * Call setResponse() to set the response that will be returned for the
Chris@0 20 * current request. The propagation of this event is stopped as soon as a
Chris@0 21 * response is set.
Chris@0 22 *
Chris@0 23 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 24 */
Chris@0 25 class GetResponseEvent extends KernelEvent
Chris@0 26 {
Chris@0 27 private $response;
Chris@0 28
Chris@0 29 /**
Chris@0 30 * Returns the response object.
Chris@0 31 *
Chris@17 32 * @return Response|null
Chris@0 33 */
Chris@0 34 public function getResponse()
Chris@0 35 {
Chris@0 36 return $this->response;
Chris@0 37 }
Chris@0 38
Chris@0 39 /**
Chris@0 40 * Sets a response and stops event propagation.
Chris@0 41 */
Chris@0 42 public function setResponse(Response $response)
Chris@0 43 {
Chris@0 44 $this->response = $response;
Chris@0 45
Chris@0 46 $this->stopPropagation();
Chris@0 47 }
Chris@0 48
Chris@0 49 /**
Chris@0 50 * Returns whether a response was set.
Chris@0 51 *
Chris@0 52 * @return bool Whether a response was set
Chris@0 53 */
Chris@0 54 public function hasResponse()
Chris@0 55 {
Chris@0 56 return null !== $this->response;
Chris@0 57 }
Chris@0 58 }