KnpPaginatorBundle
v6.6.1
Дружественный пагинатор Symfony для разбивки всего на страницы
Обычно этот пакет основан на компоненте Knp Pager. Этот компонент представляет другой способ обработки страниц. Подробнее о внутренней логике можно прочитать по данной ссылке на документацию.
Примечание. Синхронизируйте компоненты knp с этим пакетом. Если вы хотите использовать более старую версию KnpPaginatorBundle — используйте в репозитории теги v3.0 или v4.X , которые подходят для разбиения на страницы запросов ODM MongoDB и ORM 2.0.
Для получения подробной информации об изменениях, пожалуйста, прочитайте о выпусках.
>=4.4 .>=6.4 .>=3.0 . Примечание. Использование нескольких пагинаторов требует установки псевдонима , чтобы сохранить неконфликтующие параметры.
composer require knplabs/knp-paginator-bundleЕсли вы не используете flex (вам следует это сделать), вам нужно вручную включить пакет:
// app / AppKernel . php
public function registerBundles ()
{
return [
// ...
new Knp Bundle PaginatorBundle KnpPaginatorBundle (),
// ...
];
}Вы можете настроить имена и шаблоны параметров запроса по умолчанию, а также несколько других параметров:
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
]
]);
}; Это можно использовать «из коробки» в ключе knp_paginator.template.pagination :
@KnpPaginator/Pagination/sliding.html.twig (по умолчанию)@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 Это можно использовать «из коробки» в ключе knp_paginator.template.rel_links :
@KnpPaginator/Pagination/rel_links.html.twig (по умолчанию) Это можно использовать «из коробки» в ключе knp_paginator.template.sortable :
@KnpPaginator/Pagination/sortable_link.html.twig (по умолчанию)@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 Это можно использовать «из коробки» в ключе knp_paginator.template.filtration :
@KnpPaginator/Pagination/filtration.html.twig (по умолчанию)@KnpPaginator/Pagination/bootstrap_v5_filtration.html.twig@KnpPaginator/Pagination/twitter_bootstrap_v4_filtration.html.twigВ настоящее время пагинатор может разбивать на страницы:
arrayDoctrineDBALQueryQueryBuilderDoctrineORMQueryDoctrineORMQueryBuilderDoctrineODMMongoDBQueryQueryDoctrineODMMongoDBQueryBuilderDoctrineODMPHPCRQueryQueryDoctrineODMPHPCRQueryBuilderQueryBuilderDoctrineCommonCollectionArrayCollection — любая коллекция отношений Doctrine, включаяModelCriteria — запрос Propel ORMSolarium_Client и Solarium_Query_Select в качестве элементов // 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 >Для перевода следующего текста:
%foo% name с ключом перевода table_header_name . Перевод находится в messages домена.{0} No author|{1} Author|[2,Inf] Authors с ключом перевода table_header_author . Перевод находится в messages домена.TranslationCount и TranslationParameters можно комбинировать.
< 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 > Вы также можете переопределить переводы, создав файл перевода в следующем формате имени: domain.locale.format . Итак, чтобы создать файл перевода для этого пакета, вам нужно создать, например, файл KnpPaginatorBundle.tr.yaml в каталоге project_root/translations/ и добавить туда свои переводы:
label_previous : " Önceki "
label_next : " Sonraki "
filter_searchword : " Arama kelimesi "Если вы соответствующим образом установите перевод по умолчанию для конфигурации:
framework :
default_locale : trSymfony выберет его автоматически.
Вы можете автоматически внедрить службу разбиения на страницы в другую службу, используя тег DIC knp_paginator.injectable . Тег принимает один необязательный аргумент paginator , который является идентификатором службы разбиения на страницы, которую следует внедрить. По умолчанию используется knp_paginator .
Класс, который получает службу KnpPaginator, должен реализовать KnpBundlePaginatorBundleDefinitionPaginatorAwareInterface . Если вам лень, вы также можете просто расширить базовый класс KnpBundlePaginatorBundleDefinitionPaginatorAware .
Предупреждение об использовании
PaginatorAwareInterfaceне рекомендуется и может быть удалено в будущей версии. Не следует полагаться на внедрение сеттера, а только на правильное внедрение в конструктор. Рекомендуется использовать встроенный механизм автоподключения Symfony.
Служба knp_paginator будет создана лениво, если установлен пакет symfony/proxy-manager-bridge .
Для получения дополнительной информации о ленивых сервисах обратитесь к документации Symfony по внедрению зависимостей.
<? 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 (при необходимости замените «en» на код вашего собственного языка). Затем добавьте эти строки: label_next : Next
label_previous : Previous<rel> имеют смысл только при использовании нумерации страниц и не имеют отношения к сортировке или фильтрации. Пожалуйста, сначала прочитайте этот пост.
Эту библиотеку поддерживают следующие люди (в алфавитном порядке):
