Benutzer-Werkzeuge

Webseiten-Werkzeuge


php:twig

TWIG (Template-Engine)

TWIG ist eine Template-Engine für PHP mit einer einfach zu erlernenden Syntax.

Um den Vorteil für den Einsatz von TWIG zu verstehen verfolgen wir am Besten bei der Umsetzung eines Projektes den folgenden Gedanken: Es soll die Möglichkeit bestehen, dass Ihr Projekt eines Tages von mehreren Entwicklern, evtl. sogar mit mehreren Teams, weiterentwickelt werden soll. Dafür ist es sinnvoll, die reine Programmierung (in unserem Falle mit der Programmiersprache PHP) von der optischen Gestalltung (Auszeichnungssprache HTML mit CSS) strikt zu trennen. So kann später ein Webdesigner selbständig das Layout ändern ohne über Programmierkentnisse zu verfügen. Und andersherum kann ein Programmierer Änderungen an der Logik vornehmen, ohne sich Gedanken über das Layout machen zu müssen.

Da in TWIG-Vorlagen kein PHP verwendet werden kann (das ist schon wegen der abweichenden Dateiendung „.twig“ nicht möglich) können hier lediglich mit TWIG-Platzhaltern und -Funktionen verwendet werden. Die Platzhalter, die Variablen, Arrays und Objekte sein können, werden zuvor mit PHP im Controller vorbereitet und an die TWIG-Vorlage übergeben. So ist die Programmierung sauber vom Layout getrennt.

Die Syntax ist in der offiziellen TWIG-Dokumentation in den folgenden 4 Bereichen aufgeteilt:

  • Tags (z. B. Bedingugen oder Schleifen)
  • Filters (z. B. nur den ersten oder letzten Eintrag anzeigen)
  • Functions (z. B. Zufallswert, kleinster Wert oder größter Wert)
  • Tests (z. B. prüfen, ob Wert leer oder gerade oder ungerade ist)

Installation in PhpStorm

Menüpunkt „Composer“ –> „Add dependency…“ –> „twig/twig“ –> „install“ auswählen


Installation ohne PhpStorm

Die Installation von TWIG ist durch den Abhängigkeits-Manager für PHP Composer möglich:

composer require twig/twig

Templates in andere Templates einbinden

Es empfiehlt sich, als erstes einen Basis-Template anzulegen, welches in den anderen Seiten eingebunden wird:

{% extends 'base.twig' %}

Anders herum ist es natürlich auch möglich, Templates in andere Templates zu inkludieren:

{% include 'footer.twig' %}

Syntax

Variable definieren und Wert zuweisen:

{% set variable = 'wert' %}

Der Inhalt einer Variable wird in doppelt geschweiften Klammern ausgegeben:

{{ variable }}

Tags werden in TWIG immer in einfachen geschweiften Klammern, gefolgt von einem Prozentzeichen, geschrieben:

{% tag [ | filter ] %}
	{# HTML #}
{% endtag %}

Bedingungen werden immer in einfachen geschweiften Klammern, gefolgt von einem Prozentzeichen, aufgerufen:

{% if var == a %}...{% endif %}

Funktionen werden immer in einfachen geschweiften Klammern, gefolgt von einem Prozentzeichen, aufgerufen:

{% funktion( parameter ) %}

Twig-Beispiel

Das Twig-Beispiel zeigt die sinnvolle Aufteilung von den folgenden Komponenten einer Webseite auf:

  • Konfiguration
  • Page-Controller
  • Mastertemplate
  • Twig-View

Hier geht's zum Beispiel

Kurzreferenz

Kurzbeschreibung Beispiel
Abfragen, ob eine Variable leer ist
 {% if Statusmeldung %}...{% endif %} 
Bedingungen
 {% if ergebnis == true %}..{% else %}..[% endif %}
Inhalt einer Variable ausgeben
{{ Statusmeldung }} 
Durch ein Objekt oder Array iterieren
{% for entry in data %}...{% endfor %}
Inhalt eines Array-Elements oder einer Objekt-Variable in einer Schleife ausgeben
{{ entry.email }} 
For-Next-Schleife erstellen
{% for i in 0..10 %}<p>{{ i }}</p>{% endfor %}
For-Next-Schleife mit variabler Anzahl von Durchläufen
{% for f in range( 1, config.faecher ) %} {{ f }} {% endfor %}
Methode einer Klasse aufrufen
{{ user.checkEmail( email ) }}
php/twig.txt · Zuletzt geändert: 2021/03/14 12:01 von webproducer