La pagination avec Symfony et Doctrine

Créer une liste de résultats avec une pagination est très simple avec Symfony. Pour suivre ce petit tuto, je pars du principe que vous avez déjà créé votre modèle et le module qui lui est associé, tout ce qu’il reste à faire est d’afficher les résultats sur la page d’index du module en intégrant un système de pagination.

Création d’une méthode dans le modèle

Bon plutôt que d’utiliser des noms factices, j’ai pris un exemple banal: on veux afficher une liste de news avec les informations sur la news ainsi que le nom de la catégorie et de l’auteur qui sont stockés dans des tables liées. La première chose à faire est donc de créer la fonction chargée de récupérer les données dans la base.

Que fait cette requête ? Elle sélectionne toutes les news actives (on considère qu’une news est active si le champ is_activated est égal à 1), les trie en ordre décroissant par date de création et récupère les données liées dans d’autres tables (la catégorie et le membre qui a posté la news) avec les jointures.

J’utilise innerJoin car dans mon modèle une news a forcément une catégorie et un auteur, si ce n’est pas le cas utilisez leftJoin. En faisant les jointures dans cette fonction on diminue de manière drastique le nombre de requêtes pour l’affichage de la liste.

Notez aussi qu’avec le Doctrine pager, la fonction doit renvoyer $q et pas $q->execute()

Création de l’action dans le contrôleur

Lorsque l’on créer un module en utilisant les lignes de commandes, Symfony génère déjà une requête par défaut pour l’action « index », mais on ne va pas l’utiliser puisque l’on vient de créer une fonction exprès pour ça ! De toute façon en principe il faut écrire les requêtes dans le modèle et pas dans le contrôleur. En plus, cela permet de réutiliser la requête dans un autre module sans avoir à la réécrire.

Avant on va juste faire un petit ajout dans le fichier app.yml de votre application :

Bien on peut maintenant créer notre action dans le contrôleur du module (actions.php)

Simple non? Il ne reste plus qu’à gérer l’affichage dans la vue indexSuccess.php. On va d’abord afficher les résultats (via un pauvre tableau mais bon c’est pour l’exemple)

Et maintenant, toujours dans le même fichier, la pagination en bas du tableau :

Vous êtes libres de styliser comme bon vous semble les liens en mettant des images, des effets…

Optimisations

On a un système qui fonctionne mais on peut encore un peu l’améliorer. Si on a plusieurs modules avec des listes paginées il peut être intéressant de créer un template unique pour l’affichage des liens vers les autres pages.

Pour ce faire, vous pouvez créer un fichier _paginate.php dans le dossier /templates de votre application. Par exemple, si votre application s’appelle « frontend » cela donne /frontend/templates, il doit déjà y avoir un fichier layout.php à cet endroit normalement. Une fois le fichier crée, copiez-y le code suivant :

Vous pouvez désormais appeler le partial _paginate.php depuis n’importe quelle vue en ajoutant le code suivant dans votre vue :

Seule la route est variable dans le code ci-dessus. Pour que cela marche, il faut éditer le fichier routing.yml de votre application et rajouter autant de routes que nécessaires pour l’affichage des listes. Dans cet exemple cela donne :

L’ajout de cette route permet de créer de « joli » liens sans le point d’interrogation et également de s’assurer que le le paramètre get fourni dans l’url est bien un entier positif (sinon erreur 404). Pour s’assurer également qu’un utilisateur ne va pas s’amuser à mettre le numéro d’une page qui n’existe pas, on peut rajouter le code suivant dans l’action index :

Voilà, la prochaine étape sera de gérer la pagination de la liste en prenant en compte les paramètres de recherche d’un utilisateur