ExceptionEvent.php 1.9 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\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(HttpKernelInterface $kernel, Request $request, int $requestType, \Throwable $e)
  31. {
  32. parent::__construct($kernel, $request, $requestType);
  33. $this->setThrowable($e);
  34. }
  35. public function getThrowable(): \Throwable
  36. {
  37. return $this->throwable;
  38. }
  39. /**
  40. * Replaces the thrown exception.
  41. *
  42. * This exception will be thrown if no response is set in the event.
  43. */
  44. public function setThrowable(\Throwable $exception): void
  45. {
  46. $this->throwable = $exception;
  47. }
  48. /**
  49. * Mark the event as allowing a custom response code.
  50. */
  51. public function allowCustomResponseCode(): void
  52. {
  53. $this->allowCustomResponseCode = true;
  54. }
  55. /**
  56. * Returns true if the event allows a custom response code.
  57. */
  58. public function isAllowingCustomResponseCode(): bool
  59. {
  60. return $this->allowCustomResponseCode;
  61. }
  62. }