Laravel

Plan

1. Formulaire

1.1. Création d'un formulaire

On créer une nouvelle page pour créer un projet et une nouvelle route:

Route::get('/project', [ProjectController::class, 'index']);
Route::get('/project/create', [ProjectController::class, 'create']);

Dans app/Http/Controller/ProjectController.php:

public function create()
 {
     return view('project.create');
 }

Puis on créer resources/views/project/create.blade.php avec la même structure html

Optionnel: on peut ajouter un lien sous notre liste de projet

<a href="/project/create">Créer un nouveau projet</a>

@extends('layout')
@section('title','Project Create')

@section('content')
<h2>Créer un nouveau projet</h2>
<form>
    <div>
        <input type="text" name="title" placeholder="Titre du projet">
    </div>
    <div>
        <textarea name="description" placeholder="Description du projet"></textarea>
    </div>
    <div>
        <button type="submit">Créer le projet</button>
    </div>
</form>
@endsection

→ on check et on test avec un submit
→ remarquer les paramètres get: http://localhost:8000/projects/create?title=test+titre&description=test+description

1.2. Gestion des soumissions de formulaires

• On change le formulaire en post et on ajoute une action

  <form method="POST" action="/project">
  

• On a déjà une route ( route/web.php )

  Route::get('/project', [ProjectController::class, 'index']);
  

  → Comment cela va donc marcher? On test -> HTTP exception

• C'est une route en GET

• On créer une route en POST:

  Route::post('/project', [ProjectController::class, 'store']);
  //(store est une convention qu’il est conseillé de suivre)
  

• Puis on va créer la méthode store dans le controller qui sera chargée de traiter le formulaire.

1.3. CSRF

• Dans le controller ProjectController on ajoute la méthode store

  public function store()
  {
      return request()->all(); //pour récupérer les informations du formulaire
  }
  

• On test → On obtient une erreur 419
• https://www.google.fr/search?q=laravel+419&oq=laravel+419
• Problème de token

• Ajout d’un helper spécial @csrf dans le <form>

  <form method="POST" action="/projects">
       @csrf
  

• On peut regarder la source du formulaire (champs hidden) et on check l’envoi du formulaire
• Pour info https://fr.wikipedia.org/wiki/Cross-site_request_forgery

1.4. Gestion soumission des formulaires et sauvegarde en BDD

• On modifie la méthode store() dans le controller ProjectController pour sauvegarder en BDD

  public function store()
   {
       $project = new Project(); //on instancie un nouveau projet
  
       $project->title = request('title'); //on set le titre avec la donnée envoyée du formulaire
       $project->description = request('description');
  
       $project->save(); // on enregistre dans la base
  
       return redirect('/project'); // méthode pour rediriger vers une autre url (en get par défaut)
   }
  

• On test
• On peut aller voir dans la DB

1.5. Mass assignment

1.6. Recap

• On peut créer des formulaire HTML dans les vues, comme d’habitude.
• Les routes peuvent être déclarées en get ou en post.
• On peut donc utiliser la même route et appeler un méthode différente si la requête est en post
• On peut utiliser request()->all() ou request('title') pour récupérer les données envoyées en post, puis on utilise la méthode Eloquent save() pour sauvegarder dans la base de données.

2. RESTful

2.1. REST

REST (Representation State Transfert) est une façon de définir nos routes pour représenter nos fonctionnalités CRUD Dans un environnement REST, CRUD correspond souvent au méthodes http:

• POST
• GET
• PUT
• DELETE

2.2. Les 7 RESTful routes

2.3. Controllers resource

• Artisan crée la structure typique d’un CRUD:

  php artisan help make:controller
  php artisan make:controller -r ProjectController
  

• Dans la route:

  Route::resource('/project', ProjectController::class);
  

• On peut enregistrer plusieurs contrôleurs “ressource” à la fois:

  Route::resources([
      'photos' => ProjectController::class,
      'posts' => PostController::class
  ])
  

2.4. Méthodes spoofing

Les formulaires HTML ne peuvent pas réaliser des requêtes PUT, PATCH ou DELETE (les formulaires peuvent uniquement faire des requêtes POST ou GET), on doit ajouter un champ caché @method. ex: @method('PUT')

2.5. Routes ressources partielles

Il est possible de limiter les actions acceptées par une route ressource:

Route::resource('photos', PhotoController::class)->only([
    'index', 'show'
]);

Route::resource('photos', PhotoController::class)->except([
    'create', 'store', 'update', 'destroy'
]);

2.6. Route model binding

public function show($id)
{
  $project = Project::find($id);
}

public function show(Project $project)
{
}

3. Relationships

3.1. Eloquent Relationships

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Project extends Model
{
    // Get the user the project.
    public function user()
    {
        return $this->belongs(User::class);
    }
    // Get the tasks for the project.
    public function tasks()
    {
        return $this->hasMany(Task::class);
        // Select * from tasks where project_id = 1
    }
}

<?php
$tasks = \App\Model\Project::find(1)->tasks;
foreach ($tasks as $task) {
    //
}

• hasOne
• hasMany
• belongsTo
• belongsToMany

