|
| 1 | +# Events |
| 2 | + |
| 3 | +Simple events for Nette. |
| 4 | + |
| 5 | +## Content |
| 6 | + |
| 7 | +- [Usage - how to register](#usage) |
| 8 | + - [Register events](#register-events) |
| 9 | + - [Register lazy events](#register-lazy-events) |
| 10 | + - [Fire events](#fire-events) |
| 11 | + |
| 12 | +## Usage |
| 13 | + |
| 14 | +### Register extension |
| 15 | + |
| 16 | +Register in your config file (e.q. config.neon). |
| 17 | + |
| 18 | +```neon |
| 19 | +extensions: |
| 20 | + events: Contributte\DummyEvents\DI\EventsExtension |
| 21 | +``` |
| 22 | + |
| 23 | +### Register events |
| 24 | + |
| 25 | +On Container compile - **EventsExtension** collect all services which implement **EventsSubscriber** and call their `onEvents($em)` method. |
| 26 | + |
| 27 | +```php |
| 28 | +use Contributte\DummyEvents\EventsSubscriber; |
| 29 | +use Contributte\DummyEvents\EventsManager; |
| 30 | + |
| 31 | +class TestService implements EventsSubscriber |
| 32 | +{ |
| 33 | + /** |
| 34 | + * @param EventsManager $em |
| 35 | + */ |
| 36 | + public function onEvents(EventsManager $em) { |
| 37 | + $em->on('order.update', function($state) { |
| 38 | + // Some logic.. |
| 39 | + }); |
| 40 | + } |
| 41 | +} |
| 42 | +``` |
| 43 | + |
| 44 | +### Register lazy events |
| 45 | + |
| 46 | +Name tag as event name with prefix **event**. |
| 47 | + |
| 48 | +```neon |
| 49 | +services: |
| 50 | + {class: TestService, tags: [event.order.update]} |
| 51 | +``` |
| 52 | + |
| 53 | +Or use tag arrays with key name **events**. |
| 54 | + |
| 55 | +```neon |
| 56 | +services: |
| 57 | + {class: TestService, tags: [events: [order.update]]} |
| 58 | +``` |
| 59 | + |
| 60 | +This prevents usage of other tags. |
| 61 | + |
| 62 | +If **EventsSubscriber** register more events and also is lazy registered (by tags in neon). Implemented method |
| 63 | +`onEvents(EventsManager $em)` is called **only once**. |
| 64 | + |
| 65 | +```php |
| 66 | +use Contributte\DummyEvents\EventsSubscriber; |
| 67 | +use Contributte\DummyEvents\EventsManager; |
| 68 | + |
| 69 | +class TestSubscriber implements EventsSubscriber |
| 70 | +{ |
| 71 | + |
| 72 | + public function onEvents(EventsManager $em) { |
| 73 | + $em->on('order.create', function($state) { |
| 74 | + // Some logic.. |
| 75 | + }); |
| 76 | + |
| 77 | + $em->on('order.update', function($state) { |
| 78 | + // Some logic.. |
| 79 | + }); |
| 80 | + |
| 81 | + $em->on('order.delete', function($state) { |
| 82 | + // Some logic.. |
| 83 | + }); |
| 84 | + } |
| 85 | +} |
| 86 | +``` |
| 87 | + |
| 88 | +### Fire events |
| 89 | + |
| 90 | +Inject to your class ultra-simple **EventsManager**. |
| 91 | + |
| 92 | +```php |
| 93 | +use Contributte\DummyEvents\EventsManager; |
| 94 | + |
| 95 | +/** @var EventsManager @inject **/ |
| 96 | +public $em; |
| 97 | + |
| 98 | +public function save() { |
| 99 | + // Some logic.. |
| 100 | + |
| 101 | + // Fire order update events |
| 102 | + $this->em->trigger('order.update', $order->state); |
| 103 | +} |
| 104 | +``` |
| 105 | + |
0 commit comments