Nous avons vu dans le chapitre précédent un scénario mettant en œuvre un formulaire. Nous n’avons imposé aucune contrainte sur les valeurs transmises. Dans une application réelle, il est toujours nécessaire de vérifier que ces valeurs correspondent à ce qu’on attend. Par exemple un nom doit comporter uniquement des caractères alphabétiques et avoir une longueur maximale, une adresse email doit correspondre à un certain format.

Il faut donc mettre en place des règles de validation. En général on procède à une première validation côté client pour éviter de faire des allers-retours avec le serveur. Mais quelle que soit la pertinence de cette validation côté client elle n’exonère pas d’une validation côté serveur.

Dans l’exemple de ce chapitre je ne prévoirai pas de validation côté client, d’une part ce n’est pas mon propos, d’autre part elle masquerait la validation côté serveur pour les tests.

Scénario et routes

Voici le scénario que je vous propose pour ce chapitre :

Scénario de prise de contact

 

  1. le client demande le formulaire de contact,

  2. le contrôleur génère le formulaire,

  3. le contrôleur envoie le formulaire,

  4. le client remplit le formulaire et le soumet,

  5. le contrôleur teste la validité des informations et là on a deux possibilités :

  • en cas d’échec on renvoie le formulaire au client en l’informant des erreurs et en conservant ses entrées correctes,

  • en cas de réussite on envoie un message de confirmation au client .

Routes

On va donc avoir besoin de 2 routes :

Route::get('contact', 'ContactController@create');
Route::post('contact', 'ContactController@store');

On aura une seule url (avec verbe « get » pour demander le formulaire et verbe « post » pour le soumettre) :

http://monsite.fr/contact

Les vues

Le template

Pour ce chapitre je vais créer un template réaliste avec l’utilisation de Bootstrap pour alléger le code. Voici le code de ce template (resources/views/template.blade.php) :

<!DOCTYPE html>
<html lang="fr">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>Mon joli site</title>
        {!! Html::style('https://netdna.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css') !!}
        <style> textarea { resize: none; } </style>
    </head>
    <body>
        @yield('contenu')
    </body>
</html>

Pour la génération des liens vers la librairie CSS j’ai utilisé la classe Html avec sa méthode style. Il y a un certain nombre de méthodes pratiques dans cette classe que nous découvrirons petit à petit.

J’ai prévu l’emplacement @yield nommé « contenu » pour recevoir les pages du site, pour notre exemple on aura seulement la page de contact et celle de la confirmation.

La vue de contact

La vue de contact va contenir essentiellement un formulaire (resources/views/contact.blade.php) :

@extends('template')

@section('contenu')
    <br>
    <div class="col-sm-offset-3 col-sm-6">
        <div class="panel panel-info">
            <div class="panel-heading">Contactez-moi</div>
            <div class="panel-body"> 
                {!! Form::open(['url' => 'contact']) !!}
                    <div class="form-group {!! $errors->has('nom') ? 'has-error' : '' !!}">
                        {!! Form::text('nom', null, ['class' => 'form-control', 'placeholder' => 'Votre nom']) !!}
                        {!! $errors->first('nom', '<small class="help-block">:message</small>') !!}
                    </div>
                    <div class="form-group {!! $errors->has('email') ? 'has-error' : '' !!}">
                        {!! Form::email('email', null, ['class' => 'form-control', 'placeholder' => 'Votre email']) !!}
                        {!! $errors->first('email', '<small class="help-block">:message</small>') !!}
                    </div>
                    <div class="form-group {!! $errors->has('texte') ? 'has-error' : '' !!}">
                        {!! Form::textarea ('texte', null, ['class' => 'form-control', 'placeholder' => 'Votre message']) !!}
                        {!! $errors->first('texte', '<small class="help-block">:message</small>') !!}
                    </div>
                    {!! Form::submit('Envoyer !', ['class' => 'btn btn-info pull-right']) !!}
                {!! Form::close() !!}
            </div>
        </div>
    </div>
@endsection

