Création, édition et suppression d'entités

1. Effacez les accesseurs de la classe « Artist »
2. Modifiez le type de la propriété « id » pour le rendre « nullable »
3. Utilisez PhpStorm pour générer les accesseurs et les modificateurs fluides (« fluent » en anglais) de propriétés « id » et « name »
   Information

   Le code généré sera inséré à l'endroit où se situe le curseur texte. Visez bien !

4. Modifiez la visibilité du mutateur « setId() » pour le rendre privé
   Information

   L'identifiant est une donnée sensible pour les interactions avec la base de données. Seule la classe doit être autorisée à le modifier.

5. Ajoutez la méthode d'instance « delete » qui a pour objectifs de :
   • supprimer la ligne correspondante à l'« id » dans la base de données
   • mettre « null » dans la propriété « id » de l'instance
   • retourner l'instance courante pour permettre le chaînage des méthodes
   Remarque importante

   Pour des raisons de performance, toutes vos requêtes doivent être préparées, et si nécessaire paramétrées, pour des raisons de sécurité. Toute substitution de variable dans une requête est une faille de sécurité potentielle !

1. Ajoutez la méthode suivante au « Cest » « Crud » dédié à la classe « Artist » :

   public function delete(CrudTester $I)
   {
       $artist = Artist::findById(4);
       $artist->delete();
       $I->cantSeeInDatabase('artist', ['id' => 4]);
       $I->cantSeeInDatabase('artist', ['name' => 'Slipknot']);
       $I->assertNull($artist->getId());
       $I->assertSame('Slipknot', $artist->getName());
   }

2. Vérifiez que les tests passent

1. Ajoutez la méthode d'instance « save() » qui a pour objectifs de :
   • mettre à jour le « name » de la table « artist » pour la ligne dont l'« id » est celui de l'instance courante
   • retourner l'instance courante pour permettre le chaînage des méthodes
   Remarque importante

   Pour des raisons de performance, toutes vos requêtes doivent être préparées, et si nécessaire paramétrées, pour des raisons de sécurité. Toute substitution de variable dans une requête est une faille de sécurité potentielle !

1. Ajoutez la méthode suivante au « Cest » « Crud » dédié à la classe « Artist » :

   public function update(CrudTester $I)
   {
       $artist = Artist::findById(4);
       $artist->setName('Nœud Coulant');
       $artist->save();
       $I->canSeeNumRecords(1, 'artist', [
           'id' => 4,
           'name' => 'Nœud Coulant'
       ]);
       $I->assertSame(4, $artist->getId());
       $I->assertSame('Nœud Coulant', $artist->getName());
   }

2. Vérifiez que les tests passent

1. Ajoutez la méthode de classe « create() » qui a pour objectifs de :
   • créer une instance de « Artist »
   • Affecter « name » avec le premier paramètre de la méthode
   • Affecter « id » avec le second paramètre facultatif de la méthode
   • retourner l'instance créée
2. Ajoutez un constructeur privé à la classe « Artist »

1. Ajoutez les méthodes suivantes au « Cest » « Crud » dédié à la classe « Artist » :

   public function createWithoutId(CrudTester $I)
   {
       $artist = Artist::create('Nœud Coulant');
       $I->assertNull($artist->getId());
       $I->assertSame('Nœud Coulant', $artist->getName());
   }
   
   public function createWithId(CrudTester $I)
   {
       $artist = Artist::create('Nœud Coulant', 4);
       $I->assertSame(4, $artist->getId());
       $I->assertSame('Nœud Coulant', $artist->getName());
   }

2. Vérifiez que les tests passent

1. Renommez la méthode « save() » en « update() »
2. Ajoutez la méthode d'instance « insert() » qui a pour objectifs de :
   • exécuter la requête d'insertion dans la table « artist »
   • mettre à jour l'identifiant de l'instance courante avec le dernier identifiant créé par la base de données
   • retourner l'instance courante pour permettre le chaînage des méthodes
3. Ajoutez la méthode d'instance « save() » qui a pour objectifs de :
   • déclencher « insert() » ou « update() » selon que la valeur de « id » est respectivement « null » ou non
   • retourner l'instance courante pour permettre le chaînage des méthodes

1. Ajoutez les méthodes suivantes au « Cest » « Crud » dédié à la classe « Artist » :

   /**
    * @after createWithoutId
    */
   public function insert(CrudTester $I)
   {
       $artist = Artist::create('Nœud Coulant');
       $artist->save();
       $I->canSeeNumRecords(1, 'artist', [
           'id' => 90,
           'name' => 'Nœud Coulant'
       ]);
       $I->assertSame($artist->getId(), 90);
       $I->assertSame('Nœud Coulant', $artist->getName());
   }

2. Vérifiez que les tests passent

