Routage et contrôleurs

Routes

Le système de routage fait qu’une route est une correspondance entre une URL (dans le navigateur) et une méthode PHP (dans le contrôleur).

Il est possible de passer des paramètres de l’URL à la méthode, de manière plus jolie que ?id=1.

Configuration

5 façons possibles :

• PHP (jamais)

• YAML (fichier de configuration route.yaml où on peut mettre toutes les routes — utilisé parfois car cela permet d’avoir toutes les routes au même endroit)

• XML (très similaire au fichier YAML, mais moins bien)

• annotations (/** *@UneAnnotation */ au dessus de la méthode associée — utilisé)

• attributs (avec # au dessus de la méthode associée, c’est ça que fait le make:controller — utilisé)

BP : on utilise maintenant au maximum les attributs.

(Annotations ou) attributs

Ce sont en fait des commentaires interprétés, placés au-dessus du code PHP associé.

Ils doivent impérativement avoir cette forme : #[Route(….)].

Dans le contrôleur, on importe la classe de route de Symfony et on lui donne un alias, puis on crée l’annotation au-dessus de chaque méthode.

...
use Symfony\Component\Routing\Annotation\Route;
...
#[Route('/', name: 'home_index')]
    public function index(): Response
{
	...
}

Paramètres

Dans les paramètres passés à l’attribut, on donne obligatoire l’URL souhaitée de la route et un nom à cette route ; éventuellement, on peut ajouter des conditions (requirements) et des méthodes.

Dans l’URL de la route, on passe entre accolades le paramètre qu’on souhaite prendre en compte dans la méthode.

On peut ajouter des conditions sur ce paramètre avec requirements ou un paramètre par défaut.

#[Route("/utilisateurs/profils/{user}")]
...

#[Route("/utilisateurs/profils/{id}", requirements={"id"="\d+"}))]
...

#[Route("/utilisateurs/profils/{page}")]
public function listusers($page = 1)
{
	...
}

Il existe d’autres conditions au match de la requête :

- method

- host pour rediriger selon l’hôte

- _locale pour la langue

- UTF-8 pour vérifier que le navigateur est bien codé en UTF-8

Console

Afficher la liste des routes : symfony console debug:router

Afficher les détails d’une route : symfony console debug:router name_route

Tester le match entre une URL et une route : symfony console router:match /url-a-tester

Contrôleurs

Un contrôleur est une simple classe PHP, qui hérite du contrôleur de Symfony AbstractController. Il retourne un objet Response.

On peut en créer autant qu’on veut mais chaque méthode du contrôleur n’est lié qu’à une seule page, elle retourne un et un seul Twig.

BP : On essaie de regrouper les méthodes et Twigs qui se ressemble et d’avoir un contrôleur par fonctionnalité.

Pour créer un contrôleur : symfony console make:controller > nomController

Méthodes

Affichage et réponses :

• render()

• json()

• file() pour télécharger un ficher

• createNotFoundException()

Routage :

• redirectToRoute() pour diriger vers un autre contrôleur

• generateURL() pour générer une URL

• redirect() pour diriger vers une autre site web

Sécurité :

• getUser() pour récupérer l’utilisateur connecté

• createAccesDeniedException()

• isGranted() pour vérifier si l’utilisateur a les droits

• denyAccessUnlessGranted() pour interdire l’accès à un utilisateur qui n’a pas les droits

Modèle et données :

• createForm()

• getDoctrine()

Divers :

• addFlash() pour afficher un message qui n’apparaît qu’une fois (ex: confirmation d’ajout en base de données)

Préfixes

Pas obligatoire, ils sont utiles quand on répète plusieurs fois le même début d’URL.

On l’attribut de la route commune au dessus du contrôleur et ainsi toutes les routes commencent par le préfixe.

Les noms de route sont concaténés. On touche pas au chemin du twig.

BP : on laisse le nom de la route dans la fonction avec un underscore, ce qui indique au lecteur qu’on utilise un préfixe.

#[Route('/series', name: 'serie')]
class SerieController
	#[Route('/', name: '_series')]
	public function series(): Response
	{
		return $this->render('serie/series.html.twig', []);
	}
	
	#[Route('/{id}', name: '_serie'), requirements: ['id'=>'\d+'])]
	public function serie(int $id): Response
	{
		return $this->render('serie/serie.html.twig', []);
	}

Débogage

Des paquets permettent d’ajouter une barre de débogage dans le navigateur, en environnement de développement.

Pour installer la barre de débogage : composer require symfony/profiler-pack --dev

Pour installer le paquet pour les dump() sur les variables : composer require symfony/var-dumper --dev

Pour installer le paquet qui affiche les dump() dans la barre : composer require symfony/debug-bundle --dev

Les méthodes disponibles sont dump() pour réaliser un “joli” var_dump() dans la barre de débogage et dd() qui réalise un dump() suivi d’un die() (arrêt du traitement).

La barre montre de nombreuses informations : statut http, @nom de la route, temps de traitement, mémoire utilisée, messages d’erreurs, warnings, temps d’affichage du twig, nombre de requêtes SQL…