Programmation PHP/Symfony/Twig


InstallationModifier

Twig est un moteur de templates pour le langage de programmation PHP, utilisé par défaut par le framework Symfony. Son livre officiel faisant 156 pages[1], la présente pas aura plutôt un rôle d'aide mémoire et d'illustration.

Pour exécuter du code sans installer Twig, il existe https://twigfiddle.com/.

composer require symfony/templating

Anciennement sur Symfony 3 :

composer require twig/twig

Syntaxe nativeModifier

Les mots réservés suivants s'ajoutent au HTML déjà interprété :

  • {{ ... }} : appel à une variable ou une fonction PHP, ou un template Twig parent ({{ parent() }}).
  • {# ... #} : commentaires.
  • {% ... %} : commande, comme une affectation, une condition, une boucle ou un bloc HTML.
    • {% set foo = 'bar' %} : assignation[2].
    • {% if (i is defined and i == 1) or j is not defined or j is empty %} ... {% endif %} : condition.
    • {% for i in 0..10 %} ... {% endfor %} : compteur dans une boucle.
  • ' : caractère d'échappement.

TableauxModifier

CréationModifier

Pour créer un tableau itératif :

{% set myArray = [1, 2] %}

Un tableau associatif :

{% set myArray = {'key': 'value'} %}

A plusieurs lignes :

{% set months = {
    1: 'janvier',
    2: 'février',
    3: 'mars',
} %}
{{ dump(months[1]) }} {# 'janvier' #}

Multidimensionnel :

{% set myArray = [
    {'key1': 'value1'},
    {'key2': 'value2'}
] %}

Dans un "for ... in", pour séparer chaque élément avec une virgule :

{% if loop.first != true %}
    ,
{% endif %}

ModificationModifier

Pour ajouter une ou plusieurs lignes à un tableau, utiliser "merge()" :

{% set newArray = oldArray|merge([2,3]) %}

LectureModifier

Pour savoir si un tableau est vide, utiliser empty comme pour les chaines de caractères. Par exemple pour savoir si un tableau est vide :

my_array is empty

Pour le filtrer, utiliser filter[3]. Par exemple pour savoir si un tableau multidimensionnel a ses sous-tableaux vides :

my_array|filter(v => v is not empty) is empty

Précédence des opérateursModifier

Du moins au plus prioritaire[4] :

Opérateur Rôle
b-and Et booléen
b-xor Ou exclusif
b-or Ou booléen
or Ou
and Et
== Est-il égal
!= Est-il différent
< Inférieur
> Supérieur
>= Supérieur ou égal
<= Inférieur ou égal
in Dans (ex : {% if x in [1, 2] %})
matches Correspond
starts with Commence par
ends with Se termine par
.. Séquence (ex : 1..5)
+ Plus
- Moins
~ Concaténation
* Multiplication
/ Division
// Division arrondie à l'inférieur
% Modulo
is Test (ex : is defined ou is not empty)
** Puissance
| Filtre
[] Entrée de tableau
. Attribut ou méthode d'un objet (ex : country.name)

Pour afficher la valeur NULL dans un opérateur ternaire, il faut la mettre entre apostrophes :

{{ (myVariable is not empty) ? '"' ~ myVariable.value ~ '"' : 'null' }}

Fonctions usuellesModifier

  • url() : affiche l'URL en chemin absolu.
  • path() : affiche l'URL en chemin relatif. Les paramètres POST peuvent être ajoutés dans un tableau ensuite (ex : path(url, {'parametre1': param1}).
  • asset() : pointe vers le dossier des "assets" ("web" dans SF2, "public" dans SF4).
  • controller() : exécute la méthode d'un contrôleur. Ex : {{ render_esi(controller('App\\Controller\\DefaultController:indexAction')) }}.
  • constant() : importe une constante PHP[5].
  • date() : convertit en date, ce qui permet leur comparaison. Ex : {% if date(x) > date(y) %}. NB : comme en PHP, "d/m/Y" correspond au format "jj/mm/aaaa".

FiltresModifier

Les filtres fournissent des traitements sur une expression, si on les place après elle séparés par des pipes. Par exemple :

  • capitalize : équivaut au PHP ucfirst(), met une majuscule à la première lettre d'une chaine de caractères, et passe les autres en minuscules.
  • upper : équivaut au PHP strtoupper(), met la chaine en lettres capitales. Exemple pour ne mettre la majuscule que sur la première lettre : {{ variable[:1]|upper ~ variable[1:] }}.
  • first : affiche la première ligne d'un tableau, ou la première lettre d'une chaine.
  • length : équivaut au PHP sizeof(), renvoie la taille de la variable (chaine ou tableau).
  • format : équivaut au PHP printf().
  • replace : équivaut au PHP str_replace().
  • join : équivaut au PHP implode() : convertit un tableau en chaine avec un séparateur en paramètre.
  • trim : équivaut au PHP trim().
  • raw : ne pas échapper les balises HTML.
  • default : ce filtre lève les exceptions sur les variables non définies ou vides[6]. Ex :
{{ variable1 |default(null) }}

Variables spécialesModifier

  • loop contient les informations de la boucle dans laquelle elle se trouve. Par exemple loop.index donne le nombre d'itérations déjà survenue (commence par 1 et pas par 0).
  • Les variables globales commencent par des underscores, par exemple :
    • _route (partie de URL située après le domaine)
    • _self (nom de du fichier courant)
    Donc, pour obtenir la route d'une page : {{ path(app.request.attributes.get('_route'), app.request.attributes.get('_route_params')) }}
    L'URL courante : {{ app.request.uri }}
    La page d'accueil du site Web : url('homepage')
  • Les variables d'environnement CGI, telles que {{ app.request.server.get('SERVER_NAME') }}

Variables variablesModifier

Utiliser _context.

Gestion des espacesModifier

Un Twig bien formaté ne correspond pas forcément au rendu qu'il doit apporter. Pour supprimer les espaces du formatage dans ce rendu, il existe en Twig < 2.7[7] :

{% spaceless %}
    {% autoescape false %}
    <b>
        Hello World!
    </b>
{% endspaceless %}

Ceci est remplacé depuis Twig 2.7 par le filtre |spaceless[8].

De plus, on peut apposer le symboles "-" aux endroits où ignorer les espacements (dont retours chariot) du formatage :

    Hello {% ... -%}
    {%- ... %} World!

Cela fonctionne aussi entre {{- -}}.

Utilisation du traducteurModifier

ConfigurationModifier

Le module de traduction Symfony s'installe avec :

composer require translator

Quand une page peut apparaitre dans plusieurs langues, inutile d'injecter la locale dans le Twig depuis le contrôleur PHP, c'est une variable d'environnement que l'on peut récupérer avec :

{{ app.request.getLocale() }}

Le fichier YAML contenant les traductions dans cette langue sera automatiquement utilisé s'il est placé dans le dossier "translations" apparu lors de l'installation. En effet, il est identifié par le code langue ISO de son suffixe (ex : le Twig de la page d'accueil pourra être traduit dans homepage.fr.yml, homepage.en.yml, etc.).

Pour définir le préfixe des YAML auquel un Twig fera appel, on le définit sans suffixe en début de fichier Twig :

{% trans_default_domain 'homepage' %}

Par ailleurs, la commande PHP pour lister les traductions les traductions d'une langue est[9] :

php bin/console debug:translation en --only-unused  // Pour les inutilisées
php bin/console debug:translation en --only-missing // Pour les manquantes

Filtre transModifier

Une fois la configuration effectuée, on peut apposer le filtre trans aux textes traduis dans le Twig.

{{ MessageInMyLanguage |trans }}

Parfois, il peut être utile de factoriser les traductions de plusieurs Twig dans un seul YAML. Pour piocher dans un YAML qui n'est pas celui par défaut, il suffit de le nommer en second paramètre du filtre trans :

 {{ 'punctuation_separator'|trans({}, 'common') }}
  Si le YAML contient des balises HTML à interpréter, il faut apposer le filtre raw après trans.


Si une variable doit apparaitre dans une langue différente de celle de l'utilisateur, on le précisera dans le troisième paramètre du filtre trans :

{{ FrenchMessage |trans({}, 'common', 'fr') }}

Si le YAML doit contenir une variable, on la place entre pourcentages pour la remplacer en Twig avec le premier paramètre du filtre trans :

{{ variableMessage |trans({"%price%": formatPrice(myPrice)}) }}
  Si la clé à traduire doit être variable, on ne peut pas réaliser la concaténation dans la même commande que la traduction : il faut décomposer en deux lignes :
{% set variableMessage = 'constante.' ~ variable %}
{{ variableMessage |trans }}


Opération transModifier

Il existe aussi une syntaxe alternative au filtre. Par exemple les deux paragraphes ci-dessous sont équivalents :

{{ 'punctuation_separator'|trans({}, 'common') }}

{% trans from 'common' %}
    punctuation_separator
{% endtrans %}


De plus, on peut injecter une variable avec "with". Voici deux équivalents :

{{ 'Bonjour %name% !' |trans({"%name%": name}) }}

{% trans with {'%name%': name}%}Bonjour %name% !{% endtrans %}

ImagesModifier

Stockage d'une image dans variable Twig :

{% set myImage = '<img src="' ~ {{ asset('images/myImage.png') }} ~ '">' %}

Méthodes PHP appelables en TwigModifier

En PHP, on peut créer des classes qui étendent Twig_Extension et dont les méthodes seront invocables en Twig, et de la déclarer par surcharge de getFunctions(). Ex :

return [
    new Twig_SimpleFunction('getPrice', [$this, 'getPrice']),
];

Héritages et inclusionsModifier

extendsModifier

Si une fichier appelé doit être inclus dans un tout, il doit en hériter avec le mot extends. Le cas typique est celui d'une "base.html.twig" qui contient l'en-tête et le pied de page HTML commun à toutes les pages d'un site. Ex :

    {% extends "base.html.twig" %}
  Twig ne supporte pas l'héritage multiple[10].


Il est possible de surcharger totalement ou en partie les blocs du template parent. Exemple depuis le template qui hérite :

    {% block header %}
        Mon en-tête qui écrase le parent
    {% endblock %}

    {% block footer %}
        Mon pied de page qui complète le parent
        {{ parent() }}
    {% endblock %}

includeModifier

A contrario, si un fichier doit en inclure un autre (par exemple pour qu'un fragment de vue soit réutilisable dans plusieurs pages), on utilise le mot include. Ex :

    {% include("partials/footer.html.twig") %}

En lui injectant des paramètres :

    {% include("partials/footer.html.twig") with {'clé': 'valeur'} %}
  On trouvait en Twig 1 la syntaxe {{ include() }}[11] au lieu de {% include() %}[12] en Twig 2.


render_esiModifier

Inclus un Twig avec le cache Edge Side Includes[13].

embedModifier

Enfin, embed combine les deux précédentes fonctions :

    {% embed "footer.html.twig" %}
        ...
    {% endembed %}

importModifier

import récupère certaines fonctions d'un fichier en contenant plusieurs :

    {% from 'mes_macros.html' import format_price as price, format_date %}

MacrosModifier

Les macros sont des fonctions globales, appelables depuis un fichier Twig[14].

Exemple :

{% macro format_price(price, currency = '€') %}
    {% set locale = (app.request is null) ? 'fr_FR' : app.request.locale %}
    {% if locale == 'fr_FR' %}
        {{ price|number_format(2, ',', ' ') }}&nbsp;{{ currency }}
    {% else %}
        {{ price|number_format(2, '.', ' ') }}{{ currency }}
    {% endif %}
{% endmacro %}
  Lors de l'appel, les paramètres nommés ne fonctionnent que si 100 % des paramètres appelés le sont.


ExemplesModifier

{% extends "base.html.twig" %}
{% block navigation %}
    <ul id="navigation">
    {% for item in navigation %}
        <li>
            <a href="{{ item.href }}">
                {% if item.level == 2 %}&nbsp;&nbsp;{% endif %}
                {{ item.caption|upper }}
            </a>
        </li>
    {% endfor %}
    </ul>
{% endblock navigation %}

Pour ne pas qu'un bloc hérité écrase son parent, mais l'incrémente plutôt, utiliser :

{{ parent() }}

Bonnes pratiquesModifier

Les noms des fichiers .twig doivent être rédigés en snake_case[15].

RéférencesModifier