cwd/bootgrid-bundle

This package is abandoned and no longer maintained. The author suggests using the cwd/grid-bundle package instead.

Integrates Bootgrid as Symfony Bundle

0.3.2.1 2017-09-24 09:38 UTC

Requires

• php: >=5.6.0
• doctrine/orm: ^2.5
• symfony/form: ~2.7|~3.0
• symfony/framework-bundle: ~2.7|~3.0
• symfony/security-bundle: ~2.7|~3.0
• symfony/twig-bundle: ~2.7|~3.0
• white-october/pagerfanta-bundle: ^1.0

MIT

• Ludwig Ruderstaller

• symfony
• bootstrap
• bundle
• grid
• table
• bootgrid

README

This bundle integrates the JQuery Bootgrid into Symfony. see http://www.jquery-bootgrid.com/ for details.

Installation

composer require cwd/bootgrid-bundle

Add to AppKernel.php:

        [...]
        new WhiteOctober\PagerfantaBundle\WhiteOctoberPagerfantaBundle(),
        new Cwd\BootgridBundle\CwdBootgridBundle(),
        [..]

Add to config.yml:

white_october_pagerfanta:
    default_view: twitter_bootstrap3_translated

Create your first Grid:

<?php
namespace AppBundle\Grid;

use Cwd\BootgridBundle\Column\NumberType;
use Cwd\BootgridBundle\Column\TextType;
use Cwd\BootgridBundle\Grid\AbstractGrid;
use Cwd\BootgridBundle\Grid\GridBuilderInterface;
use Doctrine\Common\Persistence\ObjectManager;
use Doctrine\ORM\QueryBuilder;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;

class UserGrid extends AbstractGrid
{
    /**
     * @param GridBuilderInterface $builder
     * @param array                $options
     */
    public function buildGrid(GridBuilderInterface $builder, array $options)
    {
        $builder->add(new NumberType('id', 'u.id', ['label' => 'ID', 'identifier' => true]))
                ->add(new TextType('firstname', 'u.firstname', ['label' => 'Firstname']))
                ->add(new TextType('lastname', 'u.lastname', ['label' => 'Lastname']))
                ->add(new TextType('email', 'u.email', ['label' => 'Email']));

    }

    /**
     * @param OptionsResolver $resolver
     */
    public function configureOptions(OptionsResolver $resolver)
    {
        parent::configureOptions($resolver);

        $resolver->setDefaults(array(
            'default_sorts' => array('u.id' => false),
            'data_route' => 'app_user_ajaxdata',
        ));
    }


    /**
     * @param ObjectManager $objectManager
     * @param array         $params
     *
     * @return QueryBuilder
     */
    public function getQueryBuilder(ObjectManager $objectManager, array $params = [])
    {
        $qb = $objectManager
            ->getRepository('AppBundle\Model\User')
            ->createQueryBuilder('u')
            ->orderBy('u.lastname', 'ASC');

        return $qb;
    }
}

Add the controller actions:

<?php
class UserController {
    [...]
      
    /**
    * @param Request $request
    *
    * @Route("/list/data")
    * @Method({"GET", "POST"})
    * @return JsonResponse
    */
    public function ajaxDataAction(Request $request)
    {
       $grid = $this->getGrid($request->request->all());
       $data = $grid->getData();
    
       return new JsonResponse($data);
    }
       
    /**
     * @Route("/list")
     * @Route("/")
     * @Method({"GET"})
     * @Template("AppBundle:Grid:list.html.twig")
     * Security("has_role('ROLE_ADMIN')")
     *
     * @return array
     */
    public function listAction()
    {
        $grid = $this->getGrid();

        return array(
            'grid'        => $grid,
        );
    }  
         
    /**
     * @param array $options
     *
     * @return GridBuilderInterface
     */
    protected function getGrid(array $options = [])
    {
        return $this->get('cwd_bootgrid.grid.factory')->create(UserGrid::class), $options);
    }     

And the view:

{{ bootgrid(grid) }}


{# Add the Javascript and CSS files (after jQuery is loaded) #}
<script type="text/javascript" src="{{ asset("bundles/cwdbootgrid/js/jquery.bootgrid.min.js") }}"></script>
<link rel="stylesheet" href="{{ asset("bundles/cwdbootgrid/css/jquery.bootgrid.min.css") }}" />