Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
80.00% |
4 / 5 |
|
66.67% |
2 / 3 |
CRAP | |
0.00% |
0 / 1 |
| DeferredCallbackListenerProvider | |
80.00% |
4 / 5 |
|
66.67% |
2 / 3 |
4.13 | |
0.00% |
0 / 1 |
| __construct | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| setLogger | |
0.00% |
0 / 1 |
|
0.00% |
0 / 1 |
2 | |||
| getListenersForEvent | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
2 | |||
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | /** |
| 6 | * This file is part of fast-forward/defer. |
| 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) 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/defer |
| 15 | * @see https://github.com/php-fast-forward |
| 16 | * @see https://datatracker.ietf.org/doc/html/rfc2119 |
| 17 | */ |
| 18 | |
| 19 | namespace FastForward\Defer\EventDispatcher\ListenerProvider; |
| 20 | |
| 21 | use FastForward\Defer\EventDispatcher\Event\DeferredCallbackFailed; |
| 22 | use FastForward\Defer\EventDispatcher\Listener\LogDeferredCallbackFailure; |
| 23 | use Psr\EventDispatcher\ListenerProviderInterface; |
| 24 | use Psr\Log\LoggerAwareInterface; |
| 25 | use Psr\Log\LoggerInterface; |
| 26 | use Psr\Log\NullLogger; |
| 27 | |
| 28 | /** |
| 29 | * This provider MUST be used to supply listeners for DeferredCallbackFailed events. |
| 30 | * It SHALL provide a LogDeferredCallbackFailure listener for each such event. |
| 31 | * The logger MAY be customized via setLogger(). |
| 32 | */ |
| 33 | final class DeferredCallbackListenerProvider implements ListenerProviderInterface, LoggerAwareInterface |
| 34 | { |
| 35 | /** |
| 36 | * Constructs a new DeferredCallbackListenerProvider instance. |
| 37 | * |
| 38 | * @param LoggerInterface|null $logger the logger to use for listeners (optional) |
| 39 | */ |
| 40 | public function __construct( |
| 41 | private ?LoggerInterface $logger = new NullLogger() |
| 42 | ) {} |
| 43 | |
| 44 | /** |
| 45 | * Sets the logger to be used by listeners. |
| 46 | * |
| 47 | * @param LoggerInterface $logger the logger to set |
| 48 | * |
| 49 | * @return void |
| 50 | */ |
| 51 | public function setLogger(LoggerInterface $logger): void |
| 52 | { |
| 53 | $this->logger = $logger; |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Returns listeners for the given event. |
| 58 | * |
| 59 | * This method MUST yield a LogDeferredCallbackFailure listener for DeferredCallbackFailed events. |
| 60 | * |
| 61 | * @param object $event the event to get listeners for |
| 62 | * |
| 63 | * @return iterable the listeners for the event |
| 64 | */ |
| 65 | public function getListenersForEvent(object $event): iterable |
| 66 | { |
| 67 | if (! $event instanceof DeferredCallbackFailed) { |
| 68 | return; |
| 69 | } |
| 70 | |
| 71 | yield new LogDeferredCallbackFailure($this->logger); |
| 72 | } |
| 73 | } |