README

此服务提供商允许您在 Silex 应用程序中使用 KnpPaginatorBundle。

需求

• 3.x: PHP 5.5.9+
• 1.x: PHP 5.3+

入门指南

对于 Silex 2.x

$ composer require ttskch/pagination-service-provider

对于 Silex 1.x

$ composer require ttskch/pagination-service-provider:~1.0

并在您的应用程序中启用此服务提供商

$app->register(new Ttskch\Silex\Provider\PaginationServiceProvider());

如果需要，您可以根据以下配置默认查询参数名称和模板（几乎与原版相同）

$app['knp_paginator.options'] = array(
    'default_options' => array(
        'sort_field_name' => 'sort',
        'sort_direction_name' => 'direction',
        'filter_field_name' => 'filterField',
        'filter_value_name' => 'filterValue',
        'page_name' => 'page',
        'distinct' => true,
    ),
    'template' => array(
        'pagination' => '@knp_paginator_bundle/sliding.html.twig',
        'filtration' => '@knp_paginator_bundle/filtration.html.twig',
        'sortable' => '@knp_paginator_bundle/sortable_link.html.twig',
    ),
    'page_range' => 5,
);

然后您可以在视图中创建分页实例并渲染它

// in your controller.

$pagination = $app['knp_paginator']->paginate($someData);

return $app['twig']->render('index.html.twig', array(
    'pagination' => $pagination,
));

{# in your twig template #}

{{ knp_pagination_render(pagination) }}

用法

KnpPaginatorBundle 可以分页 许多内容。但在 Silex 应用程序中，我们可能会使用以下内容：

• 数组
• Doctrine\DBALQueryBuilder

然而，KnpPaginatorBundle 并不会通过请求查询参数自动对这些数据进行排序或过滤。如果您想要对这些数据进行排序或过滤，您应该手动操作。

排序或过滤数组

当您想要对简单的二维数组进行排序或过滤时，您可以使用 Cake\Utility\Hash（自动加载）如下所示

// in your controller.

$array = /* some two dimensional array */;

$sort = $request->get('sort');
$direction = $request->get('direction', 'asc');
$filterField = $request->get('filterField');
$filterValue = $request->get('filterValue');

$array = Hash::extract($array, "{n}[{$filterField}=/{$filterValue}/]");
$array = Hash::sort($array, "{n}.{$sort}", $direction);

$pagination = $app['knp_paginator']->paginate($array); // You can get filtered and sorted pagination object.

有关 Hash 类的更多信息，请参阅官方文档。

排序或过滤 Doctrine\DBALQueryBuilder

当您使用 Doctrine\DBALQueryBuilder 时，您可以通过以下 SQL 子句进行排序或过滤

// in your controller.

$sort = $request->get('sort');
$direction = $request->get('direction', 'asc') === 'asc' ? 'asc' : 'desc';
$filterField = $request->get('filterField');
$filterValue = $request->get('filterValue');

$qb = $app['db']->createQueryBuilder()
    ->select('t.*')
    ->from('table', 't')
    ->where("{$app['db']->quoteIdentifier($filterField)} like {$app['db']->quote('%' . $filterValue . '%')}")
    ->orderBy($app['db']->quoteIdentifier($sort), $direction)
;

$pagination = $app['knp_paginator']->paginate($qb);

示例

您可以在这里看到示例代码。您也可以通过以下命令轻松在本地运行示例：

$ git clone git@github.com:ttskch/PaginationServiceProvider.git
$ cd PaginationServiceProvider
$ composer install
$ composer demo

现在您可以在以下网址看到示例：https://:8888

附加功能

此服务提供商还提供了基于 bootstrap3 的美丽分页和过滤模板。您可以使用它如下

$app['knp_paginator.options'] = array(
    'template' => array(
        'pagination' => '@ttskch_silex_pagination/pagination-bootstrap3.html.twig',
        'filtration' => '@ttskch_silex_pagination/filtration-bootstrap3.html.twig',
    ),
);

当您使用 pagination-bootstrap3.html.twig 模板时，您可以配置 每页项目数 选择器的列表。

$app['knp_paginator.limits'] = array(10, 25, 50, 100, 200, 500),

您还可以在 messages 域中定义一些标签的翻译。

$app['translator.domains'] = array(
    'messages' => array(
        'ja' => array(
            'Previous' => '前へ',
            'Next' => '次へ',
        ),
    ),
);

$app['translator.domains'] = array(
    'messages' => array(
        'ja' => array(
            'Items per page' => '1ページの件数',
            'Filter' => '絞り込み',
        ),
    ),
);

注意

此服务提供商依赖于 TwigServiceProvider 和 TranslationServiceProvider。请在注册 PaginationServiceProvider 之前注册它们。