ICanBoogie/HTTP v2.5.0
  • Namespace
  • Class

Namespaces

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

Classes

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

Interfaces

  • Dispatcher
  • Exception
  • SecurityError

Exceptions

  • AuthenticationRequired
  • ClientError
  • DispatcherNotDefined
  • 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 
<?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;

use ICanBoogie\Accessor\AccessorTrait;

/**
 * Used to define a dispatcher and its weight.
 *
 * <pre>
 * <?php
 *
 * $dispatcher['my'] = new WeightedDispatcher('callback', 'before:that_other_dispatcher');
 * </pre>
 *
 * @property-read string|Dispatcher $dispatcher
 * @property-read int|string $weight
 */
class WeightedDispatcher
{
    use AccessorTrait;

    const WEIGHT_TOP = 'top';
    const WEIGHT_BOTTOM = 'bottom';
    const WEIGHT_BEFORE_PREFIX = 'before:';
    const WEIGHT_AFTER_PREFIX = 'after:';
    const WEIGHT_DEFAULT = 0;

    /**
     * @var Dispatcher|string
     */
    private $dispatcher;

    /**
     * @return Dispatcher|string
     */
    protected function get_dispatcher()
    {
        return $this->dispatcher;
    }

    /**
     * @var int|string
     */
    private $weight;

    /**
     * @return int|string
     */
    protected function get_weight()
    {
        return $this->weight;
    }

    /**
     * Initializes the {@link $dispatcher} and {@link $weight} properties.
     *
     * @param Dispatcher|string $dispatcher
     * @param int|string $weight
     */
    public function __construct($dispatcher, $weight = self::WEIGHT_DEFAULT)
    {
        $this->dispatcher = $dispatcher;
        $this->weight = $weight;
    }
}
ICanBoogie/HTTP v2.5.0 API documentation generated by ApiGen