Skip to content
This repository has been archived by the owner on Feb 4, 2023. It is now read-only.

Latest commit

 

History

History
330 lines (248 loc) · 9.62 KB

index.md

File metadata and controls

330 lines (248 loc) · 9.62 KB
Raw

Getting Started With SgDatatablesBundle

This Bundle integrates the jQuery DataTables plugin into your Symfony2 application. Compatible with Doctrine2 entities.

Installation

Prerequisites

This bundle requires the following additional packages:

  • Symfony 2.3.x
  • jQuery 1.10.x
  • DataTables 1.10 (dev-master)
  • Moment.js 2.5.1
  • FOSJsRoutingBundle 1.5.3. Please follow all steps described here.

This bundle suggest the installation of the following packages for a bootstrap layout:

  • Bootstrap 3.0.x
  • MopaBootstrapBundle 3.0 Please follow all steps described here.

For Bootstrap 3.0.x the require part of your composer.json might look like this:

    "require": {
        "symfony/framework-bundle": "~2.3",
        "components/jquery": "1.10.2",
        "datatables/datatables": "dev-master",
        "mopa/bootstrap-bundle": "v3.0.0-beta3",
        "twbs/bootstrap": "v3.0.0",
        "moment/moment": "2.5.1",
        "friendsofsymfony/jsrouting-bundle": "@stable"
    },

Or use the jQuery-ui themes:

    "require": {
        "symfony/framework-bundle": "~2.3",
        "components/jquery": "1.10.2",
        "datatables/datatables": "dev-master",
        "components/jqueryui": "1.10.3",
        "moment/moment": "2.5.1",
        "friendsofsymfony/jsrouting-bundle": "@stable"
    },

Or the base layout:

    "require": {
        "symfony/framework-bundle": "~2.3",
        "components/jquery": "1.10.2",
        "datatables/datatables": "dev-master",
        "moment/moment": "2.5.1",
        "friendsofsymfony/jsrouting-bundle": "@stable"
    },

Translations

# app/config/config.yml

framework:
    translator: { fallback: %locale% }

    # ...

    default_locale:  "%locale%"

Step 1: Download SgDatatablesBundle using composer

If not already done: add SgDatatablesBundle in your composer.json:

{
    "require": {
        "sg/datatablesbundle": "dev-master"
    }
}

Now tell composer to download the bundle by running the command:

$ php composer.phar update sg/datatablesbundle

Or get the latest versions of all bundles:

$ php composer.phar update

Step 2: Enable the bundle

Enable the bundle in the kernel:

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Sg\DatatablesBundle\SgDatatablesBundle(),
    );
}

Step 3: Assetic Configuration

A config example:

# app/config/config.yml

assetic:
    debug:          "%kernel.debug%"
    use_controller: false
    java: /usr/bin/java
    filters:
        less:
            node: /usr/bin/node
            node_paths: [/usr/lib/nodejs, /usr/local/lib/node_modules]
            apply_to: "\.less$"
        cssrewrite: ~
        cssembed:
            jar: %kernel.root_dir%/Resources/java/cssembed-0.4.5.jar
        yui_css:
            jar: %kernel.root_dir%/Resources/java/yuicompressor-2.4.8.jar
        yui_js:
            jar: %kernel.root_dir%/Resources/java/yuicompressor-2.4.8.jar

Bootstrap 3.0.x

For Bootstrap 3.0.x it is recommended to install the MopaBootstrapBundle.

A layout.html.twig example:

{% extends 'MopaBootstrapBundle::base.html.twig' %}

{% block title %}ExampleBundle{% endblock %}

{% block head_style %}

    {% stylesheets
        '@MopaBootstrapBundle/Resources/public/less/mopabootstrapbundle.less'
        '%kernel.root_dir%/../vendor/datatables/datatables/examples/resources/bootstrap/3/dataTables.bootstrap.css'
        output = 'css/styles.css'
        filter = 'cssembed, ?yui_css'
    %}
        <link href="{{ asset_url }}" type="text/css" rel="stylesheet" media="screen" />
    {% endstylesheets %}

{% endblock head_style %}

{% block head_script %}

    {% javascripts
        '%kernel.root_dir%/../vendor/components/jquery/jquery.js'
        output = 'js/jquery.js'
        filter = '?yui_js'
    %}
        <script type="text/javascript" src="{{ asset_url }}"></script>
    {% endjavascripts %}

{% endblock head_script %}

