GetResponseForExceptionEvent.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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. class GetResponseForExceptionEvent extends GetResponseEvent
  27. {
  28. /**
  29. * The exception object.
  30. *
  31. * @var \Exception
  32. */
  33. private $exception;
  34. /**
  35. * @var bool
  36. */
  37. private $allowCustomResponseCode = false;
  38. public function __construct(HttpKernelInterface $kernel, Request $request, $requestType, \Exception $e)
  39. {
  40. parent::__construct($kernel, $request, $requestType);
  41. $this->setException($e);
  42. }
  43. /**
  44. * Returns the thrown exception.
  45. *
  46. * @return \Exception The thrown exception
  47. */
  48. public function getException()
  49. {
  50. return $this->exception;
  51. }
  52. /**
  53. * Replaces the thrown exception.
  54. *
  55. * This exception will be thrown if no response is set in the event.
  56. *
  57. * @param \Exception $exception The thrown exception
  58. */
  59. public function setException(\Exception $exception)
  60. {
  61. $this->exception = $exception;
  62. }
  63. /**
  64. * Mark the event as allowing a custom response code.
  65. */
  66. public function allowCustomResponseCode()
  67. {
  68. $this->allowCustomResponseCode = true;
  69. }
  70. /**
  71. * Returns true if the event allows a custom response code.
  72. *
  73. * @return bool
  74. */
  75. public function isAllowingCustomResponseCode()
  76. {
  77. return $this->allowCustomResponseCode;
  78. }
  79. }