KnpPaginatorBundle - default order by

Question

I'm trying to get KnpPaginatorBundle to default the "order by" after the query has been made.

I have tried the following but has proven no luck!

[
    'defaultSortFieldName'      => 'i.name',
    'defaultSortDirection'      => 'desc'
]

The reason for doing it like this is because my next sort-able option doesn't need to sort by name hence not wanting to include the order by in the query.

Any ideas?

Answer 1

I belive the KnpPaginatorBundle will alter and play with your $_GET globals, which is not ideal. I have found the better alternative is to control sorting yourself.

A minimal example:

<?php

namespace App\Repository;

use App\Entity\Blog;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepository;
use Knp\Component\Pager\PaginatorInterface;
use Symfony\Bridge\Doctrine\RegistryInterface;
use Doctrine\ORM\Query\Expr;

/**
 * @method Blog|null find($id, $lockMode = null, $lockVersion = null)
 * @method Blog|null findOneBy(array $criteria, array $orderBy = null)
 * @method Blog[]    findAll()
 * @method Blog[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
 */
class BlogRepository extends ServiceEntityRepository
{
    private const LIMIT_BLOGS_PER_PAGE = 20;
    private $paginator;

    public function __construct(RegistryInterface $registry, PaginatorInterface $paginator)
    {
        $this->paginator = $paginator;
        parent::__construct($registry, Blog::class);
    }

    public function getPaginatedBlogs(int $page, array $params = [], bool $isPublished = true)
    {
        list($sortKey, $order) = $this->getSorting(@$params['sort']);

        $qb = $this->createQueryBuilder('blog')
            ->where('blog.is_published = :is_published')
            ->setParameter('is_published', $isPublished);

        // Sort by order as requested by user
        $qb->orderBy($sortKey, $order);

        return $this->paginator->paginate(
            $qb->getQuery(),
            $page,
            self::LIMIT_BLOGS_PER_PAGE,
            []
        );
    }

    private function getSorting($sort)
    {
        switch ($sort) {
            case 'updated':
                $sortKey = 'blog.updated';
                $order = 'DESC';
                break;

            case 'title':
                $sortKey = 'blog.title';
                $order = 'ASC';
                break;

            default:
                $sortKey = 'blog.created';
                $order = 'DESC';
                break;
        }

        return [$sortKey, $order];
    }
}