Cette vue étend le template vu ci-dessus et renseigne la section « contenu ». Je ne commente pas la mise en forme spécifique à Bootstrap.  Le formulaire est généré avec la classe Form que nous avons déjà vue au chapitre précédent.

La structure des méthodes pour générer les contrôles du formulaire est toujours la même. Prenons par exemple l’email :

{!! Form::email('email', null, ['class' => 'form-control', 'placeholder' => 'Votre email']) !!}

On veut un élément de formulaire (Form) de type « email », avec le nom « email », avec une valeur nulle et avec les attributs « class » et « placeholder » en précisant leur valeur.

Le bouton de soumission ne comporte évidemment pas de valeur et on a donc un paramètre de moins pour lui :

{!! Form::submit('Envoyer !', ['class' => 'btn btn-info pull-right']) !!}

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.

C’est pour cela que je 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 :

{!! $errors->first('nom', '<small class="help-block">:message</small>') !!}

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é.

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

Le formulaire vierge

Après une soumission et renvoi avec des erreurs il pourra se présenter ainsi :

Le formulaire avec des erreurs

Les messages en français

Par défaut les messages sont en anglais. Pour avoir ces textes en français vous devez récupérer les fichiers ici. Placez le dossier « fr » et son contenu dans le dossier resources/lang :

Mise en place du français

Ensuite changez cette ligne dans le fichier config/app.php :

'locale' => 'fr',

Vous devriez avoir votre Laravel en français :

Les messages en français

La vue de confirmation

Pour la vue de confirmation (resources/views/confirm.blade.php) le code est plus simple et on utilise évidemment le même template  :

@extends('template')

@section('contenu')
    <br>
    <div class="col-sm-offset-3 col-sm-6">
        <div class="panel panel-info">
            <div class="panel-heading">Contactez-moi</div>
            <div class="panel-body"> 
                Merci. Votre message a été transmis à l'administrateur du site. Vous recevrez une réponse rapidement.
            </div>
        </div>
    </div>
@endsection

Ce qui donne cette apparence :

La confirmation

La requête de formulaire

Il y a plusieurs façons d’effectuer la validation avec Laravel mais la plus simple et élégante consiste à utiliser une requête de formulaire (Form request).

Nous avons déjà utilisé Artisan qui permet d’effectuer de nombreuses opérations et nous allons encore avoir besoin de lui pour créer une requête de formulaire :

php artisan make:request ContactRequest

Comme par défaut le dossier n’existe pas il est créé en même temps que la classe :

La requête de formulaire et son dossier

Voyons le code généré :

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class ContactRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return false;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            //
        ];
    }
}

La classe générée comporte 2 méthodes :

  • authorize : pour effectuer un contrôle de sécurité éventuel sur l’identité ou les droits de l’émetteur,

  • rules : pour les règles de validation.

On va arranger le code pour notre cas :

<?php

namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class ContactRequest extends FormRequest
{
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'nom' => 'bail|required|between:5,20|alpha',
            'email' => 'bail|required|email',
            'texte' => 'bail|required|max:250'
        ];
    }
}

Au niveau de la méthode rules on retourne un tableau qui contient des clés qui correspondent aux champs du formulaire. Vous retrouvez le nom, l’email et le texte. Les valeurs contiennent les règles de validation. Comme il y en a chaque fois plusieurs elles sont séparées par le signe « | ». Voyons les différentes règles prévues :

  • bail : on arrête de vérifier dès qu’une règle n’est pas respectée,

  • required : une valeur est requise, donc le champ ne doit pas être vide,

  • between : nombre de caractères entre une valeur minimale et une valeur maximale,

  • alpha : on n’accepte que les caractères alphabétiques,

  • email : la valeur doit être une adresse email valide.

Au niveau de la méthode authorize je me suis contenté de renvoyer true parce que nous ne ferons pas de contrôle supplémentaire à ce niveau.

Le contrôleur

On va encore utiliser Artisan pour générer le contrôleur :

php artisan make:controller ContactController

Modifiez le code par défaut pour en arriver à celui-ci :

<?php 

namespace App\Http\Controllers;

