GetResponseForExceptionEvent.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpKernel\Event;
  11. use Symfony\Component\HttpKernel\HttpKernelInterface;
  12. use Symfony\Component\HttpFoundation\Request;
  13. /**
  14. * Allows to create a response for a thrown exception
  15. *
  16. * Call setResponse() to set the response that will be returned for the
  17. * current request. The propagation of this event is stopped as soon as a
  18. * response is set.
  19. *
  20. * You can also call setException() to replace the thrown exception. This
  21. * exception will be thrown if no response is set during processing of this
  22. * event.
  23. *
  24. * @author Bernhard Schussek <bschussek@gmail.com>
  25. *
  26. * @api
  27. */
  28. class GetResponseForExceptionEvent extends GetResponseEvent
  29. {
  30. /**
  31. * The exception object
  32. * @var \Exception
  33. */
  34. private $exception;
  35. public function __construct(HttpKernelInterface $kernel, Request $request, $requestType, \Exception $e)
  36. {
  37. parent::__construct($kernel, $request, $requestType);
  38. $this->setException($e);
  39. }
  40. /**
  41. * Returns the thrown exception
  42. *
  43. * @return \Exception The thrown exception
  44. *
  45. * @api
  46. */
  47. public function getException()
  48. {
  49. return $this->exception;
  50. }
  51. /**
  52. * Replaces the thrown exception
  53. *
  54. * This exception will be thrown if no response is set in the event.
  55. *
  56. * @param \Exception $exception The thrown exception
  57. *
  58. * @api
  59. */
  60. public function setException(\Exception $exception)
  61. {
  62. $this->exception = $exception;
  63. }
  64. }