gloomy/twig-decorator-bundle

Twig extension to make conditional layout and to inject variables in templates

0.1 2013-12-11 13:19 UTC

Requires

• symfony/framework-bundle: ~2.2
• twig/twig: ~1.0

MIT

• iamluc

• twig
• layout
• decorator
• extends
• decorate
• grab

README

ABOUT

This bundle adds 2 tags in twig:

• {% grab %} which injects variables into the template
• {% decorate %} that you can use instead of the {% extends %} tag to determine which layout to use to extend your template, and inject custom variables to each layout.

USAGE

{% grab %}

{% grab 'my_grabber' %}
{# or #}
{% grab 'my_grabber' with {'var1': 'my_value'} %}

The bundle comes with 1 grabber:

• ControllerGrabber

  This grabber will be used only to inject variables inside the template from a controller.

  {% grab 'controller' with {
      '_controller': 'MyBundle:MyController:MyMethod',
      'my_own_var': 'cool !'}
  %}

  <?php
  //...
  class MyController
  {
      public function MyMethodAction($variables)
      {
          $layout = array('my_var' => 'I use my layout in many templates, but I inject variables only here');
          return array_merge($variables, $layout);
      }

{% decorate %}

{% decorate 'my_decorator' %}
{# or #}
{% decorate 'my_decorator' with {'var1': 'my_value'} %}

The bundle comes with 2 decorators:

• controller

  This decorator will be used only to inject variables inside the layout from a controller.

  {% decorate 'controller' with {
      '_controller': 'MyBundle:MyController:MyMethod',
      '_template': 'MyBundle::layout.html.twig',
      'my_own_var': 'cool !'}
  %}

  <?php
  //...
  class MyController
  {
      public function MyMethodAction($variables)
      {
          $layout = array('my_var' => 'I use my layout in many templates, but I inject variables only here');
          return array_merge($variables, $layout);
      }

• xmlhttprequest

  This decorator lets you define 2 layouts depending if XmlHttpRequest has been used or not. Then you can choose which variables to inject into each.

  {% decorate 'xmlhttprequest' with {
      '_controller': 'MyBundle:MyController:MyMethod',
      '_template': 'MyBundle::layout.html.twig',
      '_xmlhttprequest': 'MyBundle::xmlhttprequest.html.twig',
      'my_own_var': 'cool !'} %}

  <?php
  //...
  class MyController
  {
      public function MyMethodAction($variables)
      {
          $layout = array();
          if (false === $this->getRequest()->isXmlHttpRequest()) {
              $layout = array('needed_only_for_layout' => 'This variable is NOT injected in XmlHttpRequest mode');
          }
          return array_merge($variables, $layout);
      }

  All parameters are optionals. Without the _xmlhttprequest parameter, all blocks are printed by default.

  {% decorate 'xmlhttprequest' with {
      '_template': 'MyBundle::layout.html.twig',
      'my_own_var': 'cool !'} %}
  
  {% block test %}
      This block is printed directly if request is xmlHttpRequest, but extends MyBundle::layout.html.twig otherwise
  {% endblock %}

  You can choose the blocks you want to display with the _blocks parameter

  {% decorate 'xmlhttprequest' with {
      '_template': 'MyBundle::layout.html.twig',
      '_blocks': ['test']
      'my_own_var': 'cool !'} %}
  
  {% block test %}
      This block is printed if request is xmlHttpRequest, but extends MyBundle::layout.html.twig otherwise
  {% endblock %}
  
  {% block test_not_printed %}
      This block is NOT printed if request is xmlHttpRequest, but extends MyBundle::layout.html.twig otherwise
  {% endblock %}

EXTEND

Create your own grabber or decorator.

Grabber

Your class must implement Gloomy\TwigDecoratorBundle\Grabber\GrabberInterface which has only 1 method:

• public function getVariables(array $variables);

Decorator

Your class must implement Gloomy\TwigDecoratorBundle\Decorator\DecoratorInterface which has only 2 methods:

• public function getTemplate(array $variables);
• public function getVariables(array $variables);

Then define a tagged service and use it as the first argument of the {% grab %} or {% decorate %} tag. The tag can be :

    <tag name="gloomy.grabber" alias="my_alias"/>
    <tag name="gloomy.decorator" alias="my_alias"/>

LICENSE

MIT

INSTALLATION

1. Install with composer

composer.phar require "gloomy/twig-decorator-bundle" "*"

2. Modify your app/AppKernel.php

<?php
    //...
    $bundles = array(
        //...
        new Gloomy\TwigDecoratorBundle\GloomyTwigDecoratorBundle(),
    );