Pagination avec Symfony2 et PagerFanta !

Symfony2 Beta1 est sorti depuis quelques semaines, tout va bien !

Alors que je me demandais comment fonctionnait un Bundle je constate qu’il utilise un Pager! Oh, de la pagination! Voilà un sujet intéressant !

Alors le but n’est pas de vous expliquer en profondeur comment va fonctionner le pager, la classe est tellement simple que je vous laisse la découvrir !

Installation

On va installer un Bundle et PagerFanta! PagerFanta est le système de pagination en lui-même, et le Bundle ne fera que gérer la vue et la personnalisation de PagerFanta.

git submodule add http://github.com/whiteoctober/Pagerfanta.git vendor/pagerfanta
git submodule add http://github.com/whiteoctober/WhiteOctoberPagerfantaBundle.git vendor/bundles/WhiteOctober/PagerfantaBundle

On enregistre les namespaces:

// app/autoload.php
$loader->registerNamespaces(array(
// ...
'WhiteOctober\PagerfantaBundle' => __DIR__.'/../vendor/bundles',
'Pagerfanta' => __DIR__.'/../vendor/pagerfanta/src',
// ... ));

Puis on enregistre le Bundle

// app/AppKernel.php
public function registerBundles()
{
return array(
// ...
new WhiteOctober\PagerfantaBundle\WhiteOctoberPagerfantaBundle(),
// ...
);
}

Utilisation

Je pars du principe que vous avez un Bundle, un Controller et une Vue ! Et une base de données ! Dans mon cas ça sera Mysql.

PagerFanta fonctionne en utilisant le Pattern Adaptateur, c’est-à-dire qu’on peut utiliser n’importe quelles classes implémentant l’interface AdapterInterface. On pourra ainsi utiliser Doctrine ORM ou ODM ou d’autres, tant qu’on se débrouille pour renvoyer le résultat.

Premièrement on instancie un nouvel objet Adaptateur: DoctrineORMAdapter dans lequel on passe une instance de queryBuilder. C’est la requête que l’on effectuera pour récupérer notre contenu.

On passe ensuite l’objet DoctrineORMAdapter au constructeur de PagerFanta.
A partir de là, on peut commencer à personnaliser notre objet de pagination:

$pagerfanta->setMaxPerPage($maxPerPage); // 10 par défaut
$maxPerPage = $pagerfanta->getMaxPerPage();

$pagerfanta->setCurrentPage($currentPage); // 1 par défaut
$currentPage = $pagerfanta->getCurrentPage();

$nbResults = $pagerfanta->getNbResults();
$currentPageResults = $pagerfanta->getCurrentPageResults();
$pagerfanta->getNbPages();

$pagerfanta->haveToPaginate();
$pagerfanta->hasPreviousPage();
$pagerfanta->getPreviousPage();
$pagerfanta->hasNextPage();
$pagerfanta->getNextPage();

Grâce à ses méthodes on dispose de toutes les informations qu’il nous faut pour effectuer nos paginations.

Dans la vue

Pour générer la pagination, c’est-à-dire les liens entre chaque page, le Bundle PagerFantaBundle propose une méthode pour twig:

{{ pagerfanta(pagerfanta, 'default') }}

On lui passe notre objet pagerfanta, et on lui applique une vue par défaut.

Pour afficher la liste du contenu, on va appeler une boucle sur l’objet pagerfanta que l’on passera dans le Controller:

{% for data in pagerfanta.currentPageResults %}
<li>{{ data }}</li>
{% endfor %}

On va ainsi afficher les résultats de la page courante, par page je parle toujours des données découpées par la pagination.

Le Controller

Dans la vue, chaque lien généré aura une URL de la sorte : ma-route/?page=x, où x est le numéro de la page.

Lorsqu’on clic sur le lien, il faut récupérer cette valeur dans notre controller. Pour cela on utilise le service request:

$request = $this->get('request');
$page = $request->query->get('page',1);
try {
$pagerfanta->setCurrentPage($page);

} catch (NotValidCurrentPageException $e) {
throw new NotFoundHttpException();
}

$request->query->get(‘page’,1) nous permet de récupérer la valeur de page, et le second argument est la valeur par défaut.

Voici le code de mon Controller:

// pagination
$queryBuilder = $em->createQueryBuilder()
->select('u')
->from('NaN\ArticlesBundle\Entity\Articles', 'u');


$adapter = new DoctrineORMAdapter($queryBuilder);
$pagerfanta = new Pagerfanta($adapter);
$pagerfanta->setMaxPerPage(8); // 8 résultats par page

$request = $this->get('request');
$page = $request->query->get('page',1);
try {
$pagerfanta->setCurrentPage($page);
} catch (NotValidCurrentPageException $e) {
throw new NotFoundHttpException();
}

return array('pagerfanta' => $pagerfanta);

Ainsi on vient de voir comment utiliser simplement et rapidement un système de pagination pour Symfony2 !

Les sources des projets comportent des détails pour personnaliser les paginations, à lire !

PagerFante

PagerFantaBundle