Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
100.00%
15 / 15
100.00%
3 / 3
 CRAP
100.00%
1 / 1
LogEventListenerProvider
100.00%
15 / 15
100.00%
3 / 3
 5
100.00%
1 / 1
 __construct
100.00%
1 / 1
100.00%
1 / 1
 1
 __invoke
100.00%
1 / 1
100.00%
1 / 1
 1
 createContext
100.00%
13 / 13
100.00%
1 / 1
 3
1<?php
2
3declare(strict_types=1);
4
5/**
6 * This file is part of php-fast-forward/event-dispatcher.
7 *
8 * This source file is subject to the license bundled
9 * with this source code in the file LICENSE.
10 *
11 * @copyright Copyright (c) 2025-2026 Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
12 * @license   https://opensource.org/licenses/MIT MIT License
13 *
14 * @see       https://github.com/php-fast-forward/event-dispatcher
15 * @see       https://github.com/php-fast-forward
16 * @see       https://datatracker.ietf.org/doc/html/rfc2119
17 */
18
19namespace FastForward\EventDispatcher\ListenerProvider;
20
21use FastForward\EventDispatcher\Event\ErrorEvent;
22use FastForward\EventDispatcher\Event\NamedEvent;
23use Psr\Log\LoggerInterface;
24use Psr\Log\LogLevel;
25
26/**
27 * Log every dispatched object through a PSR-3 logger.
28 */
29 class LogEventListenerProvider extends WildcardListenerProvider
30{
31    /**
32     * Create a listener that records dispatched events.
33     *
34     * @param LoggerInterface $logger logger used to record the event
35     * @param string $level PSR-3 log level
36     */
37    public function __construct(
38        private  LoggerInterface $logger,
39        private  string $level = LogLevel::INFO,
40    ) {}
41
42    /**
43     * Log the provided event.
44     *
45     * @param object $event event emitted by the dispatcher
46     */
47    public function __invoke(object $event): void
48    {
49        $this->logger->log($this->level, 'Event dispatched', $this->createContext($event));
50    }
51
52    /**
53     * Create the log context for the event.
54     *
55     * @param object $event event being logged
56     *
57     * @return array<string, mixed> log context
58     */
59    private function createContext(object $event): array
60    {
61        $context = [
62            'event' => $event,
63            'event_class' => $event::class,
64        ];
65
66        if ($event instanceof NamedEvent) {
67            $context['event_name'] = $event->getName();
68            $context['wrapped_event'] = $event->getEvent();
69            $context['wrapped_event_class'] = $event->getEvent()::class;
70        }
71
72        if ($event instanceof ErrorEvent) {
73            $context['exception'] = $event->getThrowable();
74            $context['original_event'] = $event->getEvent();
75            $context['original_event_class'] = $event->getEvent()::class;
76        }
77
78        return $context;
79    }
80}