TD6 – Architecture MVC avancée 2/2 Vues modulaires, filtrage, formulaires améliorés

1. Si aucun paramètre n’est donné dans l’URL, initialisons la variable action avec la chaîne de caractères "afficherListe" dans controleurFrontal.php. Utilisez la fonction isset($_GET['action']) qui teste si la variable $_GET['action'] a été initialisée, ce qui est le cas si et seulement si une variable action a été donnée dans l’URL.

2. Testez votre site en appelant controleurFrontal.php sans action.

Note : De manière générale, il ne faut jamais lire la case d’un tableau avant d’avoir vérifié qu’elle était bien définie avec un isset(...) sous peine d’avoir des erreurs Undefined index : ....

On souhaite que le routeur vérifie que action est le nom d’une méthode de ControleurVoiture.php avant d’appeler cette méthode. Sinon, nous renverrons vers une page d’erreur.

1. Créez une action afficherErreur(string $messageErreur = "") dans le contrôleur voiture qui affiche une vue d’erreur src/vue/voiture/erreur.php contenant le message d’erreur Problème avec la voiture : $messageErreur, ou juste Problème avec la voiture si le message est vide.

2. Modifiez le code du routeur pour implémenter la vérification de l’action. Si l’action n’existe pas, appelez l’action afficherErreur.

   Notes :

   • Vous pouvez récupérer le tableau des méthodes visibles d’une classe avec la fonction get_class_methods() et tester si une valeur appartient à un tableau avec la fonction in_array.
   • get_class_methods() prend en argument une chaine de caractères contenant le nom de la classe qualifié, c.-à-d. avec le namespace.

1. Renommez la classe ModeleVoiture en Voiture.
   Utilisez le refactoring de PhpStorm : Clic droit sur le nom de la classe > Refactor > Rename.

2. Créez deux dossiers DataObject et Repository dans Modele.

3. Créez une classe VoitureRepository dans le dossier Repository avec le namespace correspondant (App\Covoiturage\Modele\Repository). Déplacez les méthodes suivantes de Voiture dans VoitureRepository :
   • getVoitures
   • getVoitureParImmatriculation
   • ajouter
   • construireDepuisTableau

   Pour la méthode construireDepuisTableau, changez si nécessaire le corps de la fonction afin qu’un objet Voiture soit correctement retourné. Pensez également à adapter le code des autres fonctions de la classe VoitureRepository afin qu’elles appellent correctement la méthode construireDepuisTableau.

   Transformez la méthode ajouter en une méthode statique prenant en paramètre un objet de type Voiture. Cet objet sera la voiture à ajouter. Utilisez donc les getters de cette Voiture afin de retrouver les données à insérer dans la requête SQL de la méthode ajouter.

4. Déplacer Voiture dans le dossier DataObject et ConnexionBaseDeDonnees dans Repository.

   Attention si vous utilisez le drag & drop de PhpStorm, vous allez avoir des mauvaises surprises car les namespace risquent de ne pas se mettre à jour correctement…
   La façon correcte de le faire : Clic droit sur le nom de la classe > Refactor > Move Class > Indiquer le namespace correspondant.

   Vérifiez que votre code correspond à celui indiqué dans le diagramme de classe évoqué précédemment.

5. Faites remarcher les actions une par une :
   • afficherListe :
     • getVoitures appartient à la classe VoitureRepository désormais.
   • afficherDetail :
     • getVoitureParImmatriculation appartient à la classe VoitureRepository.
   • creerDepuisFormulaire :
     • ajouter et getVoitures appartiennent à la classe VoitureRepository désormais.
     • ajouter sera maintenant statique et prendra en argument un objet de la classe Voiture ; les getters de Voiture servent à construire la requête SQL.

Nous souhaitons ajouter l’action supprimer aux voitures. Pour cela :

1. Écrivez dans VoitureRepository une méthode statique supprimerParImmatriculation($immatriculation) qui prend en entrée l’immatriculation à supprimer (pensez à utiliser les requêtes préparées de PDO).

2. Créez une vue src/vue/voiture/voitureSupprimee.php qui affiche “La voiture d’immatriculation $immatriculation a bien été supprimée”, suivi de la liste des voitures en appelant la vue liste.php (de la même manière que voitureCreee.php).

3. Écrivez l’action supprimer du contrôleur de voiture pour que

   1. il supprime la voiture dont l’immatriculation est passée en paramètre dans l’URL,
   2. il affiche la vue voitureSupprimee.php en utilisant le mécanisme de vue générique, et en donnant en paramètres les variables nécessaires dans la vue.

