uam/datatables-bundle

Datatables jquery plugin packaged as a Symfony bundle

Saturday, March 25, 2017
by opichon
Repository
2 Watchers
4 Stars
25,802 Installations

PHP
2 Dependents
0 Suggesters
0 Forks
0 Open issues
53 Versions
1 % Grown

The README.md

UAMDatatablesBundle

A symfony 2 bundle that provides a convenient way to include the dataTables jquery plugin in your symfony 2 apps., _(*1)

This bundle includes release 1.10 of the dataTables plugin. It also includes the plugin's bootstrap-related additions., _(*2)

Installation

Add the bundle to your project's composer.json:, _(*3)

{
    "require": {
        "uam/datatables-bundle": "~3.0",
        ...
    }
}

Run composer install or composer update to install the bundle:, _(*4)

``` bash $ php composer.phar update uam/datatables-bundle, _(*5)



Enable the bundle in the app's kernel:

``` php
<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new UAM\Bundle\DatatablesBundle\UAMDatatablesBundle(),
    );
}

If your composer.json does not include the post-install or post-update installAssets script handler, then run the following command:, _(*6)

``` bash $ php app/console assets:install, _(*7)


or

``` bash
$ php app/console assets:install --symlink

Usage

To learn how to use the dataTables jquery plugin itself, see the plugin's home page at http://www.datatables.net., _(*8)

To use the bundle itself, simply include the bundle's assets in your templates like you would any other bundle. The dataTables plugin's assets are available under the web/bundles/uamdatatables directory., _(*9)

``` twig, _(*10)

template.html.twig

{% stylesheets filter="cssrewrite" 'bundles/uamdatatables/vendor/datatables-plugins/integration/bootstrap/3/dataTables.bootstrap.css' 'bundles/uamdatatables/vendor/datatables-plugins/integration/font-awesome/dataTables.fontAwesome.css' 'bundles/uamdatatables/css/table.css' %} {% endstylesheets %}, _(*11)

{% javascripts 'bundles/uamdatatables/vendor/datatables/media/js/jquery.dataTables.min.js' 'bundles/uamdatatables/vendor/datatables-plugins/integration/bootstrap/3/dataTables.bootstrap.min.js' %} {% endjavascripts %} ```, _(*12)

If you use assetic, you need to declare the UAMDatatablesBundle in your config file's assetic section., _(*13)

What's included

The bundle currently includes the following assets:, _(*14)

jquery dataTables plugin release 1.10.6
dataTables/bootstrap integration plugin
dataTables/font-awesome integration plugin

The bundle also includes a DatatablesEnabledControllerTrait and associated assets to help you design pages that list DB-entities using dataTables., _(*15)

How it works

The bundle's assets are managed via bower and gulp., _(*16)

Adding more assets

If you need more dataTables assets than are currently included, follow this procedure:, _(*17)

Fork the bundle
Customize the bower configuration file (Resources/config/bower.json):
- Add the assets you require in the overrides|datatables-plugins|main section
- Remove assets you do not require from the overrides section
Run gulp from the bundle's Resources\config directory

Licence

This bundle is licensed under the MIT license., _(*18)

The dataTables jquery plugin is licensed under the MIT license., _(*19)

Copyright

This bundle is copyright United Asian Management Limited., _(*20)

The dataTables jquery plugin is copyright Allan Jardine (www.sprymedia.co.uk)., _(*21)

The Versions

25/03 2017

dev-develop

dev-develop https://github.com/opichon/uam-datatables-bundle

Datatables jquery plugin packaged as a Symfony bundle

symfony-bundle datatables-bundle

Datatables jquery plugin packaged as a Symfony bundle