Auf ein Event reagieren
Der Core meldet wichtige Vorgänge wie das Anlegen oder Bezahlen einer Rechnung als Domain-Events. Ihr Bundle reagiert darauf, ohne dass Sie Code im Core ändern.
Was Sie bauen
Den Listener InvoiceStatusLogger, der bei jedem Statuswechsel einer Rechnung eine Zeile in var/log/dev.log schreibt.
Voraussetzungen
- Zuerst durcharbeiten: Ein Bundle anlegen
- Eine versendete Rechnung in dieser Installation
Schritt 1 von 4
Das passende Event finden
Jeder Bereich des Core sammelt seine Events als Konstanten in einer eigenen Klasse. Für Rechnungen heißt sie InvoiceEvents.
Terminal
Befehl
docker compose exec -T php php bin/console debug:event-dispatcher 'Vendority\Bundle\Core\Invoice\Event\InvoiceTransitionedEvent'-
1
InvoiceEventsliegt im NamespaceVendority\Bundle\Core\Invoice\Event. Jede Konstante enthält den Klassennamen eines Events,InvoiceEvents::TRANSITIONEDalsoInvoiceTransitionedEvent::class. -
2
Der Core löst
InvoiceTransitionedEventaus, nachdem eine Rechnung ihren Status gewechselt hat und gespeichert ist. -
3
getInvoice()liefert die Rechnung,getTargetStatus()den neuen Status als EnumStatusmit den Wertendraft,sent,paid,overdueundcancelled. -
4
Weitere Konstanten sind
CREATED,UPDATEDundDELETED. Für Events vor einer Änderung gibt es Varianten mitBEFORE_, etwaBEFORE_TRANSITION. -
5
debug:event-dispatcherzeigt, wer schon auf das Event hört. Wie lang die Liste ist, hängt von den installierten Bundles ab.
Schritt 2 von 4
Den Listener schreiben
Ein Listener ist eine Klasse mit einer Methode, die das Event entgegennimmt.
src/Invoice/EventListener/InvoiceStatusLogger.php
Neue Datei
<?php
declare(strict_types=1);
namespace Vendority\Bundle\Acme\Invoice\EventListener;
use Psr\Log\LoggerInterface;
use Symfony\Component\EventDispatcher\Attribute\AsEventListener;
use Vendority\Bundle\Core\Invoice\Event\InvoiceEvents;
use Vendority\Bundle\Core\Invoice\Event\InvoiceTransitionedEvent;
#[AsEventListener(event: InvoiceEvents::TRANSITIONED)]
final readonly class InvoiceStatusLogger
{
public function __construct(
private LoggerInterface $logger,
) {
}
public function __invoke(InvoiceTransitionedEvent $event): void
{
$invoice = $event->getInvoice();
$this->logger->info('Acme: Rechnung {number} hat jetzt den Status {status}.', [
'number' => $invoice->getInvoiceNumber(),
'status' => $event->getTargetStatus()->value,
]);
}
}-
1
#[AsEventListener]meldet die Klasse beim Event-Dispatcher an. Unterevent:steht die Konstante ausInvoiceEvents. -
2
Ohne weitere Angabe ruft Symfony
__invoke()auf. Über den Parametertyp kennt Ihr Editor die Getter des Events. -
3
LoggerInterfacebekommen Sie per Autowiring. Die Einträge landen im Kanalapp. -
4
Die Platzhalter
{number}und{status}füllt Monolog aus dem Array im zweiten Argument. -
5
Der Listener läuft im selben Request wie der Statuswechsel. Halten Sie ihn kurz, denn der Benutzer wartet, bis er fertig ist.
-
6
Mehrere Events in einer Klasse behandeln Sie mit
EventSubscriberInterface. So arbeitet der Core selbst.
Schritt 3 von 4
Den Listener registrieren
Auch ein Listener wird erst als Service wirksam.
config/services.yaml
Geändert
services:
_defaults:
autowire: true
autoconfigure: true
…
Vendority\Bundle\Acme\Invoice\EventListener\:
resource: '../src/Invoice/EventListener'+2 Zeilen neu · grau: bestehender Code zur Orientierung
Terminal
Befehl
docker compose exec -T php php bin/console debug:event-dispatcher 'Vendority\Bundle\Core\Invoice\Event\InvoiceTransitionedEvent'-
1
autoconfigurewertet#[AsEventListener]aus, aber nur bei Klassen, die als Service eingetragen sind. -
2
Der Eintrag nimmt jede Klasse im Ordner
src/Invoice/EventListenerauf. Weitere Listener legen Sie einfach daneben. -
3
Rufen Sie
debug:event-dispatchernoch einmal auf. Ihr Listener steht jetzt mit__invoke()in der Liste.
Schritt 4 von 4
Auslösen und im Log nachsehen
Ändern Sie den Status einer Rechnung und suchen Sie danach die Zeile im Log.
Terminal
Befehl
docker compose exec -T php grep 'Acme: Rechnung' var/log/dev.log-
1
Öffnen Sie „Rechnungen“, wählen Sie im Zeilenmenü einer versendeten Rechnung „Als bezahlt markieren“ und bestätigen Sie mit „Weiter“.
-
2
Suchen Sie danach im Log nach dem Anfang Ihrer Meldung. Eine Suche nach
Acmeallein findet auch jede Zeile, in der der Namensraum Ihres Bundles vorkommt. In der Umgebungdevschreibt Vendority alle Einträge nachvar/log/dev.log. -
3
Auch „Als versendet markieren“ und „Als überfällig markieren“ lösen das Event aus. Ist eine Rechnung vollständig storniert, kommt es mit dem Status
cancelled.
Geschafft.
Sie haben „Auf ein Event reagieren“ von Anfang bis Ende durchgearbeitet.
Blättern auch mit ← und →