Example needed on custom filtering/sorting

[keymaster]

In the README, there is mention of the ability to add custom filtering and sorting based on the request parameters.

It might be worthwhile adding an example or two of how to use custom filtering and sorting with the PaginatorBundle.

[Dentxinho]

I'm looking for it. This is a plus over PagerFanta

[l3pp4rd]

sorry, hope to cover it for friday

[l3pp4rd]

for a start: https://knplabs.com/en/blog/knp-paginator-reborn
later will add example for filtering

[Dentxinho]

cool!

[franmomu]

Hi, what about this issue? It would be great to have an example of filtering.

[l3pp4rd]

hm, will take a look today ;)

[l3pp4rd]

well, there are 2 ways to do it,

• one to have code in the controller to check the query params and modify the query builder.
• another one to have a subscriber to modify the query or query builder.

and filter selection which would be controlled by javascript to trigger generated urls.

But in overall, if making those abstract, it would be hard to customize, for example have AND or OR filters. So my advice is to have it in the controller, etc based on query parameters, modify the query. and in template just merge the route parameters for new urls, like pagination template does. This way you would be able to achieve more custom results, which in general I do not see the point to abstract, or make it a part of paginator. Sorting is more predictable.

[franmomu]

Thank you! I think I'll use query params and modify the query in the controller

[clemblanco]

What about the status of that filtering feature ?

[elboletaire]

Still waiting for it!

[gondo]

any update?
also please see #225

[Bladrak]

👍

[bassrock]

Any update on this? 👍

[jiguillen]

Anybody knows how to use filters?

[l3pp4rd]

there is no general way since knp paginator supports different kinds of providers for pagination to be built. If you are only using Doctrine ORM in our company we use https://github.com/DATA-DOG/DataDogPagerBundle there you can easily customize filters in pragmatic way.

[lokhman]

@l3pp4rd From what I can see DataDogPagerBundle doesn't rely on Doctrine Paginator component, but does simple LIMIT functionality, which won't work with complex one-to-many and many-to-many associations.

[l3pp4rd]

@lokhman right, in complex cases you need custom count. we do not make collection joins for that reason, though there is only a single class which may be customized in such cases. for our needs it serves very well.

[deejff]

It's possioble to implement filters with form component and query builder modifications after submission. You can use this wrapper for KnpPaginator https://github.com/deejff/DataGridBundle to apply this approach.

[Mateuszry]

I know that this topic outdated, but I was looking for an example implementation of filtering using the KnpPaginatorBundle and I could not find any. Then I finally find sollution by myself. Filtering works only with Query Object. Here is the example:

    $qb = $em->createQueryBuilder()
        ->from('ExampleBundle:Entity', 'entity')
        ->select("entity");
    $page = $request->query->getInt('page', 1);
    $pagination = $this->get('knp_paginator')->paginate(
        $qb,
        $page,
        10
    );

And render filtration in TWIG:

    {{ knp_pagination_filter(pagination, {
        'entity.name': 'Name',
    }) }}

I hope that this sample implementation of filtering will be convenient for someone.

[amiriskander]

Hello @Mateuszry
Thank you for hinting the twig filtration function knp_pagination_filter.

Do you have any idea how to control the filters created by this function? For example controlling the comparison operator (=, <>, >, <, LIKE) ?

[Mateuszry]

@amiriskander I'm glad I could help!

I'm not sure if this is the answer to your question, because I haven't used this since the publication of the previous post, but if you want to use operator = you should type something in the filter field, but if you want to use LIKE operator you can type *thing or some* or *thi* and it should work.

[jgrygierek]

Maybe try this bundle? https://github.com/lexik/LexikFormFilterBundle

[SabWLD]

Bonjour ,
je travaille sur un moteur de recherche selon plusieurs critères avec symfony et php,
pour cela au début je voudrais choisir un filtre et un mot clé. pour pouvoir afficher un liste des projets qui correspond à ma recherche..mais j'ai pas réussi à le faire.
j'ai besoin un aide pour mon code svp

voici mon contrôleur: j'ai une erreur que listprojets not find,

