Apprendre à exploiter le moteur de templates Twig dans Symfony

iner dukoid

Ce tutoriel a pour but de vous apprendre le moteur de templates Twig, qui est intégré dans Symfony depuis la version 2, du framework PHP.

Commentez

- Titre : Apprendre à exploiter le moteur de templates Twig dans Symfony

- Auteur : iner dukoid

- Parution : 22 mars 2016

- Mise à jour : 29 août 2016

- Public visé :

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2016 iner dukoid. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. À propos

- II. Avantages de Twig

- III. Le langage Twig

- III-A. Affichage des données

- III-B. Concaténation

- III-C. Les variables

- III-D. Condition IF : {% if … %} … {% endif %}

- III-E. La boucle FOR: {% for … %} {% endfor %}

- III-F. Commentaire: {# … #}

- III-G. Les filtres

- III-H. Les fonctions

- III-I. Les macros

- III-J. Named Arguments

- III-K. Les tags ou actions

- III-L. Include de template (Symfony)

- III-M. Render controller (Symfony)

- III-N. Personnaliser les templates: héritage, block…

- III-O. Les liens (Symfony)

- III-P. L'inclusion de feuilles de style et de JavaScripts avec Twig (Symfony)

- III-Q. Vérification de la syntaxe

- III-R. Les formats de template (Symfony)

- III-S. créer un filtre (Symfony)

- III-T. Math

- III-U. Coding Standards

- IV. Remerciements

I - À propos

Twig est un moteur de templates qui a été créé par SensioLabs, les créateurs de Symfony.
On le retrouve nativement dans les frameworks Symfony et Drupal8, mais il peut être installé sur la majorité des frameworks ainsi que dans un environnement PHP.

Dans ce tutoriel pas de long discours explicatif. J'ai choisi de présenter un exemple Twig et son équivalent en PHP. Parfois aucune explication, en lisant l'exemple du code, on comprend le fonctionnement.

Même si ce tutoriel est orienté Symfony, il peut être valable pour apprendre Twig de façon générale.

II - Avantages de Twig

1. Twig permet de séparer la présentation des données du traitement.

2. Twig permet la personnalisation de page web.

3. Twig permet de rendre les pages web plus lisibles, plus claires.

4. Twig est rapide.

5. Twig apporte de nouvelles fonctionnalités.

6. Twig apporte plus de sécurité.

Mais aussi :

- Twig est facile à apprendre ;

- les messages d'erreur Twig sont clairs et précis ;

- Twig est supporté par la plupart des éditeurs de code.

A.

Bien souvent, afficher une donnée brute ne suffit pas. On veut lui appliquer un traitement logique avant de l'afficher (une conversion, un calcul…).

Twig permet de définir en dehors de la page web des filtres que l'on pourra appliquer à la donnée.

B.

Un block menu, un block recherche, un block contenu… le tout défini dans un template lui-même héritable.

C.

On a souvent besoin de boucles, de conditions… à la construction d'une page web et pour cela, on utilise PHP. Votre page devient vite illisible, peu maintenable, sujette à de nombreuses erreurs.

Twig par son langage est moins invasif que PHP et se substitue à celui-ci.

TWIG

{% for value in items if value.active %}
<img src="{{ value.url }}"/>
{% endfor %}

PHP

<?php foreach ($items as $value):
if ($value.active) {?>
<img src="<?php echo $value.url;?>"/>
<?php } endforeach;?>

D.

La conversion Twig/PHP ne se fait qu'une seule fois au premier appel, ensuite il est mis en cache pour les autres appels (et donc finalement, c'est aussi rapide qu'en PHP).

E.

Twig apporte de nouvelles fonctionnalités: les macros, les filtres, les blocks, l'héritage de templates…

F.

Avec Twig, plus de sécurité avec l'échappement des variables qui est activé par défaut.

III - Le langage Twig

Faisons le tour de toute la syntaxe du langage Twig.
{% %}: pour faire une action : un set de variable, une condition if, une boucle for ;
{{ }}: pour afficher quelque chose.

III-A - Affichage des données

L'affichage des données et l'échappement :

TWIG

<b>{{ 'coucou' }}</b>

coucou

TWIG

{% set data = '<h1>coucou</h1>' %}
{{ data }}

<h1>coucou</h1>

Pour la sécurité, l'échappement est activé par défaut. Les balises ne sont pas interprétées. L'échappement convertit la donnée en code HTML avant l'affichage.

Forcer l'interprétation des balises avec le filtre raw :

TWIG

{% set data = '<h1>coucou</h1>' %}
{{ data|raw }}

coucou

Si l'échappement par défaut a été désactivé. Forcer l'échappement avec le filtre e :

TWIG

{% set data = '<h1>coucou</h1>' %}
{{ data|e }}

<h1>coucou</h1>

L'affichage des données de différents types: objet, tableau…

TWIG

{{ produit.nom }}
{{ produit.categorie.nom }}

PHP

<?php
echo $produit->getNom();
echo $produit->getCategorie()->getNom();
?>

TWIG

{{ produit["nom"] }}    ou    {{ produit.nom }}

PHP

<?php
echo $produit["nom"];
?>

TWIG

{% set animal = 'oiseaux' %}
{{ "il y a des #{animal} sur le toit" }}

{{ 14752 / 22 = #{14752 / 22} }}

PHP

<?php
$animal = 'oiseaux';
echo sprintf('Il y a des %s sur le toit',  $animal);

echo printf('14752 / 22 = %d',  (14752 / 22));
?>

L'affichage de données avec suppression d'espace entre deux balises à gauche ou à droite ou les deux :

supprimer les espaces entre les balises HTML

TWIG

{% spaceless %}
<div>          <strong>foo bar</strong>
</div>
{% endspaceless %}

Conversion en : (avant affichage)

<div><strong>foo bar</strong></div>

supprimer les espaces à gauche puis des deux côtés avec le caractère '-' :

TWIG

<li>    {{- 'bonjour' }}    </li>
<li>    {{- 'aurevoir' -}}    </li>

Conversion en: (avant affichage)

<li>bonjour    </li>
<li>aurevoir</li>

III-B - Concaténation

TWIG

{{ "Description du produit:" ~ produit.description }}

PHP

<?php
echo "Description du produit:"  .
$produit->getDescription();
?>

TWIG

{% set texte = greeting ~ name|lower %}
{{ texte }}

PHP

<?php
$texte = $greeting . strtolower($name);
echo  $texte;
?>

TWIG

{{ (greeting ~ name)|lower }}

PHP

<?php
echo strtolower($greeting . $name);
?>

III-C - Les variables

TWIG

{% set pi = 3.14 %}

{% set foo = 'foo' %}

- tableau simple avec une série de valeurs:
{% set tableau=[1, 2, 3] %}

- tableau avec des clés:
{% set tableau={key1:value1, key2:value2} %}

- tableau avec valeur et clé:
{% set foo = [3, {"mot": "soleil"}] %}
- afficher le contenu de 'mot' donc 'soleil':
{{ foo[1]['mot'] }}

- déclarer 2 variables en même temps // foo='foo'   // bar='bar':
{% set foo, bar = 'foo', 'bar' %}

- foo contient le texte entre les 2 balises:
{% set foo %}
<div id="pagination">
…
</div>
{% endset %}

[ … ] un tableau avec une série de valeurs.

{ … } un tableau avec des couples clé/valeur.

Les variables globales (Symfony)

parameters,yml

parameters:
webmaster: dark-vador

Config.yml

twig:
globals:
webmaster: %webmaster%

TWIG

{{ webmaster }}

Résultat à l'affichage

dark-vador

La variable globale webmaster sera accessible dans tous les templates Twig.

Cas particulier : une variable nommée avec un caractère spécial. ('-'…). L'attribut d'un objet (article.info-produit) ou la clé d'un tableau article['info-produit'] :

une donnée avec '-'

article.data-description

TWIG

{{ attribute(article, 'data-description') }}

ERREUR -> {{ article.data-description }}

une donnée avec '-'

{% set tableau={'data-info': 'information'} %}

TWIG

{{ attribute(tableau, 'data-info') }}
ou
{{  tableau['data-info'] }}

ERREUR -> {{ tableau.data-info }}

à savoir :

TWIG

{{ attribute(object, method) }}
{{ attribute(object, method, arguments) }}
{{ attribute(array, item) }}
{{ attribute(object, method) is defined? 'Method exists': 'Method does not exist' }}

http://twig.sensiolabs.org/doc/functions/attribute.html

III-D - Condition IF : {% if … %} … {% endif %}

and, or, not, is defined, starts with, ends with, matches, in, empty

TWIG

{% if produits is empty %}
il n'y a plus de produit
{% endif %}

{% if ((a==1 and b>0) or not c==0) and d is defined %}
{% set resultat = (d + a * b) / c %}
{{ resultat }}
{% endif %}

{% if 'Fabien' starts with 'F' %}
commence par F
{% endif %}

{% if 'Fabien' ends with 'n' %}
Finis par n
{% endif %}

- regular expressions:
{% if phone matches '/^[\\d\\.]+$/' %}
format telephone ok
{% endif %}

{% if 5 not in [1, 2, 3] %}
5 non présent
{% endif %}

mais aussi :

is null: si est null ;
is constant: comparer si est une constante ;
is divisible by(x): si est divisible par x ;
is even: si est pair ;
is odd: si est impair ;
is iterable: si est du type itérable (comme une liste) ;
is same as: comparer 2 variables (en php correspond ===).

Sous une autre forme :

TWIG

{{ article is null? 'yes': 'no' }}    // affiche yes ou no

{{ var is odd }}        // Affiche true ou false
// pareil que: {% if var is odd %}true{% else %}false{% endif %}

{{ var is null }}        // Affiche true ou false

http://twig.sensiolabs.org/doc/tests/index.html

III-E - La boucle FOR: {% for … %} {% endfor %}

TWIG

- affiche 0123456789
{% for i in 0..9 %}  // pareil que {% for i in range(0, 9) %}
{{ i }}
{% endfor %}

{% for produit in produits %}
{{ produit.nom }}
{% endfor %}

- avec une condition:
{% for produit in produits if produit.etat==1 %}
{{ produit.nom }}
{% endfor %}

- boucle for avec condition vide:
{% for article in articles %}
{{ article.nom }}
{% else %}
pas d'article trouvé
{% endfor %}

- clés et valeurs:
{% for key, value in table %}
{{ key }} {{ value }}
{% endfor %}

- les 10 premiers users:
{% for user in users|slice(0, 9) %}
<li>{{ user.username }}</li>
{% endfor %}

- bascule:
{% for i in 0..10 %}
<div class="{{ cycle(['fond-noir', 'fond-blanc'], i) }}">       //  fond-noir / fond-blanc  /  …

</div>
{% endfor %}

La variable loop de la boucle for :

TWIG

{{ loop.index }}        // Numéro de l'itération courante en commençant par 1
{{ loop.index0 }}         // Numéro de l'itération courante en commençant par 0
{{ loop.revindex }}        // Nombre itérations restantes avant la fin en commençant par 1
{{ loop.revindex0 }}        // Nombre itérations restantes avant la fin en commençant par 0
{{ loop.first }}        // La première itération?  True ou false
{{ loop.last }}            // La dernière itération? True ou false
{{ loop.length }}        // Nombre total d'itérations

Un exemple avec loop :

TWIG

{% for produit in produits %}
<span class="{% if loop.index is even %}fond-noir{% else %}fond-blanc{% endif %}">
{{ produit }}
</span>
{% endfor %}

III-F - Commentaire: {# … #}

TWIG

{# mon commentaire #}

III-G - Les filtres

On peut appliquer des filtres sur une variable à afficher, sur une variable d'une condition IF ou d'une boucle FOR…

Le filtre length

TWIG

{% for i in 0..produits|length %}

{% endfor %}

PHP

<?php
for ($i=0; $i<count($produits); $i++) {

}
?>

Appliquer plusieurs filtres: trim et upper

TWIG

{{ "les fleurs du mal"|trim|upper }}

PHP

<?php
echo  strtoupper(trim("les fleurs du mal"));
?>

Une autre façon d'appliquer un filtre upper

TWIG

{% filter upper %}
C'est l'heure exquise et matinale
Que rougit un soleil soudain.
A travers la brume automnale
{% endfilter %}

Avec un long texte, sous cette forme c'est plus pratique et plus clair.

à savoir:

La liste des filtres

http://twig.sensiolabs.org/doc/filters/index.html

TWIG

abs, batch, capitalize, convert_encoding, date, date_modify, default, escape, first, format, join, json_encode, keys, last, length, lower, merge,
nl2br, number_format, raw, replace, reverse, round, slice, sort, split, striptags, title, trim, upper, url_encode

Nous verrons plus loin comment créer nos propres filtres.

III-H - Les fonctions

Une fonction effectue un traitement (contrairement à un filtre qui est destiné à faire une conversion) :

TWIG

- la fonction dump: affiche tout le détail d'un objet ou d'un tableau
{{ dump(produit) }}

- la fonction max:   retourne le max d'une série de valeurs
{% set tab = [1, 5, 2, 3] %}
{{ max(tab) }}                // affiche  5

Liste des fonctions :

TWIG

attribute, block, constant, cycle, date, dump, include, max, min, parent, random, range, source, template_from_string

http://twig.sensiolabs.org/doc/functions/index.html

III-I - Les macros

Les macros sont comme des fonctions, mais composées de fragments HTML réutilisables.
Dans un template, on regroupe toutes les macros que l'on pourra importer dans un autre template afin d'être utilisées.

Prenons pour exemple un template forms.html.twig qui va contenir plusieurs macros. Une macro pour la balise input et une qui affiche une liste d'article.

forms.html.twig

{% macro input(name, value, type, size) %}
<input type="{{ type|default('text') }}" name="{{ name }}" value="{{ value|e }}" size="{{ size|default(20) }}" />
{% endmacro %}

{% macro articleListe(articles, className) %}
<ul {% if className %}class="{{ className }}"{% endif %}>
{% for article  in articles %}
<li class="article"><a href="{{ article.url }}">{{ article.nom }}</a></li>
{% endfor %}
</ul>
{% endmacro %}

Son utilisation : soit on importe toutes les macros, soit on choisit celle que l'on veut importer :

mapage.html.twig : avec import de toutes les macros se trouvant dans forms.html.twig

{% import "forms.html.twig" as forms %}

<p>{{ forms.input('livre', 'saint-exupery') }}</p>

mapage.html.twig : avec import d'une seule macro parmi les macros se trouvant dans forms.html.twig

{% from 'forms.html.twig' import input as input_field %}

<p>{{ input_field('livre', 'saint-exupery') }}</p>

mapage.html.twig : la macro se trouve dans la page même. (sans import)

{% macro input(name, value, type, size) %}
<input type="{{ type|default('text') }}" name="{{ name }}" value="{{ value|e }}" size="{{ size|default(20) }}" />
{% endmacro %}

<p>{{ _self.input('livre', 'saint-exupery', 'text', 64) }}</p>

Une macro dans la page même de son utilisation, pour cela on utilise _self. Mais on perd sa réutisabilité.

III-J - Named Arguments

Donner des noms aux arguments pour une meilleure compréhension et de pouvoir cibler un argument.

Des exemples :

TWIG

- au lieu de  ... range(1, 10, 2) :
{% for i in range(low=1, high=10, step=2) %}
{{ i }},
{% endfor %}

- l'argument ciblé est timezone parmi les autres arguments (format, date...)
{{ "now" | date(timezone="Europe/Paris") }}       //

{{ data|convert_encoding(from='iso-2022-jp', to='UTF-8') }}

III-K - Les tags ou actions

{% … %} Les commandes de base Twig pour faire des actions comme: for, if, set…

Liste de toutes les commandes :

TWIG

autoescape, block, do, embed, extends, filter, flush, for, from, if, import, include, macro, sandbox, set, spaceless, use, verbatim

http://twig.sensiolabs.org/doc/tags/index.html

III-L - Include de template (Symfony)

Inclure des fichiers template.

mapage.html.twig

<ul>
{% for item in items %}
{% include  "AcmeDemoBundle:dossier:render_item.html.twig" with {'item': item} only %}
{% endfor %}
</ul>

only est facultatif. Il permet d'indiquer que le fichier inclus n'a pas besoin des variables extérieures, mais seulement ceux passés en paramètres.

Mais aussi :

TWIG

- Un include avec  une condition:
{% include isValid ? 'option1.html.twig' : 'option2.html,twig' %}

- Si la page de l'include n'existe pas, alors il n'y aura pas d'erreur. Rien ne se passe.
{% include "index.html" ignore missing %}

III-M - Render controller (Symfony)

Faire appel à une action du contrôleur qui renvoie un rendu qui va être inclus.

Exemple : récupérer les trois derniers articles les plus récents :

TWIG

{{ render(controller('AcmeDemoBundle:Article:recentArticles', { 'max': 3 })) }}

// Fait appel à une action (recentArticlesAction) du controller (ArticleController)
// retourne un rendu avec les 3 derniers articles.

III-N - Personnaliser les templates: héritage, block…

Pour personnaliser les templates, Twig propose un système de blocks et d'héritage de templates.

Prenons cet exemple :
toutes les pages "client" et les pages "produit" ont le même header et footer ;
les pages client ont une recherche par client ;
les pages produit ont une recherche par produit ;
toutes les pages "client" et "produit" ont leur propre contenu respectif.

base.html.twig

<html>
<head>...</head>

<body>
<div class="head">     {% block header %} header {% endblock %}  </div>
<div class="sidebar">  {% block recherche %}{% endblock %}       </div>
<div class="content">  {% block contenu %}{% endblock %}         </div>
<div class="footer">   {% block footer %} footer {% endblock %}  </div>
</body>
</html>

Layout-client.html.twig

{% extends "::base.html.twig" %}

{% block recherche %}
recherche client
{% endblock %}

Layout-produit.html.twig

{% extends "::base.html.twig" %}

{% block recherche %}
recherche produit
{% endblock %}

* Toutes les pages web 'client'

{% extends "AcmeDemoBundle::layout-client.html.twig" %}

{% block contenu %}
... contenu client ...
{% endblock %}

* Toutes les pages web 'produit'

{% extends "AcmeDemoBundle::layout-produit.html.twig" %}

{% block contenu %}
... contenu produit ...
{% endblock %}

Résultat

Avec une page web "client"

Avec une page web "produit"

header
recherche client
contenu client
footer

header
recherche produit
contenu produit
footer

Les avantages :

- finalement, pour créer une page web "client" ou "produit", on hérite de son layout et on ajoute son propre contenu et… c'est tout ;

- si vous voulez modifier le header (de toutes les pages), il suffit de ne le modifier qu'à un seul endroit c'est-à-dire dans la base.

D'autres possibilités avec les blocks :

Identique

TWIG

{% extends "AcmeDemoBundle::layout-client.html.twig" %}

{% block contenu %}
contenu client
{% endblock %}

Le fait de ne pas mentionner un block parent a pour résultat que le contenu est tout de même inclus automatiquement par héritage.

header
recherche client
contenu client
footer

Identique

TWIG

{% extends "AcmeDemoBundle::layout-client.html.twig" %}

{% block header %} {{ parent() }} {% endblock %}
{% block recherche %} {{ parent() }} {% endblock%}
{% block contenu %} contenu client {% endblock %}
{% block footer %} {{ parent() }} {% endblock %}

{{ parent() }}: appelle du contenu parent

header
recherche client
contenu client
footer

Supprimer un block parent

Suppression du block recherche

TWIG

{% extends "AcmeDemoBundle::layout-client.html.twig" %}

{% block recherche %}{% endblock%}
{% block contenu %} contenu client {% endblock %}

Le fait de mentionner un block et qu'il soit vide a pour résultat que le contenu parent n'est pas appelé

header

contenu client
footer

Remplacer le contenu d'un block par un autre

sur le block recherche

TWIG

{% extends "AcmeDemoBundle::layout-client.html.twig" %}

{% block recherche %}un autre contenu{% endblock%}
{% block contenu %} contenu client {% endblock %}

header
un autre contenu
contenu client
footer

Ajouter du contenu dans un block

sur le block recherche

TWIG

{% extends "AcmeDemoBundle::layout-client.html.twig" %}

{% block recherche %}
{{parent() }} <br/>
un texte en dessous
{% endblock%}
{% block contenu %} contenu client {% endblock %}

header
recherche client
un texte en dessous
contenu client
footer

Pour information, dans cette partie "personnalisation, héritage…" seule la façon d'écrire l'extends est liée à Symfony: {% extends "AcmeDemoBundle::layout-client.html.twig" %}.

III-O - Les liens (Symfony)

TWIG

- vers fichiers assets :
<img src="{{ asset('images/logo.png') }}" />

- Vers url / :
<a href="{{ path('_welcome') }}">Home</a>

- Vers url / avec des paramètres :
<a href="{{ path('article_show', { 'slug': article.slug }) }}">
{{ article.title }}
</a>

- Vers url absolue :
<a href="{{ url('_welcome') }}">Home</a>

III-P - L'inclusion de feuilles de style et de JavaScripts avec Twig (Symfony)

http://symfony.com/doc/current/book/templating.html#including-stylesheets-and-javascripts-in-twig

III-Q - Vérification de la syntaxe

Avec les commandes Symfony, on peut vérifier la syntaxe Twig à plusieurs niveaux: template, dossier, bundle.

- Par template :
php app/console twig:lint src/Acme/ArticleBundle/Resources/views/Article/recentList.html.twig

- Par dossier :
php app/console twig:lint src/Acme/ArticleBundle/Resources/views

- Par bundle :
php app/console twig:lint @AcmeArticleBundle

III-R - Les formats de template (Symfony)

Les formats de template permettent de rendre en HTML, mais aussi en XML ou PDF.

http://symfony.com/doc/current/book/templating.html#including-stylesheets-and-javascripts-in-twig

III-S - créer un filtre (Symfony)

On a vu comment utiliser les filtres: {{ articles|length }}.
Il est possible de créer ses filtres, voici comment faire avec cet exemple.

Création d'un filtre price qui va formater une valeur en prix (monnaie dollars) :

src/AppBundle/Twig/AppExtension.php

// src/AppBundle/Twig/AppExtension.php
namespace AppBundle\Twig;

class AppExtension extends \Twig_Extension
{
public function getFilters()
{
return array(
new \Twig_SimpleFilter('price', array($this, 'priceFilter')),
);
}

public function priceFilter($number, $decimals = 0, $decPoint = '.', $thousandsSep = ',')
{
$price = number_format($number, $decimals, $decPoint, $thousandsSep);
$price = '$'.$price;

return $price;
}

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

Déclarer la classe en tant que service :

services.yml

app.twig_extension:
class: AppBundle\Twig\AppExtension
tags:
- { name: twig.extension }

Et plus qu'à utiliser le filtre price dans un template Twig :

TWIG

{{ '5500.25155'|price(2, ',', '') }}

$5500,25

TWIG

{{ '5500'|price }}

$5,500.00

III-T - Math

Un peu de math pour la route

TWIG

+ - * / : les bases

% : modulo donne le reste de la division
{{ 11 % 7 }} retourne 4.

// : arrondi inférieur ou supérieur sans les décimales
{{ 20 // 7 }} retourne 2
{{ 20 // 6 }} retourne 3

** : puissance
{{ 2 ** 3 }} retourne 8

III-U - Coding Standards

Toujours un et un seul espace entre les balises, les données… (sauf pour les filtres) :

TWIG

{{ foo }}
{# comment #}
{% if foo %}{% endif %}
{{ 1 + 2 }}
{{ foo ~ bar }}
{{ true ? true : false }}

un seul espace après (mais pas avant) un séparateur :

TWIG

{{ [1, 2, 3] }}
{{ {'foo': 'bar'} }}

inversement un seul espace avant (mais pas après) une parenthèse :

TWIG

{{ 1 + (2 * 3) }}

pas d'espace pour les filtres :

TWIG

{{ foo|upper|lower }}

indenter les blocks :

TWIG

{% block foo %}
{% if true %}
true
{% endif %}
{% endblock %}

IV - Remerciements

Je tiens à remercier Francis Walter pour sa relecture technique, Claude Leloup pour sa relecture orthographique et Guillaume SIGUI pour son encadrement.