4. Enrichissez la vue liste.php pour ajouter des liens HTML qui permettent de supprimer une voiture.

   Aide : Procédez par étape. Écrivez d’abord un lien fixe dans votre vue, puis la partie qui dépend de la voiture.

5. Testez le tout. Quand la fonctionnalité marche, appréciez l’instant.

Nous souhaitons ajouter l’action afficherFormulaireMiseAJour aux voitures qui affiche le formulaire de mise à jour. Pour cela :

1. Créez une vue src/vue/voiture/formulaireMiseAJour.php qui affiche un formulaire identique à celui de formulaireCreation.php, mais qui sera prérempli par les données de la voiture courante. Nous ne passerons que l’immatriculation de la voiture via l’URL ; les autres informations seront récupérées dans la BDD. Voici quelques points à prendre en compte avant de se lancer :

   1. L’attribut value de la balise <input> permet de préremplir un champ du formulaire. Utilisez l’attribut HTML readonly de <input> pour que l’internaute ne puisse pas changer l’immatriculation.

   2. On pourra se servir dans le contrôleur de getVoitureParImmatriculation pour récupérer l’objet voiture de la bonne immatriculation. La vue devra alors remplir le formulaire avec les attributs de cet objet.

   3. Pensez bien à échapper vos variables PHP avant de les écrire dans l’HTML et dans les URLs.

   4. Rappel : Vous souhaitez envoyer l’information action=mettreAJour en plus des informations saisies lors de l’envoi du formulaire. La bonne façon de faire pour un formulaire de méthode GET est d’ajouter un champ caché <input type='hidden' name='action' value='mettreAJour'>.

2. Écrivez l’action afficherFormulaireMiseAJour du contrôleur de voiture pour qu’il affiche le formulaire prérempli. Vérifiez que l’action afficherFormulaireMiseAJour affiche bien le formulaire.

3. Ajoutons les liens manquants. Enrichissez la vue liste.php pour ajouter des liens HTML qui permettent de mettre à jour une voiture. Ces liens pointent donc vers le formulaire de mis-à-jour prérempli.

4. Astuce optionnelle : La vue afficherFormulaireMiseAJour peut être raccourcie en utilisant la syntaxe

   <?= $immatriculationHTML ?>
   

   qui est équivalente à

   <?php echo $immatriculationHTML; ?>
   

1. Maintenant, passons à l’action mettreAJour qui effectue la mise à jour dans la BDD.

   Créez la vue src/vue/voiture/voitureMiseAJour.php pour qu’elle affiche “La voiture d’immatriculation $immatriculation a bien été mise à jour”. Affichez en dessous de ce message la liste des voitures mise à jour (à la manière de voitureSupprimee.php et voitureCreee.php).

2. Ajoutez à VoitureRepository une méthode statique mettreAJour(Voiture $voiture). Cette méthode est proche de ajouter(Voiture $voiture), à ceci près qu’elle ne renvoie pas de booléen. En effet, on va considérer qu’une mise à jour se passe toujours correctement.

3. Créez l’action mettreAJour du contrôleur de voiture pour qu’il mette à jour la voiture dont l’immatriculation est passée en paramètre dans l’URL, puis qu’il affiche la vue src/vue/voiture/voitureMiseAJour.php après l’avoir correctement initialisée.

4. Testez le tout. Quand la fonctionnalité marche, appréciez de nouveau l’instant.

1. Définissez une variable controleur dans controleurFrontal.php en récupérant sa valeur à partir de l’URL, et en mettant le contrôleur voiture par défaut.

   Aide : Ce bout de code est similaire à celui concernant action dans controleurFrontal.php.

2. On souhaite créer le nom de la classe à partir de controleur. Par exemple, quand $controleur="voiture", nous souhaitons créer une variable $nomDeClasseControleur qui vaut "App\Covoiturage\Controleur\ControleurVoiture".
   Créez la variable $nomDeClasseControleur à l’aide de la fonction ucfirst (UpperCase FIRST letter) qui sert à mettre en majuscule la première lettre d’une chaîne de caractère.

3. Testez si la classe de nom $nomDeClasseControleur existe à l’aide de la fonction class_exists et appelez l’action action de la classe $nomDeClasseControleur le cas échéant. Autrement appelez l’action afficherErreur de ControleurVoiture.

4. Testez votre code en appelant vos anciennes pages du contrôleur voiture.

1. Créez un contrôleur controleur/ControleurUtilisateur.php similaire à celui des voitures qui reprend les méthodes afficherListe(), afficherVue() et afficherErreur().

   Astuce : Vous pouvez utiliser la fonction de remplacement (Ctrl+R sous PHPStorm) pour remplacer tous les voiture par utilisateur. En cochant Préserver la casse (Preserve case), vous pouvez faire en sorte de respecter les majuscules lors du remplacement.

