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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 
<?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\WeightedDispatcher;

/**
 * Event class for the `ICanBoogie\HTTP\RequestDispatcher::alter` event.
 *
 * Event hooks may use this event to register domain dispatchers.
 *
 * @property RequestDispatcher $instance
 */
class AlterEvent extends Event
{
    /**
     * Reference to the target instance.
     *
     * @var RequestDispatcher
     */
    private $instance;

    /**
     * @return RequestDispatcher
     */
    protected function get_instance()
    {
        return $this->instance;
    }

    /**
     * @param RequestDispatcher $dispatcher
     */
    protected function set_instance(RequestDispatcher $dispatcher)
    {
        $this->instance = $dispatcher;
    }

    /**
     * The event is constructed with the type `alter`.
     *
     * @param RequestDispatcher $target
     */
    public function __construct(RequestDispatcher &$target)
    {
        $this->instance = &$target;

        parent::__construct($target, 'alter');
    }

    /**
     * Inserts a dispatcher.
     *
     * @param string $id RequestDispatcher identifier.
     * @param mixed $dispatcher RequestDispatcher.
     * @param int $weight
     */
    public function insert($id, $dispatcher, $weight = 0)
    {
        $this->instance[$id] = new WeightedDispatcher($dispatcher, $weight);
    }

    /**
     * Inserts a dispatcher before another.
     *
     * @param string $id RequestDispatcher identifier.
     * @param mixed $dispatcher RequestDispatcher.
     * @param string $reference Reference dispatcher identifier.
     */
    public function insert_before($id, $dispatcher, $reference)
    {
        $this->insert($id, $dispatcher, WeightedDispatcher::WEIGHT_BEFORE_PREFIX . $reference);
    }

    /**
     * Inserts a dispatcher after another.
     *
     * @param string $id RequestDispatcher identifier.
     * @param mixed $dispatcher RequestDispatcher.
     * @param string $reference Reference dispatcher identifier.
     */
    public function insert_after($id, $dispatcher, $reference)
    {
        $this->insert($id, $dispatcher, WeightedDispatcher::WEIGHT_AFTER_PREFIX . $reference);
    }
}
ICanBoogie/HTTP v2.5.0 API documentation generated by ApiGen