zeliard91/twigstring-bundle

Renders strings instead of files with Twig

Installs: 3 288

Dependents: 0

Suggesters: 0

Stars: 1

Watchers: 1

Forks: 18

Type:symfony-bundle

v1.1.0 2017-11-02 11:14 UTC

README

Build Status

This Symfony2 Bundle adds the possibility to render strings instead of files with the Symfony2 native Twig templating engine. The Bundle adds an additional service named twigstring. It is used the same way as the original templating service. The only difference is that the first argument of the method render(<string>, [<array]) is a string to parse instead of a template file.

The bundles supports variable output, conditions, loops and rendering of an controller. It does NOT support including templates, yet. It would interpret the template name as twigstring.

One example usage scenario is to load templates from the database instead of using files.

Extension ideas:

  • option to include templates
  • add a black-/whitelist for allowed allowed twig tags

Installation

1. Register the bundle in composer

You need to add it to your composer.json requirements:

{
    "require": {
         "zeliard91/twigstring-bundle": "~1.0"
    }
}

2. Downloading the bundle from packagist

Install it by running the following command:

$ ./composer.phar update zeliard91/twigstring-bundle

3. Registering the bundle in the kernel

<?php
// app/AppKernel.php

public function registerBundles() {
    $bundles = array(
        // ...
        new LK\TwigstringBundle\LKTwigstringBundle(),
        // ...
    );
}

4. Registering the bundle in the configuration

# app/config/config.yml
lk_twigstring:
    # Decide if you want that all registered twig extensions must be loaded
    load_twig_extensions: true # (default to true)

5. Add additional extensions you are in need of (optional)

# app/config/services.yml
services:
    twigstring.extension.foo:
        class: Foo\BarBundle\Twig\FooBarExtension
        tags:
            - { name: twigstring.extension }

For a list of available extensions see fabpot/Twig-extensions or create one on your own with Symfony Cookbook and twig doc.

Usage

// set example parameter
$vars = array('var'=>'x');

// get twigstring service
$tpl_engine = $this->get('twigstring');

// render example string
$vars['test'] = 'u ' . $tpl_engine->render('v {{ var }} {% if var is defined %} y {% endif %} z{% for i in 1..5 %} {{ i }}{% endfor %}', $vars);

or use the short way:

// set example parameter
$vars = array('var'=>'x');

// render example string
$vars['test'] = 'u ' . $this->get('twigstring')->render('v {{ var }} {% if var is defined %} y {% endif %} z{% for i in 1..5 %} {{ i }}{% endfor %}', $vars);

Example output:

u v x y z

License

The bundle is licensed under MIT license. For full license see LICENSE file

Authors

LarsK (Lars Krüger), cordoval (Luis Cordova), r1pp3rj4ck (Attila Bukor), zeliard91 (Damien Matabon)