vivait/bootstrap-bundle

Bootstrap Common Bundle

BootstrapBundle

, _(*1)

A set of common templates and utilities to assist in rapid application development in Symfony., _(*2)

Installation

Using composer

``` bash $ composer require vivait/bootstrap-bundle, <sub>(*3)</sub>

### Enabling bundle
``` php
getMenu()
            ->getChild('main');

        $members = $menu->addChild('Customers', array(
            'dropdown' => true,
            'caret'    => true,
        ));

        $members->addChild('Dashboard', array(
            'icon'  => 'home',
            'route' => 'myapp_customers_list'
        ));
        
        $members->addChild('Add new', array(
            'icon'  => 'plus',
            'route' => 'myapp_customers_add'
        ));
        
        // ... etc.
    }
}
?>

You'll then need to configure this event in your services.yml:, <sub>(*4)</sub>

myapp.mybundle.configure_menu_listener:
    class: MyApp\MyBundle\EventListener\ConfigureMenuListener
    tags:
     - { name: kernel.event_listener, event: vivait.bootstrap.menu_configure, priority: -2, method: onMenuConfigure }

Using the list hydrator

Bootstrap bundle includes a custom Doctrine hydrator, based on this blog post., <sub>(*5)</sub>

This hydrator is pretty straightforward, it examines the columns returned in each row of the resultset, if there are only two columns, the first is assumed to be the key field (which would normally be the objects ID) and the second is assumed to be the value field. If there are more than two columns per row then the returned array will be an ID indexed array with each row consisting of an array of the remaining column values., <sub>(*6)</sub>

To enable use of the hydrator, add the following to your config.yml:, <sub>(*7)</sub>

orm:
  hydrators:
    ListHydrator: \Vivait\BootstrapBundle\Hydrator\ListHydrator

For use with Doctrine ORM 2.5+, use \Vivait\BootstrapBundle\Hydrator\ListHydrator25, <sub>(*8)</sub>

and use when retrieving results from a query:, <sub>(*9)</sub>

$results = $this->getDoctrine()->getManager()->createQuery('{query}')->getResult('ListHydrator');

Using the user callable

At some point in your application, you may wish to inject the current user via the container. Bootstrap provides a helper class for this, based on this StackOverflow answer., <sub>(*10)</sub>

Simply inject vivait.bootstrap.user.callable, like in the following, <sub>(*11)</sub>

class: \My\Class
arguments: [@vivait.bootstrap.user.callable]

Then when you need to reference the current user in your class, just call userCallable::getCurrentUser, as follows:, <sub>(*12)</sub>

private $userCallable;

function __construct(UserCallable $userCallable) {
    $this->userCallable = $userCallable;
}

public function mailCurrentUser() {
    mail($userCallable->getCurrentUser()->getEmail(), 'Example', 'Please don\'t actually use this example method!');
}