KnpPaginatorBundleダウンロード - KnpPaginatorBundleソースコードのダウンロード

KnpPaginatorBundle の紹介

すべてをページネーションするフレンドリーな Symfony ページネーター

通常、このバンドルは Knp Pager コンポーネントに基づいています。このコンポーネントは、ページネーション処理の別の方法を導入します。内部ロジックの詳細については、指定されたドキュメントのリンクを参照してください。

注: knp-component をこのバンドルと同期させてください。古いバージョンの KnpPaginatorBundle を使用する場合は、 ODM MongoDBおよびORM 2.0クエリのページ分割に適したリポジトリ内のv3.0またはv4.Xタグを使用してください。

要件：

Knp Pager コンポーネント>=4.4 。
KnpPaginatorBundle のマスターは Symfony >=6.4バージョンと互換性があります。
Twig テンプレートエンジンを使用する場合は、Twig バージョン>=3.0が必要です。

特徴：

特定のアダプターを初期化する必要はありません。
ページネーションビュー、イベントサブスクライバーなど、必要に応じてカスタマイズできます。
リクエストパラメータに応じてカスタムフィルタリング、ソート機能を追加する可能性。
関心事の分離。ページネータは、ページネーションビューのみを生成する責任を負います。ページネーションビューは、表現を目的としています。

注:複数のページネータを使用するには、パラメータが競合しないようにエイリアスを設定する必要があります。

より詳細なドキュメント:

カスタムページネーションサブスクライバーの作成
ビューのテンプレートと引数のカスタマイズ

インストールと構成:

Composer を使用すると非常に簡単です。実行します

composer require knplabs/knp-paginator-bundle

PaginatorBundle をアプリケーションカーネルに追加する

flex を使用しない場合 (そうすべきです)、バンドルを手動で有効にする必要があります。

 // app / AppKernel . php
public function registerBundles ()
{
    return [
        // ...
        new Knp  Bundle  PaginatorBundle  KnpPaginatorBundle (),
        // ...
    ];
}

構成例

デフォルトのクエリパラメータ名とテンプレート、およびその他のいくつかのオプションを構成できます。

YAML:

 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

PHP:

 // 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

rel リンクタグテンプレートのサンプル

これは、 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

使用例:

コントローラ

現在、paginator は次のページネーションを実行できます。

array
DoctrineDBALQueryQueryBuilder
DoctrineORMQuery
DoctrineORMQueryBuilder
DoctrineODMMongoDBQueryQuery
DoctrineODMMongoDBQueryBuilder
DoctrineODMPHPCRQueryQuery
DoctrineODMPHPCRQueryBuilderQueryBuilder
DoctrineCommonCollectionArrayCollection - を含む任意の Doctrine リレーションコレクション
ModelCriteria - ORM クエリを推進する
Solarium_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という名前形式で翻訳ファイルを作成して、翻訳をオーバーライドすることもできます。したがって、このバンドルの翻訳ファイルを作成するには、たとえばproject_root/translations/の下にKnpPaginatorBundle.tr.yamlファイルを作成し、そこに翻訳を追加する必要があります。

 label_previous : " Önceki "
label_next : " Sonraki "
filter_searchword : " Arama kelimesi "

それに応じて構成のデフォルトの変換を設定すると、次のようになります。

 framework :
    default_locale : tr

symfony が自動的にそれを選択します。

依存関係の注入

knp_paginator.injectable DIC タグを使用すると、ページネータサービスを別のサービスに自動的に挿入できます。このタグは、オプションの引数paginator 1 つ取ります。これは、挿入される必要がある paginator サービスの ID です。デフォルトはknp_paginatorです。

KnpPaginator サービスを受け取るクラスはKnpBundlePaginatorBundleDefinitionPaginatorAwareInterfaceを実装する必要があります。面倒な場合は、単にKnpBundlePaginatorBundleDefinitionPaginatorAware基本クラスを拡張することもできます。

PaginatorAwareInterfaceを使用する警告は推奨されず、将来のバージョンでは削除される可能性があります。セッター注入には依存せず、適切なコンストラクター注入のみに依存する必要があります。 Symfony の組み込み自動配線メカニズムを使用することが推奨される方法です。

怠惰なサービス

パッケージsymfony/proxy-manager-bridgeがインストールされている場合、 knp_paginatorサービスは遅延して作成されます。

遅延サービスの詳細については、依存関係の注入に関する Symfony のドキュメントを参照してください。

XML構成例

<? 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 >

トラブルシューティング

Symfony 設定でトランスレーターが有効化されていることを確認してください。

 framework :
    translator : { fallbacks: ['%locale%'] }

ロケールが使用できない場合は、 translations/KnpPaginatorBundle.en.ymlに独自の翻訳ファイルを作成します (必要に応じて独自の言語コードを「en」に置き換えます)。次に、次の行を追加します。

 label_next : Next
label_previous : Previous

<rel>リンクはページネーションを使用する場合にのみ意味があり、並べ替えやフィルター処理には関係しないことに注意してください。

メンテナー

まずはこの投稿をお読みください。

このライブラリは次の人々によって管理されています (アルファベット順)。

@ガラク
@polc

拡大する

KnpPaginatorBundle