FR

Événements Symfony

La fenêtre Events (barre d'outils de droite, ou Outils) existe dans un projet Symfony (un projet avec bin/console). Elle liste les événements de l'application, qui les écoute et dans quel ordre, et écrit pour vous l'écouteur, le subscriber ou un nouvel événement.

Chaque changement est montré d'abord en diffs (un onglet d'éditeur par fichier) et écrit par Write the files. Si un fichier a changé entre-temps, rien n'est écrit : refaites l'aperçu. Les fichiers PHP sont modifiés avec php-parser : un use, une méthode ou un élément de tableau est inséré là où une personne l'écrirait, et le reste du fichier reste identique octet pour octet.

Onglet Events

L'onglet Events : le sélecteur et le formulaire de l'événement choisi

  • Le sélecteur : une liste filtrable (nom, constante, classe) des événements du framework : noyau (KernelEvents::*), sécurité (LoginSuccessEvent, CheckPassportEvent…), formulaires, console, workers Messenger, Mailer et Doctrine (Events::prePersist…). Seuls les événements des paquets présents dans vendor/ sont montrés, chacun avec la classe de son objet événement, si bien que la méthode écrite a le bon type (RequestEvent $event, PreUpdateEventArgs $args). Les événements propres au projet sont listés aussi : classes de src/ qui étendent Event, et ce que src/ émet (->dispatch(new X)) ; un clic ouvre les endroits où l'un d'eux est émis. Le dispatch du bus Messenger n'est pas un événement.

  • Pour l'événement choisi, la fenêtre montre ses écouteurs dans le code, dans l'ordre où ils sont appelés (la priorité se modifie sur place, et un abonnement se retire : la méthode reste), puis le formulaire Listen to this event :

    • un nouvel EventSubscriber (getSubscribedEvents() avec priorités ; plusieurs méthodes pour un même événement sont possibles) ;
    • un nouvel écouteur avec #[AsEventListener] sur une méthode ou sur la classe ;
    • un écouteur Doctrine (#[AsDoctrineListener]) ou d'entité (#[AsEntityListener]) ;
    • une méthode ajoutée à un subscriber ou un écouteur existant.

    Cliquez Preview the code, vérifiez le diff, Write the files. One more event in this class réunit plusieurs événements dans la classe en cours d'écriture.

  • New event : la classe de l'événement (propriétés en paramètres de constructeur readonly, un NAME facultatif), son dispatch inséré à la fin d'une méthode d'une classe de votre choix (avant son dernier return ; EventDispatcherInterface est injecté, et un constructeur est écrit si la classe n'en a pas), et éventuellement un écouteur pour lui.

Onglet Listeners

Qui écoute kernel.request, depuis l'application

Qui écoute quoi, dans quel ordre :

  • From the code : ce que déclarent les sources du projet ; priorités modifiables sur place.
  • From the application : le résultat de debug:event-dispatcher --format=json, lancé par le lanceur de la console Symfony (le conteneur du site ou le PHP de l'ordinateur). Il inclut les écouteurs des vendors, situés par la table PSR-4 de Composer. Un clic sur un écouteur ouvre sa méthode.

Le filtre accepte un nom d'événement ou une classe.

Limites

  • Le sélecteur ne connaît que les événements des paquets installés ; lancez d'abord composer install.
  • Les émissions sont trouvées en lisant le code : un nom d'événement construit à l'exécution n'est pas vu.
  • La vue de l'application demande un bin/console fonctionnel ; s'il échoue, l'erreur est affichée.