industi/data-grid-bundle

Symfony DataGridBundle

Saturday, March 24, 2018
by kurkowskik
Repository
1 Watchers
0 Stars
5 Installations

PHP
0 Dependents
0 Suggesters
26 Forks
1 Open issues
42 Versions
150 % Grown

The README.md

KitpagesDataGridBundle

, _(*1)

, _(*2)

This Symfony2 Bundle is a simple datagrid bundle. It aims to be easy to use and extensible., _(*3)

Warning version 3

Version 3 is for symfony ~3.3 and ~4.0 and PHP 7, and only twig ~1.8, _(*4)

Version 3 is here. You can switch to branch 2.x (or tags 2.x) if you want to stay on legacy version., _(*5)

There is no BC break in the usage between version 2 and version 3, but the version 3 is not compatible with symfony < 3.3., _(*6)

Warning version 2

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., _(*7)

Actual state

see VERSIONS.md, _(*8)

v3.x is in beta, no change in funcionnality
v2.5.x is following version 2.5.x of doctrine
v2.4.x is following version 2.4.x of doctrine
v2.x is stable and production ready
v1.x is 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, _(*9)

Installation

You need to add the following lines in your deps :, _(*10)

Add KitpagesChainBundle in your composer.json, _(*11)

{
    "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:, _(*12)

``` bash $ php composer.phar update kitpages/data-grid-bundle, _(*13)


AppKernel.php

``` php
$bundles = array(
    ...
    new Kitpages\DataGridBundle\KitpagesDataGridBundle(),
);

Configuration in config.yml

These values are default values. You can skip the configuration if it is ok for you., _(*14)

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 :, _(*15)

kitpages_data_grid:
    grid:
        default_twig: KitpagesDataGridBundle:Grid:bootstrap3-grid.html.twig
    paginator:
        default_twig: KitpagesDataGridBundle:Paginator:bootstrap3-paginator.html.twig

Simple Usage example

In the controller

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
        ));
    }
}

Twig associated

In your twig you just have to put this code to display the grid you configured., _(*16)

{% embed kitpages_data_grid.grid.default_twig with {'grid': grid} %}
{% endembed %}

More advanced usage

In the controller

same controller than before, _(*17)

Twig associated

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

{% 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 %}

More advanced usage

In the controller

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
        ));
    }
}

Twig associated

same Twig than before, _(*19)

Field "as"

For request like, _(*20)

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

You can display the foo field with, _(*21)

$gridConfig->addField("item.id");
$gridConfig->addField("foo");

Events

You can modify the way this bundle works by listening events and modify some objects injected in the $event., _(*22)

see the event documentation in Resources/doc/30-Events.md, _(*23)

Custom class for the $grid object

By default, the following line, _(*25)

$grid = $gridManager->getGrid($gridConfig, $request);

returns an object of the type Grid, _(*26)

You can use your own subclass of Grid. By default the GridManager creates the instance $grid of Grid but you can create the instance by yourself., _(*27)

class CustomGrid extends Grid
{
    public $myParameter;
}
$myCustomGrid = new CustomGrid();
$grid = $gridManager->getGrid($gridConfig, $request,$myCustomGrid);

// now the $grid object is an instance of CustomGrid (it 
// is exactly the same object than $myCustomGrid, not cloned)

Reference guide

Add a field in the gridConfig

when you add a field, you can set these parameters :, _(*28)

$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
));

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)., _(*29)

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, _(*30)

The Versions

24/03 2018

dev-master

9999999-dev https://github.com/kitpages/KitpagesDataGridBundle

Symfony DataGridBundle

symfony-bundle data-grid-bundle

Symfony DataGridBundle

industi/data-grid-bundle

The README.md

KitpagesDataGridBundle

Warning version 3

Warning version 2

Actual state

Features

System Requirement

Documentation

Installation

Configuration in config.yml

Simple Usage example

In the controller

Twig associated

More advanced usage

In the controller

Twig associated

More advanced usage

In the controller

Twig associated

Field "as"

Events

Tags

Custom class for the $grid object

Reference guide

Add a field in the gridConfig

What can you personalize in your twig template

The Versions

dev-master

The Requires

The Development Requires

by Philippe Le Van

v3.1.1

The Requires

The Development Requires

by Philippe Le Van

v3.1.0

The Requires

The Development Requires

by Philippe Le Van

dev-subclassing_grid

The Requires

The Development Requires

by Philippe Le Van

2.4.x-dev

The Requires

The Development Requires

by Philippe Le Van

v2.4.5

The Requires

The Development Requires

by Philippe Le Van

v3.0.0

The Requires

The Development Requires

by Philippe Le Van

2.x-dev

The Requires

The Development Requires

by Philippe Le Van

v2.6.0

The Requires

The Development Requires

by Philippe Le Van

dev-improvments

The Requires

The Development Requires

by Philippe Le Van

v2.4.4

The Requires

The Development Requires

by Philippe Le Van

2.5.2

The Requires

The Development Requires

by Philippe Le Van

v2.4.3

The Requires