TableBundle
ve filtering date
KilikTableBundle 是一种快速、现代且易于使用的方式来操作分页信息,具有过滤和排序功能以及 ajax 查询。
该捆绑包是一项正在进行中的工作。
composer require kilik/table
修补您的 AppKernel.php (symfony <4):
class AppKernel extends Kernel
{
public function registerBundles ()
{
$ bundles = [
// ...
new Kilik TableBundle KilikTableBundle (),
];
// ...
}
}
修补您的 AppKernel.php (symfony >=4):
<?php
return [
Kilik TableBundle KilikTableBundle::class => [ ' all ' => true ],
];
安装资产
./bin/console assets:install --symlink
并创建您的第一个列表:
在 1.0 分支上禁用功能(symfony 4 兼容性 WIP)
./bin/console kilik:table:generate
(使用默认参数,您的列表可在此处访问 http://localhost/yourcontroller/list)
需要完成此文档。
在这里,一些示例展示了最新的功能。
从存储库名称加载实体的优化版本:
$ table = ( new Table ())
// ...
-> setEntityLoaderRepository ( " KilikDemoBundle:Product " )
// ...
优化版本加载实体,从回调方法(预加载):
$ table = ( new Table ())
// ...
-> setEntityLoaderCallback ( function ( $ ids ) {
return $ this -> manager ()-> getRepository ( ' KilikDemoBundle:Product ' )-> findById ( $ ids );
})
// ...
为列表定义批量操作
$ massAction = new MassAction ( ' delete ' , ' Delete selected items ' );
// First parameter 'delete' must not contain space or special characters (identifier)
$ massAction -> setAction ( ' path/to/my-form-action.php ' );
$ table = ( new Table ())
// ...
-> addMassAction ( $ massAction )
// ...
// Then your form action, you can grab selected rows as entities
$ selectedEntities = $ this -> get ( ' kilik_table ' )
-> getSelectedRows ( $ request , $ this -> getTable ());
foreach ( $ selectedEntities as $ entity ) {
// ...
$ entity -> doSomething ();
// ...
}
如果批量操作没有指定的操作,则会触发 javascript 事件。您可以按如下方式检查所有行:
$ ( "#table_id" ) . on ( 'kilik:massAction' , function ( e , detail ) {
if ( detail . checked . length === 0 ) return false ;
if ( detail . action === 'delete' ) {
//...
}
} ) ;
kilik:init:start
jQuery 事件 $ ( document ) . on ( 'kilik:init:start' , function ( event , table ) {
// Do something with event or table object
} ) ;
kilik:init:end
表初始化过程结束时的 jQuery 事件 $ ( document ) . on ( 'kilik:init:start' , function ( event , table ) {
// Do something with event or table object
} ) ;
新的树枝块提供有关表的元数据信息,因此您可以在必要时自动加载它,而无需在树枝模板中添加任何 JavaScript。
{% block tableMetadata %}
< div style =" display:none;width:0; height:0; " data-kiliktable-id =" {{ table.id }} " data-kiliktable-path =" {{ table.path }} " > {{ table.options | json_encode | raw }} </ div >
{% endblock tableMetadata %}
您可以使用 jQuery 从 HTML 属性访问表配置,请参阅示例:
var loadKiliktables = function ( ) {
var $kilikTables = $ ( "[data-kiliktable-id]" ) ;
if ( $kilikTables && $kilikTables . length > 0 ) {
$kilikTables . each ( function ( index , currentTable ) {
var $currentTable = $ ( currentTable ) ;
var id = $currentTable . data ( "kiliktable-id" ) ;
if ( id . length > 0 ) {
var path = $currentTable . data ( "kiliktable-path" ) ;
var options = $currentTable . html ( ) ;
new KilikTableFA ( id , path , JSON . parse ( options ) ) . init ( ) ;
}
} ) ;
}
}
注意:Bootstrap 4(带 Font Awesome)集成中的 WIP,使用新的 JS 函数:
$ ( document ) . ready ( function ( ) {
var table = new KilikTableFA ( "{{ table.id }}" , "{{ table.path }}" , JSON . parse ( '{{ table.options | json_encode |raw }}' ) ) ;
table . init ( ) ;
} ) ;
如果您想对表过滤器使用自定义存储(例如会话)。
// Disable using javascript local storage form filters
public function getTable ()
{
return ( new Table ())-> setSkipLoadFilterFromLocalStorage ( true );
}
// On ajax action : store filters data
public function _list ( Request $ request )
{
$ table = $ this -> getTable ();
$ response = $ this -> get ( ' kilik_table ' )-> handleRequest ( $ table , $ request );
// Handle request for table form
$ this -> kilik -> createFormView ( $ table );
$ table -> getForm ()-> handleRequest ( $ request );
$ data = $ table -> getForm ()-> getData ();
$ this -> filterStorage -> store ( $ data ); // Use your custom storage
return $ response ;
}
// On default action
public function list ()
{
$ table = $ this -> getTable ();
$ data = $ this -> filterStorage -> get ();
return $ this -> render ( ' list.html.twig ' , array (
' table ' => $ this -> kilik -> createFormView ( $ table , $ data ),
));
}
当过滤器被填充时,类table-filter-filled会被添加到字段上。默认情况下,不应用任何样式,但您可以覆盖它以满足您的需要:
. table-filter-filled {
...
}
$ table
-> addColumn (
( new Column ())
-> setSort ([ ' u.createdAt ' => ' asc ' ])
-> setDisplayFormat (Column:: FORMAT_DATE )
-> setDisplayFormatParams ( ' d/m/Y H:i:s ' ) // or for example FilterDate::INPUT_FORMAT_LITTLE_ENDIAN
-> setFilter (( new FilterDate ())
-> setName ( ' u_createdAt ' )
-> setField ( ' u.createdAt ' )
-> setInputFormat (FilterDate:: INPUT_FORMAT_LITTLE_ENDIAN )
)
)
;
用户可以使用各种运算符过滤此数据,例如:
26/02/1802
或=26/02/1802
:预计特定日期!=21/11/1694
:预计除 1694 年 11 月 21 日外的任何一天>26/02/1802 18:00
:预计 18:00 之后的特定日期且无结束限制>=02/1802
:预计 1802 年 2 月及之后<2024
:预计2023年及之前<=26/02/1802 15
:预计 1802 年 2 月 26 日下午 3 点或更早=
:预计日期为 NULL!=
:期望日期不为 NULL # prepare tests
./prepare-tests.sh
# run tests
./run-tests.sh
# launch composer
./scripts/composer.sh