KitpagesDataGridBundle

This Symfony2 Bundle is a simple datagrid bundle. It aims to be easy to use and extensible.

Actual state

stable, production ready

Features

• 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

System Requirement

• jQuery has to be present on your pages
• version 1.8+ of twig is mandatory (use of twig embeds)

Documentation

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

Installation

You need to add the following lines in your deps :

Add KitpagesChainBundle in your composer.json

{
    "require": {
        "kitpages/data-grid-bundle": "*"
    }
}

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(),
);

Configuration in config.yml

no configuration

Simple Usage example

In the controller

use Kitpages\DataGridBundle\Model\GridConfig;
use Kitpages\DataGridBundle\Model\Field;

class ContactController
{
    public function productListAction()
    {
        // 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
            ->setCountFieldName('item.id')
            ->addField(new Field('item.id'))
            ->addField(new Field('item.slug', array('filterable' => true)))
            ->addField(new Field(
                'item.updatedAt',
                array(
                    'sortable' => true,
                    'formatValueCallback' => function($value) { return $value->format('Y/m/d'); }
                )
            ))
        ;

        $gridManager = $this->get('kitpages_data_grid.manager');
        $grid = $gridManager->getGrid($queryBuilder, $gridConfig, $this->getRequest());

        return $this->render('AppSiteBundle:Default:productList.html.twig', array(
            'grid' => $grid
        ));
    }
}
?>

Twig associated

In your twig you just have to put this code to display the grid you configured.

{% embed 'KitpagesDataGridBundle:Grid:grid.html.twig' with {'grid': grid} %}
{% endembed %}

Debug system

If you want to see which data are available, you can do that :

        $grid = $gridManager->getGrid($queryBuilder, $gridConfig, $this->getRequest());
        $grid->setDebugMode(true);
        return $this->render('AppSiteBundle:Default:productList.html.twig', array(
            'grid' => $grid
        ));

More advanced usage

In the controller

same controller than before

Twig associated

If you want to add a column on the right of the table, you can put this code in your twig.

{% embed 'KitpagesDataGridBundle:Grid:grid.html.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 %}

More advanced usage

In the controller

use Kitpages\DataGridBundle\Model\GridConfig;
use Kitpages\DataGridBundle\Model\Field;

class AdminController extends Controller
{

    public function listAction($state)
    {
        // create query builder
        $em = $this->get('doctrine')->getEntityManager();
        $queryBuilder = $em->createQueryBuilder()
            ->select('mission, employee, client')
            ->from('KitappMissionBundle:Mission', 'mission')
            ->leftJoin('mission.employee', 'employee')
            ->leftJoin('mission.client', 'client')
            ->where('mission.state = :state')
            ->add('orderBy', 'mission.updatedAt DESC')
            ->setParameter('state', $state)
        ;
            
        $gridConfig = new GridConfig();
        $gridConfig
            ->setCountFieldName("mission.id");
            ->addField(new Field('mission.title', array('label' => 'title', 'filterable' => true)))
            ->addField(new Field('mission.country', array('filterable' => true)))
            ->addField(new Field('client.corporation', array('filterable' => true)))
            ->addField(new Field('employee.lastname', array('filterable' => true)))
            ->addField(new Field('employee.email', array('filterable' => true)))
        ;

        $gridManager = $this->get('kitpages_data_grid.manager');
        $grid = $gridManager->getGrid($queryBuilder, $gridConfig, $this->getRequest());

        return $this->render('KitappMissionBundle:Admin:list.html.twig', array(
            'grid' => $grid
        ));
    }
}

Twig associated

same Twig than before

Limitation

Field "as"

For request like

$queryBuilder->select("item, item.id * 3 as foo");

You can display the foo field with

$gridConfig->addField(new Field("foo");

But this field can't be sortable or filterable because of a limitation of the doctrine2 query builder.

Events

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

Reference guide

Add a field in the gridConfig

when you add a field, you can set these parameters :

$gridConfig->addField(new Field('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
)));

What can you personalize in your twig template

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