1. Créez la classe « ArtistForm » à l'aide de PhpStorm
2. Ajoutez la propriété « artist » issue de la relation avec la classe « Artist », sachant qu'un artiste n'est pas nécessairement présent
3. Utilisez PhpStorm pour générer le constructeur
4. Utilisez PhpStorm pour l'accesseur sur la propriété « artist »
5. Écrivez la méthode « getHtmlForm() » :
   • le paramètre représente l'URL de l'action
   • le formulaire utilisera la méthode POST
   • les champs portent le nom de la propriété correspondante de « Artist »
   • le champ dédié à l'identifiant est caché et reçoit la valeur de l'identifiant de l'instance de « Artist »
   • le champ dédié au nom est obligatoire et reçoit la valeur du nom de l'instance de « Artist »
     Information

     Puisque l'objet « Artist » contenu dans le « ArtistForm » peut être null, il est important d'effectuer des contrôles avant d'essayer d'accéder à ses accesseurs. Pour une syntaxe plus simple et élégante, vous pouvez utiliser l'opérateur « nullsafe » « ?-> »

   • le champ dédié au nom comporte un « label » « Nom »
   • le bouton d'envoi porte le texte « Enregistrer »

1. Créez le trait « Html\StringEscaper » à l'aide de PhpStorm
2. Déplacez la méthode « escapeString() » de la classe « WebPage » vers le trait « StringEscaper »
3. Modifiez la méthode pour que son paramètre puisse être « null » et que la chaîne retournée soit vide dans ce cas
4. Utilisez le trait « Html\StringEscaper » dans la classe « WebPage »
5. Utilisez le trait « Html\StringEscaper » dans la classe « ArtistForm »
6. Protégez la chaîne du nom de l'artiste avant de l'utiliser dans « ArtistForm::getHtmlForm() »

1. Placez le fichier de l'assistant « Dom » (télécharger) dans « tests/_support/Helper/ »
2. Ouvrez ce nouveau fichier dans PhpStorm et corrigez les avertissements en ajoutant automatiquement « ext-dom » et « ext-libxml » dans « require-dev » du fichier « composer.json »
3. Créez une nouvelle suite de « Cest » « Form »

   php vendor/bin/codecept generate:suite Form

4. Modifiez le fichier « Form.suite.yml » de configuration de la suite pour activer l'assistant « Dom »
5. Placez le fichier de « Cest » « ArtistForm » (télécharger) dans « tests/Form/ »
6. Lancez les tests de la suite « Form » :

   php vendor/bin/codecept run Form

7. Corrigez votre classe si nécessaire
8. Ajoutez un script « test:form » dans « composer.json »
9. Mettez à jour la documentation du projet dans « README.md »

Dans le trait « StringEscaper », ajoutez la méthode d'instance « stripTagsAndTrim() » qui a pour objectifs de :

• supprimer les balises
• supprimer les espaces en tête et en queue de chaîne
• retourner une chaîne vide si la valeur est « null »

Dans la classe « ArtistForm », ajoutez la méthode d'instance « setEntityFromQueryString() » qui a pour objectifs de :

• Extraire les données constitutives d'un artiste depuis la « query string » POST
  • l'identifiant de l'artiste s'il est présent et numérique, « null » sinon
  • le nom de l'artiste s'il est présent, lever une « ParameterException » sinon
• Créer un artiste avec les données extraites et nettoyées
• Affecter l'artiste créé à la propriété d'instance

1. Activez le module « Asserts » dans « Form.suite.yml »
2. Ajoutez les méthodes suivantes au « Cest » « Form » dédié à la classe « ArtistForm » :

   /**
    * @dataProvider artistNameProvider
    */
   public function getNewArtistDataFromQueryString(FormTester $I, Example $example)
   {
       $_POST['id'] = '';
       $_POST['name'] = $example['name'];
       $form = new ArtistForm();
       $form->setEntityFromQueryString();
       $I->assertInstanceOf(Artist::class, $form->getArtist());
       $I->assertNull($form->getArtist()->getId());
       $I->assertSame($example['expectedName'], $form->getArtist()->getName());
   }
   
   /**
    * @dataProvider artistNameProvider
    */
   public function getExistingArtistDataFromQueryString(FormTester $I, Example $example)
   {
       $_POST['id'] = '90';
       $_POST['name'] = $example['name'];
       $form = new ArtistForm();
       $form->setEntityFromQueryString();
       $I->assertInstanceOf(Artist::class, $form->getArtist());
       $I->assertSame(90, $form->getArtist()->getId());
       $I->assertSame($example['expectedName'], $form->getArtist()->getName());
   }
   
   protected function artistNameProvider(): array
   {
       return [
           ['name' => 'Artist', 'expectedName' => 'Artist'],
           ['name' => '    Artist        ', 'expectedName' => 'Artist'],
           ['name' => 'Artist', 'expectedName' => 'Artist'],
           ['name' => '      Artist      ', 'expectedName' => 'Artist'],
       ];
   }
   
   public function missingArtistNameFromQueryStringThrowsException(FormTester $I)
   {
       $I->expectThrowable(ParameterException::class, function () {
           $_POST['id'] = '';
           $_POST['name'] = '';
           (new ArtistForm())->setEntityFromQueryString();
       });
   }

