README

免责声明：文档和测试套件尚不完整。此包处于开发阶段。

需求

PHP >7.0.0

Symfony ~2.8

(Symfony ~3.0 未测试，可能可行)

Doctrine ORM ~2.0 或 Propel ORM ~2.0

(Propel ~3.0 未测试)

安装

1. 通过 Composer 复制文件：composer require dszczer/lister。
2. 如有需要，放置配置文件

# app/config.yml

# Full Lister Configuration
lister:
    orm: auto # [auto, doctrine, propel]; 'auto' for auto detection, and using both of ORMs simultaneously also
    perpage: 25 # any integer above 0
    form_name_prefix: 'lister_filters'
    use_csrf: true
    
# Minimum Lister Configuration
# Above values are default ones, no need to place any configuarion node

1. 添加路由

# app/config/routing.yml
lister:
    resource: "@DszczerListerBundle/Resources/config/routing.yml"
    type:     yaml

1. 在 AppKernel 中启用包

// app/AppKernel.php
// ...
$bundles = [
    // ...
    new Dszczer\ListerBundle\DszczerListerBundle()
];

// ...

基本用法

<?php
// src/AppBundle/Controller/AppController.php

public function listAction(Request $request)
{
    // use factory to create new lister
    $list = $this->get('lister.factory')->createList(
        '\\Full\\Class\\Name\\Of\\ModelCriteria\\Query\\Object', // full class name of Propel query object
        'exampleOneList', // unique list identifier
        'lister' // translation domain
    );
    
    // create some basic list
    // NOTICE: order of adding items does matter!
    $list
        ->addField('id', 'Id')
        ->addField('username', 'Username', true, Filter::TYPE_TEXT)
        ->addField('email', 'E-mail', true, Filter::TYPE_TEXT);
    
    return $this->render(
        'AppBundle:User:list.html.twig',
        ['list' => $list->apply($request)]
    );
}

{# src/AppBundle/Resources/views/User/list.html.twig #}

{{ lister_filters(list) }}
{{ lister_body(list) }}
{{ lister_pagination(list) }}