KnpPaginatorBundle
v6.6.1
Paginador Symfony amigável para paginar tudo
Geralmente este pacote é baseado no componente Knp Pager. Este componente apresenta uma forma diferente de manipulação de paginação. Você pode ler mais sobre a lógica interna no link de documentação fornecido.
Nota: Mantenha os componentes knp sincronizados com este pacote. Se você quiser usar uma versão mais antiga do KnpPaginatorBundle - use tags v3.0 ou v4.X no repositório que é adequado para paginar consultas ODM MongoDB e ORM 2.0
Para obter detalhes sobre as mudanças, leia sobre os lançamentos.
>=4.4 .>=6.4 .>=3.0 é necessária se você usar o mecanismo de modelagem Twig. Nota: o uso de vários paginadores requer a configuração do alias para manter parâmetros não conflitantes.
composer require knplabs/knp-paginator-bundleSe você não usa flex (deveria), você precisa habilitar manualmente o pacote:
// app / AppKernel . php
public function registerBundles ()
{
return [
// ...
new Knp Bundle PaginatorBundle KnpPaginatorBundle (),
// ...
];
}Você pode configurar nomes e modelos de parâmetros de consulta padrão e algumas outras opções:
knp_paginator :
convert_exception : false # throw a 404 exception when an invalid page is requested
page_range : 5 # number of links shown in the pagination menu (e.g: you have 10 pages, a page_range of 3, on the 5th page you'll see links to page 4, 5, 6)
remove_first_page_param : false # remove the page query parameter from the first page link
default_options :
page_name : page # page query parameter name
sort_field_name : sort # sort field query parameter name
sort_direction_name : direction # sort direction query parameter name
distinct : true # ensure distinct results, useful when ORM queries are using GROUP BY statements
filter_field_name : filterField # filter field query parameter name
filter_value_name : filterValue # filter value query parameter name
page_out_of_range : ignore # ignore, fix, or throwException when the page is out of range
default_limit : 10 # default number of items per page
template :
pagination : ' @KnpPaginator/Pagination/sliding.html.twig ' # sliding pagination controls template
rel_links : ' @KnpPaginator/Pagination/rel_links.html.twig ' # <link rel=...> tags template
sortable : ' @KnpPaginator/Pagination/sortable_link.html.twig ' # sort link template
filtration : ' @KnpPaginator/Pagination/filtration.html.twig ' # filters template // config / packages / paginator . php
<?php declare (strict_types= 1 );
use Symfony Component DependencyInjection Loader Configurator ContainerConfigurator ;
return static function ( ContainerConfigurator $ configurator ): void
{
$ configurator -> extension ( ' knp_paginator ' , [
' convert_exception ' => false , // throw a 404 exception when an invalid page is requested
' page_range ' => 5 , // number of links shown in the pagination menu ( e . g : you have 10 pages , a page_range of 3 , on the 5 th page you ' ll see links
' remove_first_page_param ' => false , // remove the page query parameter from the first page link
' default_options ' => [
' page_name ' => ' page ' , // page query parameter name
' sort_field_name ' => ' sort ' , // sort field query parameter name
' sort_direction_name ' => ' direction ' , // sort direction query parameter name
' distinct ' => true , // ensure distinct results , useful when ORM queries are using GROUP BY statements
' filter_field_name ' => ' filterField ' , // filter field query parameter name
' filter_value_name ' => ' filterValue ' // filter value query parameter name
'page_out_of_range' => 'ignore', // ignore , fix , or throwException when the page is out of range
' default_limit ' => 10 // default number of items per page
],
' template ' => [
' pagination ' => ' @KnpPaginator/Pagination/sliding.html.twig ' , // sliding pagination controls template
' rel_links ' => ' @KnpPaginator/Pagination/rel_links.html.twig ' , // < link rel = ... > tags template
' sortable ' => ' @KnpPaginator/Pagination/sortable_link.html.twig ' , // sort link template
' filtration ' => ' @KnpPaginator/Pagination/filtration.html.twig ' // filters template
]
]);
}; Isso pode ser usado imediatamente na chave knp_paginator.template.pagination :
@KnpPaginator/Pagination/sliding.html.twig (por padrão)@KnpPaginator/Pagination/bootstrap_v5_pagination.html.twig@KnpPaginator/Pagination/twitter_bootstrap_v4_pagination.html.twig@KnpPaginator/Pagination/twitter_bootstrap_v3_pagination.html.twig@KnpPaginator/Pagination/twitter_bootstrap_pagination.html.twig@KnpPaginator/Pagination/foundation_v6_pagination.html.twig@KnpPaginator/Pagination/foundation_v5_pagination.html.twig@KnpPaginator/Pagination/bulma_pagination.html.twig@KnpPaginator/Pagination/semantic_ui_pagination.html.twig@KnpPaginator/Pagination/materialize_pagination.html.twig@KnpPaginator/Pagination/tailwindcss_pagination.html.twig@KnpPaginator/Pagination/uikit_v3_pagination.html.twig Isso pode ser usado imediatamente na chave knp_paginator.template.rel_links :
@KnpPaginator/Pagination/rel_links.html.twig (por padrão) Isso pode ser usado imediatamente na chave knp_paginator.template.sortable :
@KnpPaginator/Pagination/sortable_link.html.twig (por padrão)@KnpPaginator/Pagination/bootstrap_v5_bi_sortable_link.html.twig@KnpPaginator/Pagination/bootstrap_v5_fa_sortable_link.html.twig@KnpPaginator/Pagination/bootstrap_v5_md_sortable_link.html.twig@KnpPaginator/Pagination/twitter_bootstrap_v3_sortable_link.html.twig@KnpPaginator/Pagination/twitter_bootstrap_v4_font_awesome_sortable_link.html.twig@KnpPaginator/Pagination/twitter_bootstrap_v4_material_design_icons_sortable_link.html.twig@KnpPaginator/Pagination/semantic_ui_sortable_link.html.twig@KnpPaginator/Pagination/uikit_v3_sortable.html.twig Isso pode ser usado imediatamente na chave knp_paginator.template.filtration :
@KnpPaginator/Pagination/filtration.html.twig (por padrão)@KnpPaginator/Pagination/bootstrap_v5_filtration.html.twig@KnpPaginator/Pagination/twitter_bootstrap_v4_filtration.html.twigAtualmente o paginador pode paginar:
arrayDoctrineDBALQueryQueryBuilderDoctrineORMQueryDoctrineORMQueryBuilderDoctrineODMMongoDBQueryQueryDoctrineODMMongoDBQueryBuilderDoctrineODMPHPCRQueryQueryDoctrineODMPHPCRQueryBuilderQueryBuilderDoctrineCommonCollectionArrayCollection - qualquer coleção de relações do Doctrine incluindoModelCriteria - Propel consulta ORMSolarium_Client e Solarium_Query_Select como elementos // App Controller ArticleController . php
public function listAction ( EntityManagerInterface $ em , PaginatorInterface $ paginator , Request $ request )
{
$ dql = " SELECT a FROM AcmeMainBundle:Article a " ;
$ query = $ em -> createQuery ( $ dql );
$ pagination = $ paginator -> paginate (
$ query , / * query NOT result * /
$ request -> query -> getInt ( ' page ' , 1 ), / * page number * /
10 / * limit per page * /
);
// parameters to template
return $ this -> render ( ' article/list.html.twig ' , [ ' pagination ' => $ pagination ]);
}<head> : {# rel links for pagination #}
{{ knp_pagination_rel_links( pagination ) }}<body> : {# total items count #}
< div class = " count " >
{{ pagination . getTotalItemCount }}
</ div >
< table >
< tr >
{# sorting of properties based on query components #}
< th >{{ knp_pagination_sortable( pagination , ' Id ' , ' a.id ' ) }}</ th >
< th {% if pagination. isSorted ( ' a.title ' ) %} class = " sorted " {% endif %}>
{{ knp_pagination_sortable( pagination , ' Title ' , ' a.title ' ) }}
</ th >
< th {% if pagination. isSorted ([ ' a.date ' , ' a.time ' ]) %} class = " sorted " {% endif %}>
{{ knp_pagination_sortable( pagination , ' Release ' , [ ' a.date ' , ' a.time ' ]) }}
</ th >
</ tr >
{# table body #}
{% for article in pagination %}
< tr {% if loop . index is odd %} class = " color " {% endif %}>
< td >{{ article . id }}</ td >
< td >{{ article . title }}</ td >
< td >{{ article . date | date ( ' Y-m-d ' ) }}, {{ article . time | date ( ' H:i:s ' ) }}</ td >
</ tr >
{% endfor %}
</ table >
{# display navigation #}
< div class = " navigation " >
{{ knp_pagination_render( pagination ) }}
</ div >Para traduzir o seguinte texto:
%foo% name com chave de tradução table_header_name . A tradução está nas messages do domínio.{0} No author|{1} Author|[2,Inf] Authors com chave de tradução table_header_author . A tradução está nas messages do domínio.TranslationCount e TranslationParameters podem ser combinados.
< table >
< tr >
{# sorting of properties based on query components #}
< th >{{ knp_pagination_sortable( pagination , ' Id ' | trans({ foo : ' bar ' }, ' messages ' ), ' a.id ' ) | raw }}</ th >
< th {% if pagination. isSorted ( ' a.Title ' ) %} class = " sorted " {% endif %}>{{ knp_pagination_sortable( pagination , ' Title ' , ' a.title ' ) | raw }}</ th >
< th >{{ knp_pagination_sortable( pagination , ' Author ' | trans({}, ' messages ' ), ' a.author ' ) | raw }}</ th >
</ tr >
<!-- Content of the table -->
</ table > Você também pode substituir traduções criando um arquivo de tradução no seguinte formato de nome: domain.locale.format . Portanto, para criar um arquivo de tradução para este pacote, você precisa criar, por exemplo, o arquivo KnpPaginatorBundle.tr.yaml em project_root/translations/ e adicionar suas traduções lá:
label_previous : " Önceki "
label_next : " Sonraki "
filter_searchword : " Arama kelimesi "Se você definir a tradução padrão para configuração adequadamente:
framework :
default_locale : trO Symfony irá selecioná-lo automaticamente.
Você pode injetar automaticamente um serviço paginador em outro serviço usando a tag DIC knp_paginator.injectable . A tag recebe um argumento opcional paginator , que é o ID do serviço paginador que deve ser injetado. O padrão é knp_paginator .
A classe que recebe o serviço KnpPaginator deve implementar KnpBundlePaginatorBundleDefinitionPaginatorAwareInterface . Se você estiver com preguiça, também pode simplesmente estender a classe base KnpBundlePaginatorBundleDefinitionPaginatorAware .
O aviso de uso
PaginatorAwareInterfacenão é recomendado e pode ser removido em uma versão futura. Você não deve confiar na injeção do setter, mas apenas na injeção adequada do construtor. Usar o mecanismo de autowiring integrado do Symfony é o caminho sugerido.
O serviço knp_paginator será criado lentamente se o pacote symfony/proxy-manager-bridge estiver instalado.
Para obter mais informações sobre serviços lentos, consulte a documentação do Symfony sobre injeção de dependência.
<? xml version = " 1.0 " ?>
< container xmlns = " http://symfony.com/schema/dic/services "
xmlns : xsi = " http://www.w3.org/2001/XMLSchema-instance "
xsi : schemaLocation = " http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd " >
< parameters >
< parameter key = " my_bundle.paginator_aware.class " >MyBundleRepositoryPaginatorAwareRepository</ parameter >
</ parameters >
< services >
< service id = " my_bundle.paginator_aware " class = " my_bundle.paginator_aware.class " >
< tag name = " knp_paginator.injectable " paginator = " knp_paginator " />
</ service >
</ services >
</ container > framework :
translator : { fallbacks: ['%locale%'] }translations/KnpPaginatorBundle.en.yml (substitua "en" pelo seu próprio código de idioma, se necessário). Em seguida, adicione estas linhas: label_next : Next
label_previous : Previous<rel> só são significativos ao usar paginação, eles não são relevantes para classificação ou filtragem. Por favor, leia esta postagem primeiro.
Esta biblioteca é mantida pelas seguintes pessoas (classificadas em ordem alfabética):
