ICanBoogie/HTTP master
  • Namespace
  • Class

Namespaces

  • ICanBoogie
    • Exception
    • HTTP
      • Headers
      • Request
      • RequestDispatcher

Classes

  • RescueEvent
  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  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 
<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Exception;

use ICanBoogie\Event;
use ICanBoogie\HTTP\Request;
use ICanBoogie\HTTP\Response;

/**
 * Event class for the `Exception:rescue` event type.
 *
 * Third parties may use this event to provide a response for the exception.
 *
 * @property \Exception $exception
 * @property-read Request $request
 * @property Response $response
 */
class RescueEvent extends Event
{
    const TYPE = 'rescue';

    /**
     * Reference to the response.
     *
     * @var Response|null
     */
    private $response;

    /**
     * @return Response|null
     */
    protected function get_response()
    {
        return $this->response;
    }

    /**
     * @param Response|null $response
     */
    protected function set_response(Response $response = null)
    {
        $this->response = $response;
    }

    /**
     * Reference to the exception.
     *
     * @var \Exception
     */
    private $exception;

    /**
     * @return \Exception
     */
    protected function get_exception()
    {
        return $this->exception;
    }

    /**
     * @param \Exception $exception
     */
    protected function set_exception(\Exception $exception)
    {
        $this->exception = $exception;
    }

    /**
     * The request.
     *
     * @var Request
     */
    private $request;

    /**
     * @return Request
     */
    protected function get_request()
    {
        return $this->request;
    }

    /**
     * The event is constructed with the type `rescue`.
     *
     * @param \Exception $target
     * @param Request $request The request.
     * @param Response|null $response Reference to the response.
     */
    public function __construct(\Exception &$target, Request $request, Response &$response = null)
    {
        $this->response = &$response;
        $this->exception = &$target;
        $this->request = $request;

        parent::__construct($target, self::TYPE);
    }
}
ICanBoogie/HTTP master API documentation generated by ApiGen