public function research(Request $request, LesProjetsRepository $LesProjetsRepository)
{
    $searchForm = $this->createForm(ResearchType::class);

    $filtre1 = $request->query->getAlnum('caracteristiques');
    $filtre2 = $request->query->getAlnum('filtre2');

    if ( $filtre1 && $filtre2 ) {
       $motcle= $request->get('motcle');
       $this->log->error('test1');

       if (!empty($motcle)) {
           $repo = $this->getDoctrine()->getRepository(LesProjets::class);
           $this->log->error('test5');
           $listprojets = $repo->findProjetsByName($motcle);
        }
    }

    return $this->render('research/index.html.twig', [
        'search_form' => $searchForm->createView(),
        'listProjets' => $listprojets,
    ]);
}

[Eschyle]

I have a problem on my filter.
In my controller I get all my articles that I return in my view.

public function index(Request $request, ArticleRepository $repo, PaginatorInterface $paginator) {

    $searchForm = $this->createForm(SearchType::class);
    $searchForm->handleRequest($request);
    $articles= $repo->findAll();
    $filteredArticles = $paginator->paginate(
        $articles,
        $request->query->getInt('page', 1),
        10,
    );
    return $this->render('default/home.html.twig', [
        'articles' => $filteredArticles
    ]);
}

But in my view when I try to filter then it doesn't seems to work. I wrote that :
{{ knp_pagination_filter( articles, {'article.title': 'title'} ) }}

In the url it returns "http://myUrl/?filterField=article.title&filterValue=japan" but the articles displayed are still the same.

[stalkerxxl]

I have a problem on my filter. In my controller I get all my articles that I return in my view.

public function index(Request $request, ArticleRepository $repo, PaginatorInterface $paginator) {

    $searchForm = $this->createForm(SearchType::class);
    $searchForm->handleRequest($request);
    $articles= $repo->findAll();
    $filteredArticles = $paginator->paginate(
        $articles,
        $request->query->getInt('page', 1),
        10,
    );
    return $this->render('default/home.html.twig', [
        'articles' => $filteredArticles
    ]);
}

But in my view when I try to filter then it doesn't seems to work. I wrote that : {{ knp_pagination_filter( articles, {'article.title': 'title'} ) }}

In the url it returns "http://myUrl/?filterField=article.title&filterValue=japan" but the articles displayed are still the same.

I have the same problem.. There is a function, but how to use it is not clear.. have you solved this issue?

[garak]

Let me rewrite your example:

public function index(Request $request, ArticleRepository $repo, PaginatorInterface $paginator) {

    $searchForm = $this->createForm(SearchType::class);
    $searchForm->handleRequest($request);
    $articles= $repo->findAll();
    $filteredArticles = $paginator->paginate(
        $articles,  // <-------------- THIS IS JUST WRONG. PLEASE READ THE DOCUMENTATION
        $request->query->getInt('page', 1),
        10,
    );
    return $this->render('default/home.html.twig', [
        'articles' => $filteredArticles
    ]);
}

[stalkerxxl]

Let me rewrite your example:

public function index(Request $request, ArticleRepository $repo, PaginatorInterface $paginator) {

    $searchForm = $this->createForm(SearchType::class);
    $searchForm->handleRequest($request);
    $articles= $repo->findAll();
    $filteredArticles = $paginator->paginate(
        $articles,  // <-------------- THIS IS JUST WRONG. PLEASE READ THE DOCUMENTATION
        $request->query->getInt('page', 1),
        10,
    );
    return $this->render('default/home.html.twig', [
        'articles' => $filteredArticles
    ]);
}

Strange, but your code works for me (sorting and pagination)...
Yes, I know to pass $qb to the paginator...
My question is rather: why is the second array parameter needed for the
{{ knp_pagination_filter( articles, {'article.title': 'title'} ) }}
method?
What does it affect and how to use it {'article.title': 'title'}?
I did a dump() - it just added additional fields to the form and that's it...
I can't figure out how to use it properly...

[garak]

See comment on https://github.com/KnpLabs/KnpPaginatorBundle/blob/master/src/Twig/Extension/PaginationExtension.php#L65