12 - Symfony : Fabriquer ses jeux de données avec FakerPHP

Objectifs

• ✅ Installer la librairie FakerPHP
• ✅ Fabriquer un jeu de données consistant et testable

Pré-requis

​ Avoir terminé la quête

Introduction

Dans la quête précédente, tu as créé les entités Season et Episode afin de parfaire ton Wild-Séries. Parfait 🤩!

Et maintenant que tu as ces deux nouvelles entités, tu te tournes vers ton nouvel outil préféré pour créer un jeu de données que tu pourrais facilement manipuler et maintenir : les Fixtures 😎.

Tu vas donc pouvoir créer toutes les saisons et les épisodes de tes séries préférées. Mais avant ça, réalisons un rapide calcul 🤔 : si j'ai 5 séries, que chacune a en moyenne 8 saisons et que chaque saison possède une vingtaine d'épisodes... 😑

😒 5 x 8 x 20 = 800 ! 😱

😰 Hé bien il ne te reste qu'à créer 840 objets (saisons + épisodes) à la main dans tes fixtures ... Bon courage 💪!

Sommaire

FakerPHP

Ah ! tu es toujours là ... 😌 Bon effectivement il y a un moyen de s'épargner la création manuelle d'un jeu de données complet.

La solution : FakerPHP

FakerPHP est une bibliothèque PHP qui nous permet de génerer des données aléatoirement en fonction de certains critères.

Très bien mais comment ca marche 🤓?

Installation du Composant FakerPhp/Faker

Pour ajouter FakerPhp à la racine de ton projet, passe la commande :

composer require fakerphp/faker

Cela viendra ajouter la bibliothèque à ton projet.

Utilisation

FakerPhp prend tout son sens lors de l'élaboration de fixtures, car il vient nous fournir des données générées là où il nous faudrait mettre une valeur pertinente (prénom, date, prix, email, téléphone, description, etc).

Prenons l'exemple de la création de fixtures de Category :

<?php

namespace App\DataFixtures;

use App\Entity\Category;
use Doctrine\Bundle\FixturesBundle\Fixture;
use Doctrine\Persistence\ObjectManager;

//Tout d'abord nous ajoutons la classe Factory de FakerPhp
use Faker\Factory;

class CategoryFixtures extends Fixture
{
    public function load(ObjectManager $manager): void
    {
        //Puis ici nous demandons à la Factory de nous fournir un Faker
        $faker = Factory::create();

        /**
        * L'objet $faker que tu récupères est l'outil qui va te permettre 
        * de te générer toutes les données que tu souhaites
        */
        for($i = 1; $i <= 5; $i++) {
            $category = new Category();
            //Ce Faker va nous permettre d'alimenter l'instance de Category que l'on souhaite ajouter en base
            $category->setName($faker->word());

            $manager->persist($category);
            // Ici, on crée une référence à l'objet $category sous la forme 'category_1', 'category_2'...
            $this->addReference('category_' . $i, $category);
        }

        $manager->flush();
    }
}

Dans cet exemple, tu remarqueras que nous utilisons une fonction de notre Faker pour avoir un résultat approprié au champ que nous alimentons :

• word() => permet de récupérer un mot pour représenter le nom d'une catégorie

<?php

namespace App\DataFixtures;

use App\Entity\Program;
use Doctrine\Bundle\FixturesBundle\Fixture;
use Doctrine\Common\DataFixtures\DependentFixtureInterface;
use Doctrine\Persistence\ObjectManager;

use Faker\Factory;

class ProgramFixtures extends Fixture implements DependentFixtureInterface
{
    public function load(ObjectManager $manager): void
    {
        $faker = Factory::create();

        // L'objectif est de créer 10 séries qui appartiendront à une catégorie au hasard
        for($i = 1; $i <= 10; $i++) {
            $program = new Program();
            $program->setTitle($faker->words(3, true));
            $program->setSynopsis($faker->paragraphs(2, true));
            $program->setCategory($this->getReference('category_' . $faker->numberBetween(1, 5)));

            $manager->persist($program);
            $this->addReference('program_' . $i, $program);
        }

        $manager->flush();
    }

    public function getDependencies()
    {
        return [
            CategoryFixtures::class,
        ];
    }
}

Cette fois-ci, on utilise d'autres fonctions mises à disposition par Faker :

• words() => permet de récupérer une chaîne de caractères de plusieurs mots pour représenter le titre d'une série.

• numberBetween() => permet de récupérer un chiffre compris dans un interval, ici entre 1 et 5, ce qui correspond aux références créées pour les catégories.

• paragraph() => permet de générer plusieurs paragraphes de texte.

Mais il faut savoir que FakerPhp est capable de créer de la même manière des données de toute sorte :

• firstName() => permet de générer un prénom
• lastName() => permet de générer un nom de famille
• city() => permet de générer une ville
• email() => permet de générer une adresse email
• password() => permet de générer un mot de passe
• et encore beaucoup d'autres que tu pourras découvrir en parcourant la doc 😎. Tu peux aussi ajouter un paramètre pour gérer la langue, et ainsi générer des fixtures adaptées à chaque pays.

💪 Challenge

Alimente encore ton Wild Séries

Sers toi maintenant de FakerPHP afin de créer un jeu données adapté pour :

• Les saisons (5 par série)
• Les épisodes (10 par saison)

Tu seras très certainement amené à utiliser des boucles imbriquées, pour que chaque série possède plusieurs saisons, et que chaque saison possède plusieurs épisodes.

🧐 Critères de validation

• Lorsque symfony console doctrine:fixtures:load est exécuté, il n y a pas de message d'erreur.
• La navigation montre que toutes les données ont bien été insérées et qu'elles sont correctement associées (les séries ont bien des saisons, les saisons ont bien des épisodes).
• Le code est disponible sur un repository GitHub, avec une branche correspondant à cette quête.