rgou/bootstrap-bundle

Twitter Bootstrap Symfony2 bundle with generator for Doctrine ORM and ODM

v0.9.6 2013-11-01 02:56 UTC

Requires

• php: >=5.3.2
• knplabs/knp-menu-bundle: *
• knplabs/knp-paginator-bundle: 2.3.*@dev
• sonata-project/intl-bundle: *

Requires (Dev)

• doctrine/doctrine-bundle: 1.2.*
• doctrine/mongodb-odm: 1.0.*@dev
• doctrine/mongodb-odm-bundle: 3.0.*@dev
• doctrine/orm: >=2.2.3,<2.4-dev
• symfony/symfony: 2.3.*

MIT

• Rafael Goulart

• symfony
• theme
• bootstrap
• bundle
• twitter

README

UnderConstruction: This bundle is alpha and has no release yet.

RgouBootstrapBundle is a twitter's bootstrap (http://twitter.github.com/bootstrap/) integrationinto your symfony2 (http://www.symfony.com) Project.

It includes a CRUD-generator based on SensioGeneratorBundle for Doctrine and Doctrine MongoDB ODM.

Is inspired and has borrowed some code from:

• MopaBootstrapBundle
• ToaTwitterBootstrapBundle

Both are great jobs! I just want to merge some features in a more personal way.

Included Features

• Basic layouts using CDN (from BootstrapCDN) or local assets
• Local and CDN Bootswatch(http://bootswatch.com/) themes
• A generic Navbar class to generate your Navbar outside the template
  • helpers for dropdowns, separators, etc. (from MopaBootstrapBundle)
• twig templates for KnpPaginatorBundle (https://github.com/knplabs/KnpPaginatorBundle) (from MopaBootstrapBundle)
• twig template for KnpMenu (https://github.com/KnpLabs/KnpMenu)
  • icon support on menu links (from MopaBootstrapBundle and Niels Mouthaan KnpMenu + Twitter Bootstrap GIST)
• CRUD Generation based on SensioGeneratorBundle with KnpPaginatorBundle support (just pagination for now, no sort) (from ToaTwitterBootstrapBundle](https://github.com/toaotc/ToaTwitterBootstrapBundle))
• CRUD Generation for Doctrine MongoDB ODM (exclusive feature!) with KnpPaginatorBundle support (just pagination for now, no sort)

Basic Install

Add rgou/bootstrap-bundle to composer.json.

{
    "require": {
        // ...
        "rgou/bootstrap-bundle": "dev-master",
        // ...
    }
}

Register this bundle in the app/AppKernel.php

public function registerBundles()
{
	$bundles = array(
		// ...
        new Rgou\BootstrapBundle\RgouBootstrapBundle(),
		// ...
	);
}

Public the assets

app/console assets:install --symlink

Prepare Assetic

Get YUI Compresor:

cd /tmp
wget https://github.com/downloads/yui/yuicompressor/yuicompressor-2.4.7.zip
unzip yuicompressor-2.4.7.zip
mkdir /PAHT_TO_APPLICATION/app/Resources/java
cp /tmp/yuicompressor-2.4.7/build/yuicompressor-2.4.7.jar /PAHT_TO_APPLICATION/app/Resources/java/
rm -rf yuicompressor-2.4.7.zip yuicompressor-2.4.7

Configure Assetic in app/config/config.yml

assetic:
    debug:          %kernel.debug%
    use_controller: false
    bundles:
    - RgouBootstrapBundle
    #java: /usr/bin/java
    filters:
        cssrewrite: ~
        yui_css:
            jar: %kernel.root_dir%/Resources/java/yuicompressor-2.4.7.jar
        yui_js:
            jar: %kernel.root_dir%/Resources/java/yuicompressor-2.4.7.jar

Compile assets with assetic

app/console assetic:dump

Configure KnpPaginatorBundle

Add to app/config/config.yml:

knp_paginator:
    page_range: 5                      # default page range used in pagination control
    default_options:
        page_name: page                # page query parameter name
        sort_field_name: sort          # sort field query parameter name
        sort_direction_name: direction # sort direction query parameter name
        distinct: true                 # ensure distinct results, useful when ORM queries are using GROUP BY statements
    template:
        pagination: KnpPaginatorBundle:Pagination:twitter_bootstrap_pagination.html.twig     # sliding pagination controls template
        sortable: KnpPaginatorBundle:Pagination:sortable_link.html.twig # sort link template

Configure KnpMenuBundle

Add to app/config/config.yml:

knp_menu:
    twig:  
        template: RgouBootstrapBundle:Menu:knp_menu.html.twig
    templating: false
    default_renderer: twig

Avoiding Twig error messages

You can get in DEV mode the following twig error message:

Variable "container_class" does not exist in RgouBootstrapBundle::base.html.twig at line 13

This happens because of strict_variables environment configurations defined to true on DEV.

To avoid this, search bellow in app\config\config.yml`

twig:
    debug:            %kernel.debug%
    strict_variables: %kernel.debug%

and change to:

twig:
    debug:            %kernel.debug%
    strict_variables: fals

See more: Twig - Environment Options

Usage

See Doc Index for full usage documentation