TD9 – Messages Flash Une autre application des sessions

Copiez/collez dans un nouveau dossier TD9 tous les fichiers du dossier TD8.

Les messages peuvent s’afficher sur n’importe quelle page qui utilise vueGenerale.php, que nous allons mettre à jour pour afficher tous les messages existants.

Dans vueGenerale.php, rajouter le <div> suivant juste après le <nav> dans le <header>.

<div>
    <?php
    /** @var string[][] $messagesFlash */
    foreach($messagesFlash as $type => $messagesFlashPourUnType) {
        // $type est l'une des valeurs suivantes : "success", "info", "warning", "danger"
        // $messagesFlashPourUnType est la liste des messages flash d'un type
        foreach ($messagesFlashPourUnType as $messageFlash) {
            echo <<< HTML
            <div class="alert alert-$type">
               $messageFlash
            </div>
            HTML;
        }
    }
    ?>
</div>

Prenez le temps de bien comprendre ce code.

/* Bootstrap alerts */
/* https://getbootstrap.com/docs/3.4/components/#alerts */

.alert {
    padding: 15px;
    margin-bottom: 20px;
    border: 1px solid transparent;
    border-radius: 4px;
}

.alert-success {
    color: #3c763d;
    background-color: #dff0d8;
    border-color: #d6e9c6;
}

.alert-info {
    color: #31708f;
    background-color: #d9edf7;
    border-color: #bce8f1;
}

.alert-warning {
    color: #8a6d3b;
    background-color: #fcf8e3;
    border-color: #faebcc;
}

.alert-danger {
    color: #a94442;
    background-color: #f2dede;
    border-color: #ebccd1;
}

On obtient alors par exemple un bloc de succès avec le code

<div class="alert alert-success">...</div>

http://localhost/tds-php/TD9/web/controleurFrontal.php?messagesFlash[success][]=Hello+World

ou

http://localhost/tds-php/TD9/web/controleurFrontal.php?messagesFlash[danger][]=Message+de+danger+1&messagesFlash[danger][]=Message+de+danger+2

header("Location: $url");
exit();

En effet, quand un navigateur reçoit l’en-tête de réponse Location, il effectue une redirection, c’est-à-dire qu’il lance une requête vers la nouvelle URL comme si on avait cliqué sur un lien. Enfin, exit() termine l’exécution du script courant.

Note : L’utilisation de exit() est optionnelle. Nous vous le mentionnons car généralement le script n’a plus rien à faire après avoir demandé une redirection.

L’URL qu’il faut mentionner n’a pas besoin d’être l’URL absolue (comme dans les liens dans nos vues). Par exemple, pour rediriger vers l’action bonjour du contrôleur exemple avec la donnée var=a avec un message flash de succès, je peux faire :

redirigerVersURL('controleurFrontal.php?controleur=exemple&action=bonjour&var=a&messagesFlash[success][]=OK!')

Utilisons la redirection dans un premier scénario d’erreur. Dans ControleurUtilisateur::afficherDetail, si le login ne correspond à aucun utilisateur, utilisez la redirection précédente vers l’URL de l’action afficherListe avec le message flash de type warning suivant : Login inconnu.

Dans ControleurUtilisateur::supprimer, si l’utilisateur a bien été supprimé, redirigez-le vers l’action afficherListe avec le message flash de succès L'utilisateur a bien été supprimé !.

