KnpPaginatorBundle 다운로드 - KnpPaginatorBundle 소스 코드 다운로드

KnpPaginatorBundle 소개

모든 것을 페이지로 매길 수 있는 친숙한 Symfony 페이지네이터

일반적으로 이 번들은 Knp Pager 구성 요소를 기반으로 합니다. 이 구성 요소는 페이지 매김 처리의 다른 방법을 도입합니다. 해당 문서 링크에서 내부 논리에 대한 자세한 내용을 읽을 수 있습니다.

참고: knp 구성 요소를 이 번들과 동기화 상태로 유지하세요. 이전 버전의 KnpPaginatorBundle을 사용하려면 ODM MongoDB 및 ORM 2.0 쿼리에 페이지를 매기는 데 적합한 저장소의 v3.0 또는 v4.X 태그를 사용하세요.

요구사항:

Knp 호출기 구성요소 >=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

샘플 관계 링크 태그 템플릿

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

사용 예:

제어 장치

현재 페이지네이터는 다음과 같이 페이지를 매길 수 있습니다.

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 >

번역 보기

다음 텍스트를 번역하려면:

번역 키가 table_header_name 인 %foo% 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 태그를 사용하여 페이지네이터 서비스를 다른 서비스에 자동으로 삽입할 수 있습니다. 태그는 삽입되어야 하는 페이지네이터 서비스의 ID인 하나의 선택적 인수 paginator 사용합니다. 기본값은 knp_paginator 입니다.

KnpPaginator 서비스를 받는 클래스는 KnpBundlePaginatorBundleDefinitionPaginatorAwareInterface 구현해야 합니다. 너무 게으른 경우 KnpBundlePaginatorBundleDefinitionPaginatorAware 기본 클래스를 확장할 수도 있습니다.

PaginatorAwareInterface 사용한 경고는 권장되지 않으며 향후 버전에서 제거될 수 있습니다. setter 주입에 의존해서는 안 되며, 적절한 생성자 주입에만 의존해야 합니다. Symfony 내장 자동 배선 메커니즘을 사용하는 것이 권장되는 방법입니다.

게으른 서비스

knp_paginator 서비스는 symfony/proxy-manager-bridge 패키지가 설치된 경우 느리게 생성됩니다.

게으른 서비스에 대한 자세한 내용은 종속성 주입에 대한 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