3.2. Foreign keys

public function up()
{
    Schema::create('projects', function (Blueprint $table) {
        $table->bigIncrements('id');
        $table->unsignedBigInteger('user_id');
        $table->string('title');
        $table->text('description');
        $table->timestamps();

        $table->foreign('user_id')
            ->references('id')
            ->on('users')
            ->onDelete('cascade');
    });
}

Ou on peut simplifier avec

public function up()
{
    Schema::create('projects', function (Blueprint $table) {
        $table->bigIncrements('id');
        $table->string('title');
        $table->text('description');
        $table->timestamps();

        $table->foreignId('user_id')
            ->constrained()
            ->onUpdate('cascade')
            ->onDelete('cascade');
    });
}

4. Factories & Seeder

4.1. Factories

php artisan make:factory ProjectFactory

 public function definition()
{
    return [
        'user_id' => \App\Models\User::factory(),
        'title' => $this->faker->sentence,
        'description' => $this->faker->paragraph
    ];
}

\App\Models\Project::factory(5)->create();

4.2. Seeders

• Dans database/seeders/DatabaseSeeder.php on peut appeler nos factories:

  public function run()
  {
      \App\Models\User::factory(2)->create();
      \App\Models\Project::factory(10)->create();
  }
  

• Puis

  php artisan migrate:fresh --seed -v
  

• On peut lier nos factories et créer par exemple 5 projets par utilisateur:

  public function run()
  {
      $users = \App\Models\User::factory(2)->has(\App\Models\Project::factory()->count(5))->create();
  }
  

• Nous devons d’abords lier notre modèle User avec notre modèle Project, dans notre model user on ajoute la méthode:

  public function project()
  {
      return $this->hasMany(Project::class,'user_id');
  }
  

5. Validation des formulaires

5.1. Scénario et routes

5.2. Validation des données

• La validation des données de formulaire est cruciale pour la sécurité et l'intégrité des données.

• Laravel offre une façon simple et efficace de valider les données soumises à l'aide de la méthode validate() disponible dans l'objet Request.

  $request->validate([
      'nom' => 'required|max:255',
      'email' => 'required|email|unique:users,email_address',
  ]); 
  

• Ceci garantit que les données soumises respectent les règles spécifiées.
• Si les données ne passent pas la validation, Laravel renvoie automatiquement l'utilisateur au formulaire avec les messages d'erreur correspondants.
• Pour voir toutes les règles de validations possibles:
  https://laravel.com/docs/master/validation#available-validation-rules

5.3. Les vues (Formulaire et confirmation)

• En cas de réception du formulaire suite à des erreurs, on reçoit une variable $errors qui contient un tableau avec comme clés les noms des contrôles et comme valeurs les textes identifiant les erreurs.
• La variable $errors est générée systématiquement pour toutes les vues.

• On teste la présence d’une erreur pour chaque contrôle en ajustant le style et en affichant le texte de l’erreur si nécessaire avec la méthode first :

  <p style="color:red">{{$errors->first('title')}}</p>
  

• S’il n’y a aucune erreur rien n’est renvoyé et donc rien n’est affiché, sinon on récupère la première (first) et on respecte le format imposé.

@if ($errors->has('title'))
<p style="color:red">{{$errors->first('title')}}</p>
@endif

Ou

@error('title')
<p style="color:red">{{$errors->first('title')}}</p>
@enderror

On peut aussi

<input @error('title') style="border-color:red" @enderror 

• Enfin en cas d’erreur de validation, les anciennes valeurs saisies sont retournées au formulaire et récupérées avec le helper old :

  value="{{ old('nom') }}"
  

• Au départ le formulaire se présente ainsi :

• Pour afficher toutes les erreurs…

@if ($errors->any())
<div class="alert alert-danger">
    <ul>
        @foreach ($errors->all() as $error)
        <li>{{ $error }}</li>
        @endforeach
    </ul>
</div>
@endif

6. Middleware

• C’est un mécanisme pour filtrer les requêtes HTTP qui entrent dans l’application
• Par exemple, vérifier si un utilisateur est authentifié ou non :
  • S’il n’est pas authentifié, on le redirige vers une page de login
  • S’il est authentifié, on laisse l’application s'exécuter normalement
• D’autres exemples: la génération de fichiers logs (fichiers qui listent les événements qui se sont produit dans l’application), vérifier si l’application est en mode maintenance ou non, les redirections, etc.
• Laravel inclut plusieurs middleware par défaut, pour l’authentification et la protection CRSF.
• Ils sont localisés dans le répertoire app/Http/Middleware

• Voir app/Http/Kernel pour le chargement.

7. Authentification

• https://laravel.com/docs/master/authentication
• https://laravel.com/docs/master/starter-kits

7.1. Installation

• Exemple avec laravel breeze:
  https://laravel.com/docs/master/starter-kits#laravel-breeze
  Attention cela va écraser certain fichier comme web.php ou des assets

  composer require laravel/breeze --dev
  php artisan breeze:install
  npm install
  npm run dev
  php artisan migrate
  

• On peut voir php artisan route:list
  http://localhost:8000/login