Implémentez un système de message flash en complétant le squelette suivant dans le fichier src/Lib/MessageFlash.php

 namespace App\Covoiturage\Lib;

 class MessageFlash
 {

     // Les messages sont enregistrés en session associée à la clé suivante 
     private static string $cleFlash = "_messagesFlash";

     /**
      * Récupère le  tableau à deux dimensions correspondant à la clé 
      * self::$cleFlash stocké en session puis ajoute une entrée 
      * contenant $message au sous-tableau correspondant à la clé $type.
      * Enregistre ensuite ce tableau dans la session (en écrasant l'ancien).
      * 
      * $type parmi "success", "info", "warning" ou "danger".
      * 
      * Attention : si le tableau stockant les messages flashs n'existe
      * pas en session, il faut le créer.
      */
     public static function ajouter(string $type, string $message): void
     {
         // À compléter
         $session = Session::getInstance();
         $flashs = [];
         if($session->contient(self::$cleFlash)) {
             ...
         }

         ...

         $session->enregistrer(self::$cleFlash, $flashs);
     }

     /**
      * Renvoie true si le tableau à deux dimensions stockant les messages 
      * flashs en session contient une entrée $type, correspondant à 
      * un sous-tableau, et que ce tableau n'est pas vide.
      * Renvoie false sinon.
      */
     public static function contientMessage(string $type): bool
     {
         // À compléter
         $session = Session::getInstance();
         ...
         return ...
     }

     /**
      * Renvoie un tableau (à une dimension) contenant tous les messages
      * du type $type, correspondant aux données du tableau de l'entrée 
      * $type dans le tableau à deux dimensions stockant les messages
      * flashs en session.
      * Attention : la lecture doit détruire tous les messages de ce 
      * type, donc, supprimer l'entrée $type du tableau stockant les 
      * messages flashs, puis enregistrer de nouveau le tableau en session.
      * @return string[]
      */
     public static function lireMessages(string $type): array
     {
         // À compléter
         $session = Session::getInstance();
         ...
         $flashs = ...
         ...
         $session->enregistrer(self::$cleFlash, $flashs);
         return ...
     }

     /**
      * Renvoie un tableau (à deux dimensions) contenant tous les messages
      * flashs, correspondant aux données du tableau stockant tous les 
      * messages flashs en session.
      * Attention : la lecture doit détruire tous les messages, donc, supprimer 
      * le tableau stockant les messages flashs en session.
      * @return string[][]
      */
     public static function lireTousMessages() : array
     {
         // À compléter
         $session = Session::getInstance();
         ...
         $flashs = ...
         ...
         $session->enregistrer(self::$cleFlash, $flashs);
         return ...
     }

 }

Ajouter la méthode rediriger au contrôleur générique, en copiant le code ci-dessus.

Prenez bien le temps de comprendre ce que fait cette méthode, ligne par ligne. Demandez à votre enseignant chargé de TD si vous n’êtes pas sûr de comprendre certaines parties.

Remplacez les appels à redirigerVersURL par rediriger dans les actions ControleurUtilisateur::afficherDetail et ControleurUtilisateur::supprimer.

Testez et vérifiez que tout fonctionne et que vos messages flashs s’affichent toujours.

En particulier, supprimez les vues désormais inutiles comme utilisateurCree.php, utilisateurConnecte.php, utilisateurDeconnecte.php, utilisateurMisAJour.php et utilisateurSupprime.php. Faites de même pour les vues trajets et éventuellement les vues concernant les passagers si vous aviez fait certaines questions bonus.

Remplacez ces vues par des messages flashs de type success dans les actions concernées.

• Par exemple, en cas de succès de création d’un utilisateur, on pourrait ajouter un message flash de succès L’utilisateur a bien été créé puis rediriger dans l’action afficherListe du contrôleur utilisateur.

• Ou bien, pour la connexion, on pourra ajouter un message flash de succès Connexion réussie! puis rediriger dans l’action afficherDetail du contrôleur utilisateur en passant le login de l’utilisateur dans l’URL grâce au tableau associatif $query de la méthode rediriger.

L’action enregistrerPreference() doit maintenant rediriger l’action par défaut du contrôleur par défaut, que l’on obtient sans indiquer d’action ni de contrôleur dans la méthode rediriger, avec un message flash de succès La préférence de contrôleur est enregistrée !.

Action afficherDetail

• s’il manque le login, redirigez vers la liste des utilisateurs avec un message flash Login manquant de type warning.

• si l’utilisateur n’existe pas, redirigez vers la liste des utilisateurs avec un message flash Utilisateur inexistant ! de type warning.

Note : Nous réserverons les messages flash de type danger pour les erreurs qui ne sont censées se produire que si le client a essayé de hacker le site (accès à une page qu’on ne lui a pas proposé, donnée de formulaire manquante alors qu’elle était required), et les messages flash de type warning pour les erreurs de l’utilisateur.

Action creerDepuisFormulaire

• s’il manque des données, redirigez vers le formulaire de création avec un message flash Données manquantes de type warning.

• si les deux champs mot de passe ne coïncident pas, redirigez vers le formulaire de création avec un message flash Mots de passe distincts de type warning.

• s’il manque le login, redirigez vers la liste des utilisateurs avec un message flash Login manquant de type warning.

