Classes List

Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\HttpKernel\Event;

use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\HttpFoundation\Request;

/** * Allows to create a response for a thrown exception. * * Call setResponse() to set the response that will be returned for the * current request. The propagation of this event is stopped as soon as a * response is set. * * You can also call setException() to replace the thrown exception. This * exception will be thrown if no response is set during processing of this * event. * * @author Bernhard Schussek <bschussek@gmail.com> */
class GetResponseForExceptionEvent extends GetResponseEvent
{
    /** * The exception object. * * @var \Exception */
    private $exception;

    /** * @var bool */
    private $allowCustomResponseCode = false;

    public function __construct(HttpKernelInterface $kernelRequest $request$requestType\Exception $e)
    {
        parent::__construct($kernel$request$requestType);

        $this->setException($e);
    }

    /** * Returns the thrown exception. * * @return \Exception The thrown exception */
    public function getException()
    {
        return $this->exception;
    }

    /** * Replaces the thrown exception. * * This exception will be thrown if no response is set in the event. * * @param \Exception $exception The thrown exception */
    public function setException(\Exception $exception)
    {
        $this->exception = $exception;
    }

    /** * Mark the event as allowing a custom response code. */
    public function allowCustomResponseCode()
    {
        $this->allowCustomResponseCode = true;
    }

    /** * Returns true if the event allows a custom response code. * * @return bool */
    public function isAllowingCustomResponseCode()
    {
        return $this->allowCustomResponseCode;
    }
}