2. Créez une classe DataObject/Utilisateur.php basé sur votre classe Utilisateur des TDs 2 & 3. Ce modèle ne contiendra que les getter, les setter et le constructeur.

3. Créez une classe Repository/UtilisateurRepository.php qui reprend la fonction getUtilisateurs() et construireDepuisTableau($utilisateurTableau) de votre ancienne classe Utilisateur.

   Corrigez l’erreur : il manque un alias avec use pour la classe Utilisateur.

4. Créez une vue src/vue/utilisateur/liste.php similaire à celle des voitures (sans nécessairement de lien pour l’instant).
   Idem pour utilisateur/erreur.php.

5. Testez votre action en appelant l’action afficherListe du contrôleur Utilisateur (qui est accessible dans la barre de menu de votre site normalement).

Créer une classe abstraite AbstractDataObject dans le dossier DataObject. Faites hériter les autres classes de ce répertoire de AbstractDataObject pour correspondre au diagramme de classe ci-dessus.

Commençons par la fonction getVoitures() de VoitureRepository. Les seules différences entre getVoitures() et getUtilisateurs() sont le nom de la table et le nom de la classe des objets en sortie. Voici donc comment nous allons faire pour avoir un code générique :

1. Créez une nouvelle classe abstraite abstract class AbstractRepository et faites hériter la classe VoitureRepository de AbstractRepository (mot clé extends comme en Java).

2. Pour qu’on puisse migrer la fonction getVoitures() de VoitureRepository vers AbstractRepository, il faudrait que cette dernière puisse accèder au nom de la table. Pour cela elle va demander à toutes ses classes filles de posséder une méthode getNomTable().
   Ajoutez donc une méthode abstraite getNomTable() dans AbstractRepository

   protected abstract function getNomTable(): string;
   

   et une implémentation de getNomTable() dans VoitureRepository.

   Question : pourquoi la visibilité de cette fonction est protected ?

3. Déplacez la fonction getVoitures() de VoitureRepository vers AbstractRepository en la renommant recuperer().

   Astuce : sur PhpStorm le moyen le plus simple pour déplacer la fonction serait Clic droit sur la déclaration de la méthode > Refactor > Move Members > Indiquer AbstractRepository comme classe de destination. De même pour le renommage, pensez à utiliser le refactoring.

4. Utilisez getNomTable() dans la requête SQL de recuperer(). Puisque getNomTable() est une méthode dynamique, enlevez le static de recuperer().

   /**
    * @return AbstractDataObject[]
    */
   public function recuperer(): array
   

5. De même, AbstractRepository va demander à toutes ses classes filles de posséder une méthode construireDepuisTableau($objetFormatTableau).
   • Ajoutez donc une méthode abstraite dans AbstractRepository

     public abstract function construireDepuisTableau(array $objetFormatTableau) : AbstractDataObject;
     

   • Enlevez le static du construireDepuisTableau() de VoitureRepository.
   • Mettez à jour l’appel à construireDepuisTableau() de recuperer().
   • Pensez à vérifier que l’implémentation de la méthode construireDepuisTableau() de VoitureRepository déclare bien le type de retour Voiture (sous-classe de AbstractDataObject).
   • La méthode construireDepuisTableau() devient protected dans les classes filles.

6. Corrigez l’action afficherListe du ControleurVoiture pour faire appel à la méthode recuperer() de VoitureRepository. Ici nous vous conseillons pour le moment de construire un objet anonyme afin de pouvoir appeler les fonctions dynamiques de VoitureRepository. Par exemple, si vous souhaitez appeler la fonction recuperer, vous pouvez faire ceci :

   (new VoitureRepository())->recuperer();
   

   L’action afficherListe du contrôleur voiture doit remarcher.

7. Mettez à jour tous vos appels à getVoitures() (ou recuperer() si la méthode getVoitures() a été correctement renommé par le refactoring de la question 3).

1. Faites de même pour UtilisateurRepository :
   • commentez getUtilisateurs(),
   • enlevez le static de construireDepuisTableau(),
   • implémentez getNomTable(),
   • UtilisateurRepository doit hériter de AbstractRepository.
2. Corrigez l’action afficherListe du ControleurUtilisateur pour faire appel à la méthode recuperer() de UtilisateurRepository. L’action doit remarcher.