3. Vérifiez que les tests passent

1. Créez le programme « public/admin/artist-form.php » dont la structure de base sera la même que ce qui vous a été fourni pour « cover.php » :
2. Testez la présence du paramètre GET « artistId » :
   • S'il est absent, poursuivez en considérant que l'artiste est « null »
   • S'il est présent
     • testez sa forme numérique et levez une « ParameterException » en cas de non conformité
     • recherchez l'artiste correspondant à l'identifiant dans la base de données
3. Construisez une instance de « ArtistForm » que vous utiliserez pour produire un formulaire HTML soumettant les données vers « artist-save.php »

1. Placez le fichier de « Cest » pour l'édition d'un artiste (télécharger) dans « tests/Browse/ »
2. Lancez les tests de la suite « Browse » :

   composer test:browse

3. Corrigez votre programme et vos classes si nécessaire

1. Reprenez la structure de base du programme précédent pour « artist-save.php »
2. Supprimez la gestion des exceptions de type « EntityNotFoundException » qui n'ont pas de sens ici
3. Effectuez les actions nécessaires au traitement des données contenues dans la « query string » POST :
   • Construisez un « ArtistForm »
   • Utilisez-le pour construire l'entité « Artist » à partir de la « query string »
   • Enregistrez l'« Artist » obtenu
   • Redirigez vers l'accueil du site

1. Activez le module « Db » de Codeception dans le fichier « tests/Browse.suite.yml »
2. Ajoutez les méthodes suivantes au « Cest » « Browse » dédié à la modification des artistes :

   /**
    * @depends loadNewArtistFormPage
    */
   public function insertArtist(BrowseTester $I)
   {
       $I->stopFollowingRedirects();
       $I->amOnPage('/admin/artist-form.php');
       $I->submitForm('form', ['name' => 'NewArtist']);
       $I->seeInCurrentUrl('/admin/artist-save.php');
       $I->seeResponseCodeIs(302);
       $I->seeNumRecords(1, 'artist', ['name' => 'NewArtist']);
   }
   
   /**
    * @depends loadNewArtistFormPage
    */
   public function insertArtistWithMissingName(BrowseTester $I)
   {
       $I->amOnPage('/admin/artist-form.php');
       $I->submitForm('form', ['name' => '']);
       $I->seeInCurrentUrl('/admin/artist-save.php');
       $I->seeResponseCodeIs(400);
       $I->seeNumRecords(0, 'artist', ['name' => '']);
   }
   
   /**
    * @depends loadExistingArtistFormPage
    */
   public function updateArtist(BrowseTester $I)
   {
       $I->stopFollowingRedirects();
       $I->amOnPage('/admin/artist-form.php?artistId=4');
       $I->submitForm('form', ['name' => 'UpdatedArtist']);
       $I->seeInCurrentUrl('/admin/artist-save.php');
       $I->seeResponseCodeIs(302);
       $I->seeNumRecords(1, 'artist', [
           'id' => 4,
           'name' => 'UpdatedArtist'
       ]);
   }
   
   /**
    * @depends loadExistingArtistFormPage
    */
   public function updateArtistWithMissingName(BrowseTester $I)
   {
       $I->amOnPage('/admin/artist-form.php?artistId=4');
       $I->submitForm('form', ['name' => '']);
       $I->seeInCurrentUrl('/admin/artist-save.php');
       $I->seeResponseCodeIs(400);
       $I->seeNumRecords(1, 'artist', [
           'id' => 4,
           'name' => 'Slipknot'
       ]);
   }

3. Vérifiez que les tests passent

1. Reprenez la structure de base du programme précédent pour « artist-delete.php »
2. Gérez le contrôle de présence et de validité du paramètre GET « artistId »
3. Chargez l'« Artist » depuis la base de données
4. Supprimez l'« Artist » sélectionné
5. Redirigez vers l'accueil du site

1. Ajoutez les méthodes suivantes au « Cest » « Browse » dédié à la modification des artistes :

   public function deleteArtist(BrowseTester $I)
   {
       $I->stopFollowingRedirects();
       $I->amOnPage('/admin/artist-delete.php?artistId=4');
       $I->seeResponseCodeIs(302);
       $I->seeNumRecords(0, 'artist', [
           'id' => 4,
       ]);
   }
   
   public function deleteArtistWithoutId(BrowseTester $I)
   {
       $I->amOnPage('/admin/artist-delete.php');
       $I->seeResponseCodeIs(400);
       $I->seeNumRecords(8, 'artist');
   }
   
   /**
    * @example { "id": "", "code": 400 }
    * @example { "id": "1000", "code": 404 }
    * @example { "id": "id", "code": 400 }
    */
   
   public function deleteArtistWithWrongId(BrowseTester $I, Example $example)
   {
       $I->amOnPage('/admin/artist-delete.php?artistId=' . $example['id']);
       $I->seeResponseCodeIs($example['code']);
       $I->seeNumRecords(8, 'artist');
   }

2. Vérifiez que les tests passent