Twig Template Engine for Primer

, _(*1)

A template engine for Primer that uses Twig rather than the deafult (Handlebars)., _(*2)

Installation

In the composer.json in your Primer install, replace:, _(*3)

"rareloop/primer-template-engine-handlebars": "dev-master"

with:, _(*4)

"rareloop/primer-template-engine-twig": "1.0.*"

Run composer update., _(*5)

Modify your bootstrap/start.php file and change the Primer::start call to include the templateClass e.g., _(*6)

$primer = Primer::start(array(
    'basePath' => __DIR__.'/..', 
    'templateClass' => Rareloop\Primer\TemplateEngine\Twig\Template::class,
));

Replace all .hbs files in your patterns and views with `.twig' files. If you don't want to do this by hand you can download the base Primer files in Twig format from this repo., _(*7)

Usage

Including patterns within one another

Any pattern can be included within another by using the standard include syntax, e.g., _(*8)

<div class="sub-pattern">
    {% include 'elements/forms/input' %}
</div>

More information on using {% include %} and manipulating the passed in context can be found on the Twig website., _(*9)

Extending Templates

By default, Primer will wrap all page Templates with a common View (views/template.twig). When using {% extends %} this wrapping is sometimes undesirable, in such circumstances you can disable this behaviour in a couple of ways., _(*10)

On a per page Template basis. Add the following to the Templates data.json file:, _(*11)
```
{
    "primer": {
        "view": "custom-view"
    }
}
```

Site wide. Add wrapTemplate: false to the Primer::start call in bootstrap/start.php, e.g., _(*12)

$primer = Primer::start([
    'basePath' => __DIR__.'/..',

    'templateClass' => TwigTemplateEngine::class,
    'wrapTemplate' => false,
]);

Twig Template Cache

By default Primer uses a directory called cache inside the project root for cache files. To change this to somewhere else you can set an alternative when you start Primer in bootstrap/start.php, e.g., _(*13)

$primer = Primer::start(array(
    'basePath' => __DIR__.'/..', 
    'cachePath' => 'absolute/path/to/cache/dir',
    'templateClass' => Rareloop\Primer\TemplateEngine\Twig\Template::class,
));

Custom Events

Most of the Primer events are still available, this package adds a few engine specific events too:, _(*14)

Twig Engine Initialisation

Called when the Twig engine is created. Useful for registering custom helpers with the Twig engine., _(*15)
```
Event::listen('twig.init', function ($twig) {

});
```