ICanBoogie/HTTP v2.6.0
  • Namespace
  • Class

Namespaces

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

Classes

  • CallableDispatcher
  • DispatcherProvider
  • File
  • FileInfo
  • FileList
  • FileResponse
  • Headers
  • ProvideDispatcher
  • RedirectResponse
  • Request
  • RequestDispatcher
  • RequestOptionsMapper
  • RequestRange
  • Response
  • Status
  • WeightedDispatcher

Interfaces

  • Dispatcher
  • Exception
  • FileOptions
  • RequestMethods
  • RequestOptions
  • ResponseStatus
  • SecurityError

Exceptions

  • AuthenticationRequired
  • ClientError
  • DispatcherNotDefined
  • DispatcherProviderNotDefined
  • ForceRedirect
  • MethodNotSupported
  • NotFound
  • PermissionRequired
  • ServerError
  • ServiceUnavailable
  • StatusCodeNotValid

Functions

  • dispatch
  • get_dispatcher
  • get_initial_request
 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 
<?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;

/**
 * Provides a {@link Dispatcher} instance.
 */
class DispatcherProvider
{
    /**
     * @var callable {@link Dispatcher} provider
     */
    static private $provider;

    /**
     * Whether a provider if defined.
     *
     * @return callable|null
     */
    static public function defined()
    {
        return self::$provider;
    }

    /**
     * Defines the {@link Dispatcher} provider.
     *
     * @param callable $provider
     *
     * @return callable|null The previous provider, or `null` if none was defined before.
     */
    static public function define(callable $provider)
    {
        $previous = self::$provider;

        self::$provider = $provider;

        return $previous;
    }

    /**
     * Undefine the {@link Dispatcher} provider.
     */
    static public function undefine()
    {
        self::$provider = null;
    }

    /**
     * Returns a {@link Dispatcher} instance using the provider.
     *
     * @return Dispatcher
     *
     * @throws DispatcherProviderNotDefined if no provider is defined.
     */
    static public function provide()
    {
        $provider = self::$provider;

        if (!$provider)
        {
            throw new DispatcherProviderNotDefined;
        }

        return $provider();
    }
}
ICanBoogie/HTTP v2.6.0 API documentation generated by ApiGen