ICanBoogie/HTTP v2.5.0
  • Namespace
  • Class

Namespaces

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

Classes

  • AlterEvent
  • BeforeDispatchEvent
  • DispatchEvent
 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 
<?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\HTTP\RequestDispatcher;

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

/**
 * Event class for the `ICanBoogie\HTTP\RequestDispatcher::dispatch` event.
 *
 * Event hooks may use this event to alter the response before it is returned by the
 * request dispatcher.
 *
 * @property-read Request $request
 * @property Response $response
 */
class DispatchEvent extends Event
{
    /**
     * The request.
     *
     * @var Request
     */
    private $request;

    protected function get_request()
    {
        return $this->request;
    }

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

    protected function get_response()
    {
        return $this->response;
    }

    protected function set_response(Response $response = null)
    {
        $this->response = $response;
    }

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

        parent::__construct($target, 'dispatch');
    }
}
ICanBoogie/HTTP v2.5.0 API documentation generated by ApiGen