ExceptionEvent.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  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\HttpFoundation\Request;
  12. use Symfony\Component\HttpKernel\HttpKernelInterface;
  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 setThrowable() 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. final class ExceptionEvent extends RequestEvent
  27. {
  28. private \Throwable $throwable;
  29. private bool $allowCustomResponseCode = false;
  30. public function __construct(
  31. HttpKernelInterface $kernel,
  32. Request $request,
  33. int $requestType,
  34. \Throwable $e,
  35. private bool $isKernelTerminating = false,
  36. ) {
  37. parent::__construct($kernel, $request, $requestType);
  38. $this->setThrowable($e);
  39. }
  40. public function getThrowable(): \Throwable
  41. {
  42. return $this->throwable;
  43. }
  44. /**
  45. * Replaces the thrown exception.
  46. *
  47. * This exception will be thrown if no response is set in the event.
  48. */
  49. public function setThrowable(\Throwable $exception): void
  50. {
  51. $this->throwable = $exception;
  52. }
  53. /**
  54. * Mark the event as allowing a custom response code.
  55. */
  56. public function allowCustomResponseCode(): void
  57. {
  58. $this->allowCustomResponseCode = true;
  59. }
  60. /**
  61. * Returns true if the event allows a custom response code.
  62. */
  63. public function isAllowingCustomResponseCode(): bool
  64. {
  65. return $this->allowCustomResponseCode;
  66. }
  67. public function isKernelTerminating(): bool
  68. {
  69. return $this->isKernelTerminating;
  70. }
  71. }