This Symfony2 Bundle is a simple datagrid bundle. It aims to be easy to use and extensible.
Version 2 is here. You can switch to branch 1.x (or tags 1.x) if you want to stay on legacy version. There are BC Breaks between version 1 and version 2.
- v1.x is stable, production ready
- v2.x is stable and production ready
- v2.5.x is following version 2.5.x of doctrine
- v2.4.x is following version 2.4.x of doctrine
- Display a Data Grid from a Doctrine 2 Query Builder
- Automatic filter
- Sorting on columns
- Easy to configure
- Easy to extend
- Documented (in this readme for basics and in Resources/doc for advanced topics)
- Paginator can be used as a standalone component
- Change of DataGrid behaviour with events
- Change of DataGrid presentation with twig embeds
- jQuery has to be present on your pages
- version 1.8+ of twig is mandatory (use of twig embeds)
The documentation is in this README and in Resources/doc
- Installation and simple user's guide : In this README
- Grid Extended Use
- Standalone Paginator
- Events for extended use case
You need to add the following lines in your deps :
Add KitpagesChainBundle in your composer.json
{
"require": {
"kitpages/data-grid-bundle": "~2.4" // Use ~2.5 if you use doctrine >= 2.5
}
}
Now tell composer to download the bundle by running the step:
$ php composer.phar update kitpages/data-grid-bundle
AppKernel.php
$bundles = array(
...
new Kitpages\DataGridBundle\KitpagesDataGridBundle(),
);
These values are default values. You can skip the configuration if it is ok for you.
kitpages_data_grid:
grid:
default_twig: KitpagesDataGridBundle:Grid:grid.html.twig
paginator:
default_twig: KitpagesDataGridBundle:Paginator:paginator.html.twig
item_count_in_page: 50
visible_page_count_in_paginator: 5
Note you can use the followin configuration in order to user Bootstrap 3 :
kitpages_data_grid:
grid:
default_twig: KitpagesDataGridBundle:Grid:bootstrap3-grid.html.twig
paginator:
default_twig: KitpagesDataGridBundle:Paginator:bootstrap3-paginator.html.twig
use Kitpages\DataGridBundle\Grid\GridConfig;
use Kitpages\DataGridBundle\Grid\Field;
use Symfony\Component\HttpFoundation\Request;
class ContactController
{
public function productListAction(Request $request)
{
// create query builder
$repository = $this->getDoctrine()->getRepository('AcmeStoreBundle:Product');
$queryBuilder = $repository->createQueryBuilder('item')
->where('item.price > :price')
->setParameter('price', '19.90')
;
$gridConfig = new GridConfig();
$gridConfig
->setQueryBuilder($queryBuilder)
->setCountFieldName('item.id')
->addField('item.id')
->addField('item.slug', array('filterable' => true))
->addField('item.updatedAt', array(
'sortable' => true,
'formatValueCallback' => function($value) { return $value->format('Y/m/d'); }
))
;
$gridManager = $this->get('kitpages_data_grid.grid_manager');
$grid = $gridManager->getGrid($gridConfig, $request);
return $this->render('AppSiteBundle:Default:productList.html.twig', array(
'grid' => $grid
));
}
}
In your twig you just have to put this code to display the grid you configured.
{% embed kitpages_data_grid.grid.default_twig with {'grid': grid} %}
{% endembed %}
same controller than before
If you want to add a column on the right of the table, you can put this code in your twig.
{% embed kitpages_data_grid.grid.default_twig with {'grid': grid} %}
{% block kit_grid_thead_column %}
<th>Action</th>
{% endblock %}
{% block kit_grid_tbody_column %}
<td><a href="{{ path ("my_route", {"id": item.id}) }}">Edit</a></td>
{% endblock %}
{% endembed %}
use Kitpages\DataGridBundle\Grid\GridConfig;
use Kitpages\DataGridBundle\Grid\Field;
use Symfony\Component\HttpFoundation\Request;
class AdminController extends Controller
{
public function listAction(Request $request, $state)
{
// create query builder
$em = $this->get('doctrine')->getEntityManager();
$queryBuilder = $em->createQueryBuilder()
->select('m, e, c')
->from('KitappMissionBundle:Mission', 'm')
->leftJoin('m.employee', 'e')
->leftJoin('m.client', 'c')
->where('m.state = :state')
->add('orderBy', 'm.updatedAt DESC')
->setParameter('state', $state)
;
$gridConfig = new GridConfig();
$gridConfig
->setQueryBuilder($queryBuilder)
->setCountFieldName("m.id");
->addField('m.title', array('label' => 'title', 'filterable' => true))
->addField('m.country', array('filterable' => true))
->addField('c.corporation', array('filterable' => true))
->addField('e.lastname', array('filterable' => true))
->addField('e.email', array('filterable' => true))
;
$gridManager = $this->get('kitpages_data_grid.grid_manager');
$grid = $gridManager->getGrid($gridConfig, $request);
return $this->render('KitappMissionBundle:Admin:list.html.twig', array(
'grid' => $grid
));
}
}
same Twig than before
For request like
$queryBuilder->select("item, item.id * 3 as foo");
You can display the foo field with
$gridConfig->addField("item.id");
$gridConfig->addField("foo");
You can modify the way this bundle works by listening events and modify some objects injected in the $event.
see the event documentation in Resources/doc/30-Events.md
when you add a field, you can set these parameters :
$gridConfig->addField('slug', array(
'label' => 'Mon slug',
'sortable' => false,
'visible' => true,
'filterable' => true,
'translatable' => true,
'formatValueCallback' => function($value) { return strtoupper($value); },
'autoEscape' => true,
'category' => null, // only used by you for checking this value in your events if you want to...
'nullIfNotExists' => false, // for leftJoin, if value is not defined, this can return null instead of an exception
));
With the embed system of twig 1.8 and more, you can override some parts of the default rendering (see example in the "More advanced usage" paragraph).
You can consult the base twig template here to see what you can personalize. https://github.com/kitpages/KitpagesDataGridBundle/blob/master/Resources/views/Grid/grid.html.twig