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 <?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;
use ICanBoogie\Accessor\AccessorTrait;
/**
* An event hook.
*
* An {@link EventHook} instance is created when an event hook is attached. The purpose of this
* instance is to ease its detaching:
*
* <pre>
* <?php
*
* use ICanBoogie\HTTP\Dispatcher;
*
* $eh = $events->attach(function(Dispatcher\CollectEvent $event, Dispatcher $target) {
*
* // …
*
* });
*
* $eh->detach();
* </pre>
*
* @property-read EventCollection $events EventCollection collection.
* @property-read string $type Event type
* @property-read callable $hook Event hook.
*/
class EventHook
{
use AccessorTrait;
/**
* Event type.
*
* @var string
*/
private $type;
protected function get_type()
{
return $this->type;
}
/**
* @var callable
*/
private $hook;
protected function get_hook()
{
return $this->hook;
}
/**
* @var EventCollection
*/
private $events;
protected function get_events()
{
return $this->events;
}
/**
* @param EventCollection $events
* @param string $type
* @param callable $hook
*/
public function __construct(EventCollection $events, $type, $hook)
{
$this->events = $events;
$this->type = $type;
$this->hook = $hook;
}
/**
* Detaches the event hook from the events.
*/
public function detach()
{
$this->events->detach($this->type, $this->hook);
}
}