Les filters Twig sont très utiles lors des développements d’interfaces. Vous ne pouvez pas le nier, vous les utilisez tous les jours et je suis sûr que vous aimez ça

Twig vient avec tout un tas de filters plus utiles les uns que les autres, je vous invite à consulter cette liste complète des filters par défaut.

Vous pouvez également installer des filters en plus de ceux par défauts comme par exemple les quelques filters que Fabien Potencier a regroupé dans un repository Github appelé « Twig-extensions » et que nous vous recommandons. Installez facilement grâce à Composer et vous pourrez par exemple utiliser les filters debug (équivalent d’un var_dump() depuis une vue Twig), des filters relatifs à la manipulation de chaines de caractères comme avec le filter truncate ou encore des filters vous donnant la possibilité d’internationaliser vos vues.

Les filters par défaut et ceux de Fabien Potencier répondent aux besoins de la majorité des développements mais qu’en est-il si vous vous rendez compte qu’aucun des filters que vous connaissez ne réponde à un besoin particulier que vous exprimez ? Rien de plus simple, créez-le ! C’est ce que nous allons voir ici.

Pour commencer, vous devez créer un dossier Twig dans lequel vous créerez un autre dossier Extension à la racine de votre Bundle. Lorsque c’est chose faite, créez dans ce dernier dossier un fichier portant le nom de votre extension Twig comme par exemple MyfilterExtension.php. Voici ensuite ce que vous devrez au moins avoir dans ce fichier :

namespace Acme\Bundle\AcmeBundle\Twig\Extension;

class MyfilterExtension extends \Twig_Extension
{
    public function getFilters()
    {
        return array(
            'myfilter' => new \Twig_Filter_Method($this, 'doSomething')
        );
    }

    public function doSomething($value)
    {
        return 'transformated-' . $value;
    }

    public function getName()
    {
        return 'myfilter_extension';
    }

}

Ce que fait ce filter est très simple, à chaque fois que vous utiliserez dans votre vue Twig le mot clef myfilter, il ajoutera la chaine ‘transformated-’ devant la valeur de la chaine sur laquelle vous être en train d’appliquer votre filter, par exemple :

{{ 'value' }}

Affichera la chaîne de caractère value en tant que telle dans votre vue.

{{ 'value' | myfilter }}

Affichera la chaîne de caractère transformated-value dans votre vue.
Je vous laisse imaginer toutes les possibilités que vous pouvez développer avec ça !

Une fois votre classe terminée, vous n’avez plus qu’à la déclarer dans votre services.xml afin d’injecter votre classe et de pouvoir l’utiliser.

...
<services>
    ...
    <service id="acme.twig.myfilter_extension" class="Acme\Bundle\AcmeBundle\Twig\Extension\MyfilterExtension"> 
        <tag name="twig.extension" />
    </service>
    ...
</services>
...

Un point intéressant consiste à donner la possibilité à votre filter d’accepter des paramètres depuis la vue Twig, en plus de la valeur (ou l’objet) sur lequel vous voulez effectuer un traitement. On pourrait imaginer par exemple un appel à notre filter suivant :

{{ 'value' | myfilter('rockin') }}

Et avoir une méthode doSomething() acceptant cette fois-ci un deuxième paramètre.

public function doSomething($value, $parameter)
{
    return 'transformated-' . $value . '-' . $parameter;
}

ce qui nous retournerais, en gardant notre exemple précédent, la chaîne transformated-value-rockin.

Bien sûr, ce n’est ici qu’une application simple, d’autres utilisations plus poussées des filters peuvent être faites comme par exemple passer un manager en paramètre à votre classe lors de l’injection pour pouvoir effectuer du traitement lié à des entités ou autre.