Étape 12: Écouter les événements

5.0 version
Maintained

Écouter les événements

Il manque une barre de navigation au layout actuel pour revenir à la page d’accueil ou pour passer d’une conférence à l’autre.

Ajouter un en-tête au site web

Tout ce qui doit être affiché sur toutes les pages web, comme un en-tête, doit faire partie du layout de base principal :

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
--- a/templates/base.html.twig
+++ b/templates/base.html.twig
@@ -6,6 +6,15 @@
         {% block stylesheets %}{% endblock %}
     </head>
     <body>
+        <header>
+            <h1><a href="{{ path('homepage') }}">Guestbook</a></h1>
+            <ul>
+            {% for conference in conferences %}
+                <li><a href="{{ path('conference', { id: conference.id }) }}">{{ conference }}</a></li>
+            {% endfor %}
+            </ul>
+            <hr />
+        </header>
         {% block body %}{% endblock %}
         {% block javascripts %}{% endblock %}
     </body>

L’ajout de ce code au layout signifie que tous les templates qui l’étendent doivent définir une variable conferences, créée et transmise par leurs contrôleurs.

Comme nous n’avons que deux contrôleurs, vous pouvez faire ce qui suit :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
--- a/src/Controller/ConferenceController.php
+++ b/src/Controller/ConferenceController.php
@@ -32,9 +32,10 @@ class ConferenceController extends AbstractController
     /**
      * @Route("/conference/{slug}", name="conference")
      */
-    public function show(Conference $conference, CommentRepository $commentRepository)
+    public function show(Conference $conference, CommentRepository $commentRepository, ConferenceRepository $conferenceRepository)
     {
         return new Response($this->twig->render('conference/show.html.twig', [
+            'conferences' => $conferenceRepository->findAll(),
             'conference' => $conference,
             'comments' => $commentRepository->findBy(['conference' => $conference], ['createdAt' => 'DESC']),
         ]));

Imaginez devoir mettre à jour des dizaines de contrôleurs. Et faire la même chose sur tous les nouveaux. Ce n’est pas très pratique. Il doit y avoir un meilleur moyen.

Twig a la notion de variables globales. Une variable globale est disponible dans tous les templates générés. Vous pouvez les définir dans un fichier de configuration, mais cela ne fonctionne que pour les valeurs statiques. Pour ajouter toutes les conférences comme variable globale Twig, nous allons créer un listener.

Découvrir les événements Symfony

Symfony intègre un composant Event Dispatcher. Un dispatcher répartit certains événements à des moments précis que les listeners peuvent écouter. Les listeners sont des hooks dans le cœur du framework.

Par exemple, certains événements vous permettent d’interagir avec le cycle de vie des requêtes HTTP. Pendant le traitement d’une requête, le dispatcher répartit les événements lorsqu’une requête a été créée, lorsqu’un contrôleur est sur le point d’être exécuté, lorsqu’une réponse est prête à être envoyée, ou lorsqu’une exception a été levée. Un listener peut écouter un ou plusieurs événements et exécuter une logique basée sur le contexte de l’événement.

Les événements sont des points d’extension bien définis qui rendent le framework plus générique et extensible. De nombreux composants Symfony tels que Security, Messenger, Workflow ou Mailer les utilisent largement.

Un autre exemple intégré d’événements et de listeners en action est le cycle de vie d’une commande : vous pouvez créer un listener pour exécuter du code avant n’importe quelle commande.

Tout paquet ou bundle peut également déclencher ses propres événements pour rendre son code extensible.

Pour éviter d’avoir un fichier de configuration qui décrit les événements qu’un listener veut écouter, créez un subscriber. Un subscriber est un listener avec une méthode statique getSubscribedEvents() qui retourne sa configuration. Ceci permet aux subscribers d’être enregistrés automatiquement dans le dispatcher Symfony.

Implémenter un subscriber

Vous connaissez la chanson par cœur maintenant, utilisez le Maker Bundle pour générer un subscriber :

1
$ symfony console make:subscriber TwigEventSubscriber

La commande vous demande quel événement vous voulez écouter. Choisissez l’événement Symfony\Component\HttpKernel\Event\ControllerEvent qui est envoyé juste avant l’appel d’un contrôleur. C’est le meilleur moment pour injecter la variable globale conferences afin que Twig y ait accès lorsque le contrôleur générera le template. Mettez votre subscriber à jour comme suit :

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
--- a/src/EventSubscriber/TwigEventSubscriber.php
+++ b/src/EventSubscriber/TwigEventSubscriber.php
@@ -2,14 +2,25 @@

 namespace App\EventSubscriber;

+use App\Repository\ConferenceRepository;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
+use Twig\Environment;

 class TwigEventSubscriber implements EventSubscriberInterface
 {
+    private $twig;
+    private $conferenceRepository;
+
+    public function __construct(Environment $twig, ConferenceRepository $conferenceRepository)
+    {
+        $this->twig = $twig;
+        $this->conferenceRepository = $conferenceRepository;
+    }
+
     public function onControllerEvent(ControllerEvent $event)
     {
-        // ...
+        $this->twig->addGlobal('conferences', $this->conferenceRepository->findAll());
     }

     public static function getSubscribedEvents()

Maintenant, vous pouvez ajouter autant de contrôleurs que vous le souhaitez : la variable conferences sera toujours disponible dans Twig.

Note

Nous parlerons d’une alternative bien plus performante dans une prochaine étape.

Trier les conférences par année et par ville

Le tri de la liste des conférences par année peut faciliter la navigation. Nous pourrions créer notre propre méthode pour récupérer et trier toutes les conférences, mais nous allons plutôt remplacer l’implémentation par défaut de la méthode findAll(), afin que le tri s’applique partout :

patch_file
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
--- a/src/Repository/ConferenceRepository.php
+++ b/src/Repository/ConferenceRepository.php
@@ -19,6 +19,11 @@ class ConferenceRepository extends ServiceEntityRepository
         parent::__construct($registry, Conference::class);
     }

+    public function findAll()
+    {
+        return $this->findBy([], ['year' => 'ASC', 'city' => 'ASC']);
+    }
+
     // /**
     //  * @return Conference[] Returns an array of Conference objects
     //  */

À la fin de cette étape, le site web devrait ressembler à ceci :


  • « Previous Étape 11: Utiliser des branches
  • Next » Étape 13: Gérer le cycle de vie des objets Doctrine

This work, including the code samples, is licensed under a Creative Commons BY-NC-SA 4.0 license.