ICanBoogie/HTTP v2.6.0
  • Namespace
  • Class

Namespaces

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

Classes

  • Context
 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 
<?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\Request;

use ICanBoogie\HTTP\Dispatcher;
use ICanBoogie\HTTP\Request;
use ICanBoogie\PrototypeTrait;

/**
 * The context of a request.
 *
 * This is a general purpose container used to store the objects and variables related to a
 * request.
 *
 * @property-read Request $request The request associated with the context.
 * @property Dispatcher $dispatcher The dispatcher currently dispatching the request.
 */
class Context
{
    use PrototypeTrait;

    /**
     * The request the context belongs to.
     *
     * @var Request
     */
    private $request;

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

    /**
     * The dispatcher currently dispatching the request.
     *
     * @var Dispatcher|null
     */
    private $dispatcher;

    /**
     * Sets the dispatcher currently dispatching the request.
     *
     * @param Dispatcher|null $dispatcher
     *
     * @throws \InvalidArgumentException if the value is not null and does not implements {@link Dispatcher}.
     */
    protected function set_dispatcher($dispatcher)
    {
        if ($dispatcher !== null && !($dispatcher instanceof Dispatcher))
        {
            throw new \InvalidArgumentException('$dispatcher must be an instance of ICanBoogie\HTTP\DispatcherInterface. Given: ' . get_class($dispatcher) . '.');
        }

        $this->dispatcher = $dispatcher;
    }

    protected function get_dispatcher()
    {
        return $this->dispatcher;
    }

    /**
     * @param Request $request The request the context belongs to.
     */
    public function __construct(Request $request)
    {
        $this->request = $request;
    }
}
ICanBoogie/HTTP v2.6.0 API documentation generated by ApiGen