annotate vendor/symfony/http-kernel/Event/GetResponseForExceptionEvent.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children 1fec387a4317
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\HttpKernel\HttpKernelInterface;
Chris@0 15 use Symfony\Component\HttpFoundation\Request;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Allows to create a response for a thrown exception.
Chris@0 19 *
Chris@0 20 * Call setResponse() to set the response that will be returned for the
Chris@0 21 * current request. The propagation of this event is stopped as soon as a
Chris@0 22 * response is set.
Chris@0 23 *
Chris@0 24 * You can also call setException() to replace the thrown exception. This
Chris@0 25 * exception will be thrown if no response is set during processing of this
Chris@0 26 * event.
Chris@0 27 *
Chris@0 28 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 29 */
Chris@0 30 class GetResponseForExceptionEvent extends GetResponseEvent
Chris@0 31 {
Chris@0 32 /**
Chris@0 33 * The exception object.
Chris@0 34 *
Chris@0 35 * @var \Exception
Chris@0 36 */
Chris@0 37 private $exception;
Chris@0 38
Chris@0 39 public function __construct(HttpKernelInterface $kernel, Request $request, $requestType, \Exception $e)
Chris@0 40 {
Chris@0 41 parent::__construct($kernel, $request, $requestType);
Chris@0 42
Chris@0 43 $this->setException($e);
Chris@0 44 }
Chris@0 45
Chris@0 46 /**
Chris@0 47 * Returns the thrown exception.
Chris@0 48 *
Chris@0 49 * @return \Exception The thrown exception
Chris@0 50 */
Chris@0 51 public function getException()
Chris@0 52 {
Chris@0 53 return $this->exception;
Chris@0 54 }
Chris@0 55
Chris@0 56 /**
Chris@0 57 * Replaces the thrown exception.
Chris@0 58 *
Chris@0 59 * This exception will be thrown if no response is set in the event.
Chris@0 60 *
Chris@0 61 * @param \Exception $exception The thrown exception
Chris@0 62 */
Chris@0 63 public function setException(\Exception $exception)
Chris@0 64 {
Chris@0 65 $this->exception = $exception;
Chris@0 66 }
Chris@0 67 }