7.2. Utilisation

• Pour «protéger» une route, on utilise le middleware auth

  Route::get('/dashboard', function () {
      return view('dashboard');
  })->middleware(['auth', 'verified'])->name('dashboard');
  

• Ou un groupe de route

  Route::middleware('auth')->group(function () {
      Route::get('/profile', [ProfileController::class, 'edit'])->name('profile.edit');
      Route::patch('/profile', [ProfileController::class, 'update'])->name('profile.update');
      Route::delete('/profile', [ProfileController::class, 'destroy'])->name('profile.destroy');
  });
  

• Autre example

  Route::get('/', [PagesController::class, 'home'])->middleware('auth');
  

  → On peut tester authentifié ou non

• Dans la vue:

  @auth
  Bonjour {{ Auth::user()->name }}!
  @else
  Bonjour vous n'êtes pas authentifié <a href="{{ route('login') }}">Log in</a>
  @endauth
  

• ou l'inverse

  @guest
  @endguest
  

8. Assets bundling (Vite)

8.1. Rappel frontend / vocabulaire

• Ecosystème javascript
  • node
  • npm
  • package.json
• Scss

8.2. Vite

9. Mail

• Notre application peut avoir besoin d'envoyer des mails. Ex: password reset
• On doit avoir un service / serveur de mail
• Dans un premier temps on va «envoyer» nos mails dans un fichier de log
• Configuration dans le .env → driver log MAIL_MAILER=log
  → fichier de log dans storage/logs/ (on peut faire un tail -f)

• Envoi d’un mail:

  Mail::raw('Ça marche', function ($message) {
      $message->to('email@test.com')
          ->subject('Salut');
  });
  

• Utilisation de mailtrap.io

10. Exemple création projet

10.1. Lié un projet avec l'utilisateur authentifié

• On modifie la méthode store() de notre ProjectController

  Project::create(array_merge(request(['title', 'description']), ['user_id' => auth()->id()]));
  

  → Ne pas oublié d'ajouter user_id dans les fillables de project

• Ou mieux on surcharge la méthode save() du model Project

  public function save(array $options = array())
  {
      $this->user_id = auth()->id();
      parent::save($options);
  }
  

10.2. On envoi un mail à la création du projet

• On modifie la méthode store() de notre ProjectController

  Mail::raw('Projet '.request('title').': '.request('description'), function ($message) {
         $message->to('admin@monsite.com')
             ->subject('Projet créé: '. request('title') );
  });
  

• Ajouter en haut du controller

  use Illuminate\Support\Facades\Mail;
  

• C'est un example «en dur», laravel propose une gestion plus complète des mails. Voir la doc: https://laravel.com/docs/master/mail#generating-mailables

10.3. Ajout d'un message flash

• https://laravel.com/docs/master/responses#redirecting-with-flashed-session-data
• On peut ajouter un message en passant de la «donnée flash» à la session lors de la redirection

• Dans la méthode store() du controller Project

  return redirect('/project')
          ->with('message', 'Projet créé!');
  

• Puis dans la vue

  @if (session('message'))
  <div>
      {{ session('message')}}
  </div>
  @endif
  

11. Évenements

11.1. Patern observeur / observable

shéma

11.2. Création Event / Listener

• Creation Event

  php artisan event:list
  php artisan make:event ProjectCreated
  

• On déclanche l'event dans le controller app\Http\Controller\ProjectController.php

  ProjectCreated::dispatch($project);
  

  → « Un projet a été crée si quelqu'un à besoin de le savoir»

• Création Listener

  php artisan make:listener SuiviManager -e ProjectCreated
  

• App\Listeners\SuiviManager.php

  public function handle(ProjectCreated $event)
  {
      //
      var_dump($event);
      die('Die SuiviManager listener');
  }
  

  → on test rien ne se passe -> on a pas lié les deux

11.3. Lier Event / Listener

• Dans app\Providers\EventServiceProvider.php

  use App\Events\ProjectCreated;
  use App\Listeners\SuiviManager;
  …
  protected $listen = [
      Registered::class => [
          SendEmailVerificationNotification::class,
      ],
      ProjectCreated::class => [
          SuiviManager::class
      ]
  ];
  

  → La liaison dans le provider c'est bien c'est explicite mais difficile à maintenir on peut supprimer

• Event discovery app\Providers\EventServiceProvider.php

  public function shouldDiscoverEvents()
  { 
      return true;
  }
  

  -> va scanner le répértoire listener

11.4. Exemple

• On peut envoyer un mail dans l'event

  use Illuminate\Support\Facades\Mail;
  …
  public function handle(ProjectCreated $event): void
  {
      //
      Mail::raw('Projet '.$event->project->title.': '.$event->project->description,
                function ($message) use ($event){
                    $message->to('admin@monsite.com')
                        ->subject('Projet créé: '. $event->project->title);
                });
  
      //die('Die SuiviManager listener');
  }
  

12. Injection de dépendance, conteneur et façades

13. Tests et Déploiement

13.1. Bonnes pratiques pour tester et déployer des applications Laravel.

14. Conclusion