1. Commençons par déclarer la fonction suivante dans la classe AbstractRepository :

   public function recupererParClePrimaire(string $valeurClePrimaire): ?AbstractDataObject
   

   Copiez/collez le corps de la fonction getVoitureParImmatriculation($immatriculation) vers recupererParClePrimaire($valeurClePrimaire) de AbstractRepository. Nous allons le refactoriser dans les questions suivantes pour qu’il devienne générique.

2. Ajoutez la méthode suivante dans AbstractRepository

   protected abstract function getNomClePrimaire(): string;
   

   et une implémentation de getNomClePrimaire() dans VoitureRepository.

3. Utilisez getNomTable() et getNomClePrimaire() pour construire la requête SQL de recupererParClePrimaire().

4. Finissez de corriger recupererParClePrimaire() :
   • Changez les valeurs dans le tableau donné à execute()
   • Corrigez l’appel à construireDepuisTableau() qui est une méthode dynamique maintenant.
5. Corrigez l’action afficherDetail du ControleurVoiture pour faire appel à la méthode recupererParClePrimaire() de VoitureRepository. L’action doit remarcher.

1. Faites de même pour UtilisateurRepository : implémentez getNomClePrimaire().

2. Créez l’action afficherDetail du ControleurUtilisateur en vous basant sur celle de ControleurVoiture.

   Rappel : Utilisez le remplacement Ctrl+R en préservant la casse pour vous faciliter le travail.

3. Il ne vous reste plus qu’à créer la vue associée detail.php et à ajouter les liens vers la vue de détail dans liste.php. L’action afficherDetail doit maintenant fonctionner.

Nous vous laissons migrer la fonction supprimerParImmatriculation($immatriculation) de VoitureRepository vers AbstractRepository en la renommant supprimer($valeurClePrimaire) et adapter sa requête SQL. Adaptez également l’action supprimer des contrôleurs voiture et utilisateur, ainsi que leur vue associée voitureSupprimee.php et utilisateurSupprime.php.

Nous vous laissons adapter les actions afficherFormulaireCreation et afficherFormulaireMiseAJour de ControleurVoiture (et ControleurUtilisateur), leurs vues associées formulaireCreation.php et formulaireMiseJour.php et à ajouter les liens pour mettre à jour un utilisateur ou une voiture dans detail.php.

1. Déplacez la fonction mettreAJour($immatriculation) de VoitureRepository.php vers AbstractRepository en la renommant

   public function mettreAJour(AbstractDataObject $object): void
   

2. Ajoutez une méthode abstraite getNomsColonnes() dans AbstractRepository

   protected abstract function getNomsColonnes(): array;
   

   et une implémentation de getNomsColonnes() dans VoitureRepository

   protected function getNomsColonnes(): array
   {
       return ["immatriculation", "marque", "couleur", "nbSieges"];
   }
   

3. Utilisez getNomTable(), getNomClePrimaire() et getNomsColonnes() pour construire la requête SQL de mettreAJour() :

   UPDATE voiture SET marque= :marqueTag, couleur= :couleurTag, immatriculation= :immatriculationTag WHERE immatriculation= :immatriculationTag;
   

   Aide : N’hésitez pas à afficher la requête générée pour vérifier votre code.

4. Pour les besoins de execute(), nous avons besoin de transformer l’objet Voiture $voiture en un tableau

   array(
       "immatriculationTag" => $voiture->getImmatriculation(),
       "marqueTag" => $voiture->getMarque(),
       "couleurTag" => $voiture->getCouleur(),
       "nbSiegesTag" => $voiture->getNbSieges(),
   );
   

   Nous allons demander à tous les AbstractDataObject d’implémenter une méthode formatTableau() qui transforme un AbstractDataObject en tableau, qui pourrait être utilisé dans les différents appels à execute(). Ainsi, nous pouvons imposer cette méthode directement par contrat dans AbstractDataObject :

   public abstract function formatTableau(): array;
   

   Implémentez cette fonction dans Voiture avec

   public function formatTableau(): array
   {
       return array(
           "immatriculationTag" => $this->immatriculation,
           "marqueTag" => $this->marque,
           "couleurTag" => $this->couleur,
           "nbSiegesTag" => $this->nbSieges,
       );
   }
   

5. Utilisez formatTableau() dans mettreAJour() pour obtenir le tableau donné à execute().

6. Corrigez l’action mettreAJour du ControleurVoiture pour faire appel aux méthodes de VoitureRepository. L’action doit remarcher.

Implémentez l’action mettreAJour du contrôleur utilisateur.

Répétez la question précédente avec la fonction ajouter() des différents modèles. Ajoutez l’action creerDepuisFormulaire dans le contrôleur utilisateur.