Passer des paramètres aux routes (paramètres obligatoires et optionnels)

Dynamiser vos URL : l'importance des paramètres de route

Dans la construction d'applications web, il est rare que toutes les pages soient statiques. Souvent, vous avez besoin d'afficher des informations spécifiques basées sur un identifiant, un slug, ou toute autre valeur variable présente dans l'URL. Par exemple, afficher le profil d'un utilisateur spécifique (/utilisateurs/123), un article de blog (/articles/mon-super-article), ou des produits filtrés (/produits/categorie/electronique). C'est là qu interviennent les paramètres de route dans Laravel.

Les paramètres de route vous permettent de capturer des segments de l'URI et de les rendre disponibles comme variables dans votre logique de route (que ce soit une closure ou une méthode de contrôleur). Laravel offre une syntaxe simple et expressive pour définir ces paramètres, vous permettant de construire des URL dynamiques et significatives. Cette fonctionnalité est cruciale pour créer des applications interactives et riches en contenu.

Ce chapitre se concentre sur deux types de paramètres de route : les paramètres obligatoires, qui doivent impérativement être présents dans l'URL pour que la route corresponde, et les paramètres optionnels, qui peuvent être omis sans empêcher la route de fonctionner, souvent en utilisant une valeur par défaut. Maîtriser ces deux concepts vous donnera une grande flexibilité dans la conception de la structure de vos URL.

Paramètres de route obligatoires : capturer les segments essentiels de l'URL

Un paramètre de route obligatoire est un segment de l'URI qui doit être présent pour que la route soit activée. Si ce segment est manquant, Laravel considérera que l'URL ne correspond pas à la route définie (résultant souvent en une erreur 404 Not Found).

Pour définir un paramètre obligatoire, vous l'encadrez d'accolades {} dans la chaîne de définition de l'URI de votre route. Le nom que vous donnez entre les accolades devient le nom de la variable qui sera injectée dans votre fonction de rappel de route ou dans la méthode de votre contrôleur. Par exemple :

use Illuminate\Support\Facades\Route;

Route::get('/utilisateurs/{id}', function ($id) {
    return 'Affichage du profil de l'utilisateur avec l'ID : ' . $id;
});

Dans cet exemple, si un utilisateur visite /utilisateurs/42, la fonction anonyme recevra '42' comme valeur pour la variable $id. Si l'URL visitée est simplement /utilisateurs (sans ID), cette route ne correspondra pas.

Vous pouvez définir plusieurs paramètres obligatoires dans une même route. Ils seront passés à votre fonction ou méthode de contrôleur dans l'ordre où ils apparaissent dans l'URI :

Route::get('/articles/{categorie}/{slug}', function ($categorie, $slug) {
    return 'Affichage de l'article : ' . $slug . ' dans la catégorie : ' . $categorie;
});

Si vous visitez /articles/technologie/nouveautes-laravel-11, alors $categorie sera 'technologie' et $slug sera 'nouveautes-laravel-11'.

Il est important de noter que les paramètres de route sont injectés dans votre closure ou méthode de contrôleur en fonction de leur nom et de leur ordre. Laravel est suffisamment intelligent pour faire correspondre les noms des paramètres de route aux noms des arguments de votre fonction. Si vous utilisez l'injection de dépendances (par exemple, injecter la classe Request), assurez-vous que vos paramètres de route suivent les dépendances injectées :

use Illuminate\Http\Request;

Route::get('/posts/{post}/comments/{comment}', function (Request $request, $postId, $commentId) {
    // $postId contiendra la valeur de {post}
    // $commentId contiendra la valeur de {comment}
    // $request est l'instance de la requête HTTP actuelle
    return "Post ID: {$postId}, Comment ID: {$commentId}";
});

Paramètres de route optionnels : ajouter de la flexibilité avec des valeurs par défaut

Parfois, vous souhaiterez qu'un segment de l'URL soit optionnel. Par exemple, une page de résultats de recherche pourrait avoir un paramètre pour le terme de recherche, mais devrait aussi fonctionner si aucun terme n'est fourni, affichant peut-être tous les résultats ou une page par défaut.