• si l’utilisateur qui modifie de profil n’est pas l’utilisateur à qui appartient le profil ou un administrateur, redirigez vers la liste des utilisateurs avec un message flash La mise à jour n’est possible que pour l’utilisateur connecté! de type danger.

• si l’utilisateur n’existe pas, redirigez vers la liste des utilisateurs avec un message flash Utilisateur inexistant ! de type warning.

• si l’utilisateur qui modifie de profil n’est pas l’utilisateur à qui appartient le profil ou un administrateur, redirigez vers la liste des utilisateurs avec un message flash La mise à jour n’est possible que pour l’utilisateur connecté! de type danger.

• si l’utilisateur n’existe pas, redirigez vers la liste des utilisateurs avec un message flash Utilisateur inexistant ! de type warning.

• s’il manque des données, redirigez vers le formulaire de mise à jour en indiquant le login dans l’URL (grâce au tableau associatif $query en paramètre de rediriger) avec un message flash Données manquantes de type warning.

• si les 2 nouveaux mots de passe ne coïncident pas, redirigez vers le formulaire de mise à jour en indiquant le login dans l’URL (toujours grâce au paramètre $query de rediriger) avec un message flash Mots de passe distincts.

• si l’ancien mot de passe n’est pas correct et que l’utilisateur n’est pas administrateur, redirigez vers le formulaire de mise à jour en indiquant le login dans l’URL avec un message flash Ancien mot de passe erroné.

• s’il manque le login, redirigez vers la liste des utilisateurs avec un message flash Login manquant de type warning.

• si l’utilisateur qui supprime l’utilisateur n’est pas l’utilisateur à qui appartient le profil ou un administrateur, redirigez vers la liste des utilisateurs avec un message flash La suppression n’est possible que pour l’utilisateur connecté! de type danger.

• si l’utilisateur n’existe pas, redirigez vers la liste des utilisateurs avec un message flash Utilisateur inexistant ! de type warning.

• si le login ou le mot de passe ne sont pas transmis redirigez vers le formulaire de connexion avec un message flash Login et/ou mot de passe manquant de type warning.

• si l’utilisateur n’existe pas, redirigez vers le formulaire de connexion avec un message flash Login inconnu de type warning.

• si le mot de passe transmis n’est pas correct, redirigez vers le formulaire de connexion avec un message flash Mot de passe incorrect de type danger.

• si l’utilisateur n’a pas validé son adresse email, redirigez vers le formulaire de connexion avec un message flash Votre adresse email n’est pas validée! de type warning.

• s’il manque le login et/ou le nonce, redirigez vers la liste des utilisateurs avec un message flash Données manquantes de type warning.
• en cas de succès, redirigez vers la page de détail de cet utilisateur (en passant son login dans l’URL grâce au paramètre $query de rediriger) avec un message flash Adresse email validée de type success.
• en cas d’échec, “redirection flash” redirigez vers la liste des utilisateurs avec un message flash Erreur lors de la validation de type danger.

Remplacez les autres appels à afficherErreur restants (s’ils n’ont pas été listés dans cet exercice), notamment ceux des autres contrôleurs.

Normalement, à ce stade, vous ne devriez plus avoir d’appel à afficherErreur dans vos contrôleurs. Nous allons donc, à priori, pouvoir supprimer cette méthode. Cependant, elle est encore utilisée à un dernier endroit : le point d’entrée de notre site, controleurFrontal.php. Nous pouvons mettre en place deux solutions :

• Soit remplacer les appels à afficherErreur dans controleurFrontal.php par un ajout de message flashs de type danger et une redirection vers le contrôleur et l’action par défaut (en appelant ControleurGenerique::redirger sans paramètres).

• Soit créer une vue globale erreur.php dans le dossier src/vue puis une méthode statique afficherErreur($message) dans ControleurGenerique qui appellera cette vue en lui passant le message d’erreur (proche de ce que nous avions jusqu’ici). Ensuite, il suffit alors d’utiliser ControleurGenerique::afficherErreur dans controleurFrontal.php à la place de ce qui été utilisé jusqu’ici.

Choisissez une des deux solutions et implémentez là. Ensuite, vérifiez dans chaque contrôleur (sauf le contrôleur générique) que la méthode afficherErrreur n’est plus utilisée et supprimez-la.