PagerfantaBundle

Documentation

Rendering Pagerfantas

First, you'll need to pass an instance of Pagerfanta as a parameter into your template.

<?php

namespace App\Controller;

use App\Entity\BlogPost;
use Pagerfanta\Doctrine\ORM\QueryAdapter;
use Pagerfanta\Pagerfanta;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

final class BlogController extends AbstractController
{
    /**
     * @Route("/blog", name="app_blog_list", methods={"GET"})
     */
    public function listPosts(): Response
    {
        $queryBuilder = $this->get('doctrine')->getRepository(BlogPost::class)->createBlogListQueryBuilder();

        $pagerfanta = new Pagerfanta(
            new QueryAdapter($queryBuilder)
        );

        return $this->render(
            'blog/list.html.twig',
            [
                'pager' => $pagerfanta,
            ]
        );
    }
}

You then call the pagerfanta function in your Twig template, passing in the Pagerfanta instance. The routes are generated automatically for the current route using the variable "page" to propagate the page number. By default, the bundle uses the Pagerfanta\View\DefaultView class to render the pager.

{{ pagerfanta(pager) }}

By default, the "page" variable is also added for the link to the first page. To disable the generation of ?page=1 in the URL, set the omitFirstPage option to true when calling the pagerfanta() Twig function.

{{ pagerfanta(pager, 'default', {'omitFirstPage': true}) }}

You can omit the template parameter to make function call shorter, in this case the default template will be used.

{{ pagerfanta(pager, {'omitFirstPage': true }) }}

If you are using a parameter other than page for pagination, you can set the parameter name by using the pageParameter option when rendering the pager.

{{ pagerfanta(pager, 'default', {'pageParameter': '[other_page]'}) }}

Note that the page parameter MUST be wrapped in brackets (i.e. [other_page]) for the route generator to correctly function.

See the Pagerfanta documentation for the list of supported options.