Germania KG Ā· TwigServiceProvider
Pimple Service Provider for Twig templating engine, (*1)
, (*2)
Installation with Composer
$ composer require germania-kg/twigserviceprovider
Alternatively, add this package directly to your composer.json:, (*3)
"require": {
"germania-kg/twigserviceprovider": "^1.0|^2.0"
}
The v2 release requires PHP 7.3+ and Twig from v2 and up., (*4)
Setup
Have your Pimple dependency container at hand and register the TwigServiceProvider:, (*5)
<?php
use Germania\TwigServiceProvider\TwigServiceProvider;
use Pimple\Container;
$pimple = new Container;
$pimple->register( new TwigServiceProvider );
Usage
Once you've registered the TwigServiceProvider, you can grab and use your Twig_Environment like this:, (*6)
<?php
$twig_environment = $pimple['Twig'];
echo $twig_environment->render('template', [ 'foo' => 'bar']);
From v2 of this package, with Twig v2 and up, this is also possible:, (*7)
$twig_environment = $pimple[ \Twig\Environment::class ];
ā¦There are more services, see Services section, (*8)
Configuration
The default options
<?php
$options = array(
// For Twig's Filesystem Loader (string or array)
'templates' => '/path/to/templates',
// The most important Twig Environment options
'debug' => false,
'cache' => '/path/to/cache',
'auto_reload' => true,
'autoescape' => false,
'strict_variables' => false
);
You can refine these options by either passing those you like to override to the constructor or extending the Twig.Config service at runtime:, (*9)
Override on instantiation
<?php
use Germania\TwigServiceProvider\TwigServiceProvider;
$custom_options = [
'templates' => [
'/another/path/to/templates',
__DIR__ . '/vendor/foo/bar/templates'
],
'strict_variables' => true
];
$pimple->register( new TwigServiceProvider( $custom_options ));
Override at runtime
<?php
$pimple->register( new TwigServiceProvider );
$pimple->extend('Twig.Config', function( $defaults, $pimple) {
return array_merge( $defaults, [
'templates' => $pimple['custom.templates'],
'strict_variables' => getenv('STRICT_ONLY')
]);
});
Other Services
Twig.Options
Per default, the Twig_Environment instance is built with the āmost importantā options defined configurationāsee Configuration section.. You may add other options, like so:, (*10)
// @return array
$pimple->extend('Twig.Options', function($options, $pimple) {
return array_merge($options, [
'charset' => 'iso-8859-1',
'optimizations' => 0
]);
});
Twig.CachePath
// @return string
$pimple->extend('Twig.CachePath', function($old, $pimple) {
return __DIR__ . '/var/cache';
});
Twig.TemplatePaths
// @return array
$pimple->extend('Twig.TemplatePaths', function($paths, $pimple) {
return array_merge($paths, [
'another/one',
'vendor/name/package/templates'
]);
});
Twig.Loaders
This service per default contains only the Twig_Loader_Filesystem instance;
To add one or more others, add them to the $loaders array:, (*11)
// @return array
$pimple->extend('Twig.Loaders', function($loaders, $pimple) {
return array_merge($loaders, [
new Twig_Loader_Array( [ ... ] )
]);
});
All loaders in $loaders will automatically be chained via Twig's Twig_Loader_Chain., (*12)
See Twig developer docs for full description., (*13)
Other services
All these services return an (empty) array you may extend with custom data. They all will be added into the Twig_Environment., (*14)
// @return array
$pimple->extend( 'Twig.Globals', ... );
$pimple->extend( 'Twig.Filters', ... );
$pimple->extend( 'Twig.Tests', ... );
$pimple->extend( 'Twig.Functions', ... );
$pimple->extend( 'Twig.Extensions', ... );
Development
$ git clone https://github.com/GermaniaKG/TwigServiceProvider.git
$ cd TwigServiceProvider
$ composer install
Unit tests
Either copy phpunit.xml.dist to phpunit.xml and adapt to your needs, or leave as is. Run PhpUnit test or composer scripts like this:, (*15)
$ composer test
# or
$ vendor/bi
Wallogit.com