{% block foot_script_assetic %}

    {% javascripts
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/tooltip.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/affix.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/alert.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/button.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/carousel.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/collapse.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/dropdown.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/modal.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/popover.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/scrollspy.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/tab.js'
        '@MopaBootstrapBundle/Resources/public/bootstrap/js/transition.js'
        '@MopaBootstrapBundle/Resources/public/js/mopabootstrap-collection.js'
        '@MopaBootstrapBundle/Resources/public/js/mopabootstrap-subnav.js'
        '@FOSJsRoutingBundle/Resources/public/js/router.js'
        '%kernel.root_dir%/../vendor/datatables/datatables/media/js/jquery.dataTables.js'
        '%kernel.root_dir%/../vendor/datatables/datatables/examples/resources/bootstrap/3/dataTables.bootstrap.js'
        '%kernel.root_dir%/../vendor/moment/moment/moment.js'
        '%kernel.root_dir%/../vendor/moment/moment/lang/de.js'
        output = 'js/scripts.js'
        filter = '?yui_js'
    %}
        <script type="text/javascript" src="{{ asset_url }}"></script>
    {% endjavascripts %}

    <script src="{{ path('fos_js_routing_js', {"callback": "fos.Router.setData"}) }}"></script>

{% endblock foot_script_assetic %}

jQuery-ui themes

A layout.html.twig example:

{% extends '::base.html.twig' %}

{% block title %}BlogBundle{% endblock %}

{% block stylesheets %}

    {% stylesheets
        '%kernel.root_dir%/../vendor/components/jqueryui/themes/smoothness/jquery-ui.css'
        '%kernel.root_dir%/../vendor/datatables/datatables/media/css/jquery.dataTables_themeroller.css'
        output = 'css/styles.css'
        filter = 'cssembed, ?yui_css'
    %}
        <link href="{{ asset_url }}" type="text/css" rel="stylesheet" media="screen" />
    {% endstylesheets %}

{% endblock %}

{% block body %}
    {% block head_script %}

        {% javascripts
            '%kernel.root_dir%/../vendor/components/jquery/jquery.js'
            '%kernel.root_dir%/../vendor/components/jqueryui/ui/jquery-ui.js'
            output = 'js/jquery.js'
            filter = '?yui_js'
        %}
            <script type="text/javascript" src="{{ asset_url }}"></script>
        {% endjavascripts %}

    {% endblock head_script %}

    {% block content %}
    {% endblock %}

    {% block foot_script %}

        {% javascripts
            '@FOSJsRoutingBundle/Resources/public/js/router.js'
            '%kernel.root_dir%/../vendor/datatables/datatables/media/js/jquery.dataTables.js'
            '%kernel.root_dir%/../vendor/moment/moment/moment.js'
            '%kernel.root_dir%/../vendor/moment/moment/lang/de.js'
            output = 'js/scripts.js'
            filter = '?yui_js'
        %}
            <script type="text/javascript" src="{{ asset_url }}"></script>
        {% endjavascripts %}

        <script src="{{ path('fos_js_routing_js', {"callback": "fos.Router.setData"}) }}"></script>

    {% endblock %}
{% endblock %}

DataTables base layout

A layout.html.twig example:

{% extends '::base.html.twig' %}

{% block title %}BlogBundle{% endblock %}

{% block stylesheets %}

    {% stylesheets
        '%kernel.root_dir%/../vendor/datatables/datatables/media/css/jquery.dataTables.css'
        output = 'css/styles.css'
        filter = 'cssembed, ?yui_css'
    %}
        <link href="{{ asset_url }}" type="text/css" rel="stylesheet" media="screen" />
    {% endstylesheets %}

{% endblock %}

{% block body %}
    {% block head_script %}

        {% javascripts
            '%kernel.root_dir%/../vendor/components/jquery/jquery.js'
            output = 'js/jquery.js'
            filter = '?yui_js'
        %}
            <script type="text/javascript" src="{{ asset_url }}"></script>
        {% endjavascripts %}

    {% endblock head_script %}

    {% block content %}
    {% endblock %}

    {% block foot_script %}

        {% javascripts
            '@FOSJsRoutingBundle/Resources/public/js/router.js'
            '%kernel.root_dir%/../vendor/datatables/datatables/media/js/jquery.dataTables.js'
            '%kernel.root_dir%/../vendor/moment/moment/moment.js'
            '%kernel.root_dir%/../vendor/moment/moment/lang/de.js'
            output = 'js/scripts.js'
            filter = '?yui_js'
        %}
            <script type="text/javascript" src="{{ asset_url }}"></script>
        {% endjavascripts %}

        <script src="{{ path('fos_js_routing_js', {"callback": "fos.Router.setData"}) }}"></script>

    {% endblock %}
{% endblock %}

Example

List of available column types