Créer une extension pour Twig

Pour enregistrer votre extension, deux cas se présentent. Le premier est celui où vous utilisez Twig en standalone :

$twig = new Twig_Environment($loader);
$twig->addExtension(new AppExtension());

Pour une intégration à Symfony2, c'est plus compliqué, il faut utiliser le principe DependencyInjection, très puissant mais pas forcément simple à manipuler au début.

Pour cela, le mieux est de placer tout ce qui concerne l'injection de dépendances dans un répertoire spécifique, DependencyInjection à la racine de votre bundle par exemple. Créons-y un fichier du nom du bundle qui contient l'extension, soit AppExtension dans notre cas. Notez que l'on définit alors le bundle courant comme une extension de Symfony2. Par exemple, si votre bundle s'appelle AppBundle, ce fichier devra s'appeler AppExtension. AppBundle correspond au fichier de bundle créé à la racine dudit bundle (le fichier créé par la ligne de commande lors de l'initialisation d'un bundle).

Tout se déroule dans la fonction load(). Nous allons faire au plus simple : simplement donner un fichier de configuration dans lequel tout sera mis. C'est aussi la méthode la plus propre, l'autre consistant à définir chaque extension directement dans ce fichier PHP. Nous verrons aussi comment faire juste après.

<?php
 
namespace App\AppBundle\DependencyInjection;
 
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
 
class AppExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container)
    {
        $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
        $loader->load('services.yml');
    }
}

Maintenant, il va falloir mettre ce qu'il faut dans ce fichier de configuration Resources/config/services.yml à la racine de votre bundle :

services:
    twig.extension.twigext:
        class: App\AppBundle\Twig\Extension\AppExtension
        tags:
            - { name: twig.extension }

La méthode sans fichier de configuration se résume à ce genre de fichier d'injection de dépendance :

<?php 

namespace Bundle\AppBundle\DependencyInjection;
 
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;
 
class AppExtension extends Extension
{
    public function load(array $config, ContainerBuilder $container)
    {
        $definition = new Definition('App\AppBundle\Extension\AppExtension');
        $definition->addTag('twig.extension'); 
        $container->setDefinition('app_twig_extension', $definition); // le nom de l'extension renseigné dans "getName" de l'extension Twig
    }
}

Cette extension Twig peut comporter des fonctions, qui sont enregistrées comme suit :

    public function getFunctions()
    {
        return array(
            'fc' => new \Twig_Function_Method($this, 'fc', array('is_safe' => array('html'))),
            'fc2' => new \Twig_Function_Method('fc2', array('is_safe' => array('html'))),
        );
    }
 
    public function fc($txt)
    {
        // votre code
    }

Dans le dernier cas, il s'agira de la fonction fc2, elle doit être accessible dans ce fichier (définie à la suite ou include).

La fonction appelée doit renvoyer directement ce qui doit être mis dans le contenu envoyé au navigateur.

Un filtre est une fonction qui prend en paramètre un certain texte et le renvoie transformé. Par exemple, une date, qui est rendue dans un autre format. Un filtre prend donc toujours au moins un paramètre, ce texte à transformer. Il peut en prendre d'autres (reprenons l'exemple de la date : un second paramètre peut être le format).

    public function getFilters()
    {
        return array(
            'date' => new Twig_Filter_Function('date'),
            'datebis' => new Twig_Filter_Function($this, 'date'),
            'fluo' => new Twig_Filter_Function($this, 'fluo'),
        );
    }
 
    public function date($timestamp, $format)
    {
        return '42' . date($format, $timestamp); 
    }
 
    public function fluo($text, $what)
    {
        return preg_replace('/(' . $what . ')/', '<span style="background-color: #FFFF00; color: #0000FF;">\1</span>', $text);
    }

Remarquez qu'on a ici surchargé le filtre standard de Twig date. On peut évidemment brancher derrière ce filtre une implémentation beaucoup plus spécifique en remplacement du fonctionnement standard. Un exemple d'implémentation de filtre tout à fait personnalisé est aussi fourni ci-dessus pour le filtre datebis, qui ne surcharge aucun filtre préexistant. Une implémentation de filtre doit renvoyer, au même titre qu'une fonction, ce qui doit être écrit dans le fichier renvoyé au navigateur. La dernière méthode, fluo, permet de mettre en évidence ce qui est passé en argument. Maintenant, comment appeler ces filtres ?

{{ '1305238362'|datebis(l jS \of F Y h:i:s A')}}

{{ 'Un peu de texte'|fluo('t')|raw }}

Remarquez l'utilisation du filtre raw après fluo : ce dernier renvoie du code HTML à écrire tel quel, il faut donc l'écrire sans aucun échappement.