Pour définir un paramètre de route optionnel, vous ajoutez un point d'interrogation ? après le nom du paramètre dans la définition de l'URI. Il est crucial de fournir une valeur par défaut à l'argument correspondant dans votre fonction de rappel ou méthode de contrôleur. Si le segment optionnel n'est pas présent dans l'URL, cette valeur par défaut sera utilisée.

Route::get('/recherche/{terme?}', function ($terme = null) {
    if ($terme) {
        return 'Résultats de la recherche pour : ' . $terme;
    } else {
        return 'Veuillez entrer un terme de recherche ou afficher tous les résultats.';
    }
});

Avec cette configuration :

• Visiter /recherche/laravel assignera 'laravel' à $terme.
• Visiter /recherche/ (ou /recherche) assignera la valeur par défaut (null dans ce cas) à $terme.

Vous pouvez également spécifier une valeur par défaut non nulle directement dans la signature de la fonction :

Route::get('/salutations/{nom?}', function ($nom = 'Cher visiteur') {
    return 'Bonjour, ' . $nom . ' !';
});

Ici, /salutations/Alice affichera "Bonjour, Alice !", tandis que /salutations affichera "Bonjour, Cher visiteur !".

Il est important de noter que les paramètres optionnels avec des valeurs par défaut doivent généralement être placés à la fin des segments d'URI de votre route ou avant d'autres paramètres optionnels. Avoir un paramètre obligatoire après un paramètre optionnel peut conduire à des ambiguïtés dans la résolution des routes, bien que Laravel essaie de gérer cela intelligemment. Par exemple, /foo/{bar?}/baz est une construction qui pourrait être problématique si {bar} est omis, car Laravel ne saurait pas si 'baz' est la valeur de {bar} ou le segment littéral 'baz'. La convention est de mettre les optionnels à la fin : /foo/baz/{bar?}.

Contraintes sur les paramètres : affiner la correspondance des routes

Pour plus de contrôle, vous pouvez imposer des contraintes sur les valeurs que vos paramètres de route peuvent accepter en utilisant la méthode where. Ces contraintes sont définies à l'aide d'expressions régulières.

Par exemple, si un paramètre id doit toujours être numérique :

Route::get('/produit/{id}', function ($id) {
    return 'Détails du produit ID : ' . $id;
})->where('id', '[0-9]+'); // Accepte uniquement les chiffres

Si vous essayez d'accéder à /produit/abc, cette route ne correspondra pas, et Laravel cherchera une autre route correspondante ou renverra une erreur 404.

Vous pouvez appliquer des contraintes à plusieurs paramètres :

Route::get('/utilisateur/{id}/{nom}', function ($id, $nom) {
    return 'Utilisateur ID: ' . $id . ', Nom: ' . $nom;
})
->where('id', '[0-9]+')
->where('nom', '[a-zA-Z]+'); // Accepte uniquement les lettres pour le nom

Laravel fournit également quelques motifs d'expressions régulières courants que vous pouvez utiliser comme raccourcis avec whereAlpha, whereNumber, whereAlphaNumeric, et whereUuid, whereUlid (depuis Laravel 9+) :

Route::get('/item/{id}', ...)->whereNumber('id');
Route::get('/user/{name}', ...)->whereAlpha('name');
Route::get('/commande/{token}', ...)->whereAlphaNumeric('token');
Route::get('/document/{uuid}', ...)->whereUuid('uuid');

Si vous avez une contrainte qui s'applique à de nombreuses routes (par exemple, tous les paramètres id doivent être numériques), vous pouvez définir des contraintes globales dans la méthode boot de votre App\Providers\RouteServiceProvider en utilisant la méthode Route::pattern() :

// Dans app/Providers/RouteServiceProvider.php
public function boot()
{
    Route::pattern('id', '[0-9]+');
    Route::pattern('slug', '[a-z0-9\-]+');

    parent::boot();
}

Une fois ces motifs globaux définis, ils seront automatiquement appliqués à toutes les routes utilisant des paramètres nommés id ou slug. La maîtrise des paramètres obligatoires, optionnels et de leurs contraintes vous offre un contrôle précis sur la structure des URL de votre application Laravel, la rendant plus robuste et conviviale.