EnforcedResponseException.php

<?php

namespace Drupal\Core\Form;

use Symfony\Component\HttpFoundation\Response;

/**
 * Custom exception to break out of the main request and enforce a response.
 */
class EnforcedResponseException extends \Exception {
    
    /**
     * The response to be enforced.
     *
     * @var \Symfony\Component\HttpFoundation\Response
     */
    protected $response;
    
    /**
     * Constructs a new enforced response exception.
     *
     * @param \Symfony\Component\HttpFoundation\Response $response
     *   The response to be enforced.
     * @param string $message
     *   (optional) The exception message.
     * @param int $code
     *   (optional) A user defined exception code.
     * @param \Exception $previous
     *   (optional) The previous exception for nested exceptions
     */
    public function __construct(Response $response, $message = "", $code = 0, \Exception $previous = NULL) {
        parent::__construct($message, $code, $previous);
        $this->response = $response;
    }
    
    /**
     * Return the response to be enforced.
     *
     * @returns \Symfony\Component\HttpFoundation\Response $response
     *   The response to be enforced.
     */
    public function getResponse() {
        return $this->response;
    }

}