use App\Http\Requests\ContactRequest;

class ContactController extends Controller
{
    public function create()
    {
        return view('contact');
    }

    public function store(ContactRequest $request)
    {
        return view('confirm');
    }
}
La méthode create ne présente aucune nouveauté par rapport à ce qu’on a vu au chapitre précédent. On se contente de renvoyer la vue contact qui comporte le formulaire.

La méthode store nécessite quelques commentaires. Vous remarquez le paramètres de type ContactRequest. On injecte dans la méthode une instance de la classe ContactRequest que l’on a précédemment créée. Laravel permet ce genre d’injection de dépendance au niveau d’une méthode. Je reviendrai en détail dans un prochain chapitre sur cette possibilité.

Si la validation échoue parce qu’une règle n’est pas respectée c’est la classe ContactRequest qui s’occupe de tout, elle renvoie le formulaire en complétant les contrôles qui étaient corrects et crée une variable $errors pour transmettre les messages d’erreurs qu’on utilise dans la vue. Vous n’avez rien d’autre à faire !

Vérifiez avec la commande php artisan route:list que tout est correct :

Les routes de l'application

On a bien nos deux routes avec l’url correct, le bon contrôleur avec les méthodes prévues et le middleware web appliqué aux deux routes.

Faites quelques essais avec des erreurs de saisie pour voir le fonctionnement.

D’autre façons d’effectuer la validation

Si vous n’appréciez pas les requêtes de formulaire et leur côté « magique » vous pouvez effectuer la validation directement dans le contrôleur avec la méthode validate. Voici le contrôleur modifié en conséquence :

<?php 

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ContactController extends Controller
{
    public function create()
    {
        return view('contact');
    }

    public function store(Request $request)
    {
        $this->validate($request, [
            'nom' => 'bail|required|between:5,20|alpha',
            'email' => 'bail|required|email',
            'texte' => 'bail|required|max:250'
        ]);

        return view('confirm');
    }
}

Cette fois on injecte dans la méthode store directement la requête (Illuminate\Http\Request). Le fonctionnement est exactement le même.

Si cette méthode validate est encore trop abstraite à votre goût vous pouvez détailler les opérations :

<?php 

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Validator;

class ContactController extends Controller
{
    public function create()
    {
        return view('contact');
    }

    public function store(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'nom' => 'bail|required|between:5,20|alpha',
            'email' => 'bail|required|email',
            'texte' => 'bail|required|max:250'
        ]);

        if ($validator->fails()) {
            return back()->withErrors($validator)->withInput();
        }

        return view('confirm');
    }
}

On utilise la façade Validator en précisant toutes les entrée ($request->all()) et les règles de validation. Ensuite si la validation échoue (fails) on renvoie le formulaire (back) avec les erreurs (withErrors) et les valeurs entrées (withInput) pour pouvoir les afficher dans le formulaire.

Mais pourquoi se compliquer la vie quand on dispose de fonctionnalités plus simples et élégantes ?

En résumé

  • La validation est une étape essentielle de vérification des entrées du client.

  • On dispose de nombreuses règles de validation.

  • Le validateur génère des erreurs explicites à afficher au client.

  • Pour avoir les textes des erreurs en français il faut aller chercher les traductions et les placer dans le bon dossier.

  • Les requêtes de formulaires (Form request) permettent d’effectuer la validation de façon simple et élégante.

  • Il y a plusieurs façons d’effectuer la validation à adapter selon les goûts‌ et les circonstances.

Cours Laravel 5.3 – les bases – la validation

Vous pourrez aussi aimer

2 commentaires sur “Cours Laravel 5.3 – les bases – la validation

  1. Je n’ais pas réussi a modifier la langue.

    J’ai ajouté les 4 fichiers venant de src/fr de github dans un nouveau dossier que j’ai nommé fr
    (resource/lang/fr/)
    et jai changer le locate ‘en’ en ‘fr’. Je soumet le formulaire et une redirection
    s’effectue vers github et me ramène sur ma page de contact.
    Les messages en rouge reste en anglais.

Laisser un commentaire