Smarty

Smarty
Entwickler	Monte Ohrt, Messju Mohr
Aktuelle Version	3.1.4 (19. Oktober 2011)
Betriebssystem	plattformunabhängig
Programmier­sprache	PHP
Lizenz	LGPL (Freie Software)
Deutschsprachig	ja
www.smarty.net

Smarty ist eine freie (unter LGPL) Template Engine, die als PHP-Bibliothek vorliegt. Sie wurde mit dem Ziel entworfen, bei der Entwicklung von Webapplikationen die Trennung von Code und Ausgabe zu ermöglichen. Die Ausgabe erfolgt meist in HTML, möglich ist jedes textbasierte Dateiformat, zum Beispiel auch XML.

Geschichte

Mit der Intention, eine Art „Basic-PHP“ für Designer zu erschaffen, erstellten die Entwickler Monte Orth und Andrei Zmievski gegen Ende des Jahres 1999 die Spezifikation für eine Template-Engine, welche anschließend in der Hoffnung, dass sie Eingang in PHP finden würde, in C programmiert wurde.

Nachdem jedoch verschiedene technische Schwierigkeiten und eine hitzige Diskussion über die Frage, was eine Template-Engine können sollte und was nicht, eine Implementierung von Smarty in PHP verhinderten, entschlossen sich die Programmierer, das Template-System als eine Klasse für PHP zu veröffentlichen und dessen Funktionalität auf diesem Weg zur Verfügung zu stellen. Es entstand die Klasse SmartTemplate, bei der zum Parsen reguläre Ausdrücke verwendet wurden. Diese wurde jedoch nie veröffentlicht.

Da der Inhalt einer Seite jedoch bei jedem Aufruf geparst wurde, entstand ein großer Overhead. Um diesen Effekt zu vermindern, wurde Smarty mit der Erstveröffentlichung am 18. Januar 2001 um eine Vorkompilierung der Dateien (Caching) ergänzt.

Was ist Smarty?

Der Hersteller bezeichnet Smarty als „Template/Presentation Framework“. Es soll umfangreiche Hilfsmittel zum Lösen vieler Probleme im Umfeld der „Präsentation“ (XHTML-Ausgabe) von Web-Applikation zur Verfügung stellen. Ursprünglich entworfen wurde es jedoch als reine Template Engine, also ein System, das innerhalb von Texten (Text-Dateien) bestimmte Platzhalter durch dynamische Inhalte ersetzt.

Die Entwickler von Smarty gehen im Grundsatz davon aus, dass das reine Layout einer Webapplikation von einem „Template-Designer“ entworfen und in HTML (als Template) umgesetzt wird, während die eigentlichen Prozesse und Datenverarbeitungsroutinen von einem Programmierer in PHP entwickelt werden. Es erscheint deshalb logisch, diese beiden Komponenten bereits im Entwicklungsprozess zu trennen.

Zu diesem Zweck wird die Entwicklung aufgeteilt in PHP-Dateien, die Verarbeitungsprozesse ausführen, und in Templates, die als eigene Dateien in einem eigenen Format vorliegen. Bei diesen Template-Dateien handelt es sich im Wesentlichen um HTML-Dateien mit mehr- oder weniger komplexen Platzhaltern, die später durch dynamische Inhalte ersetzt werden.

Vom Hersteller werden folgende Vorteile durch diese Art der Trennung genannt:

• die Designer können im Programmcode keine Fehler oder Sicherheitsprobleme verursachen, da sie mit dem Programmcode nicht in Berührung kommen. Fehler innerhalb der Smarty-Syntax werden von Smarty abgefangen.
• die Designer können das Layout verändern, ohne einen Programmierer dafür zu benötigen.
• die Programmierer müssen sich nicht um die Präsentation ihrer Daten kümmern.
• die Templates sind sehr nahe an der tatsächlichen Ausgabe, das heißt sie enthalten in vielen Fällen bereits große Teile der letztendlichen XHTML-Seite.

Um in den Templates eine gewisse Steuerbarkeit zu ermöglichen, erkennt Smarty neben den Templatevariablen einige einfache Steuerbefehle, die stark an die PHP-Syntax angelehnt wurden und die Formulierung von Bedingungen (if) oder Schleifen (foreach) erlauben.

Smarty wurde für den professionellen Einsatz optimiert und enthält eine Art Compiler, der die Ausgabe der Smarty-Templates vorbereitet und in einem Cache speichert. Dadurch wird die Ausgabe stark beschleunigt.

Als quelloffene Programmbibliothek kann Smarty beliebig erweitert und angepasst werden.

Leistung

Technische Leistung

Smarty verarbeitet die Daten und Templates in zwei Schritten, was die Verarbeitung stark beschleunigt:

• Zunächst wird aus PHP- und XHTML-Code automatisch und für den Programmierer transparent eine neue PHP-Datei generiert, die sowohl XHTML als auch PHP enthält – also das, was ein Programmierer ohne Templates sonst selbst machen würde. Nur dann, wenn sich eine PHP-Datei ändert, wird die temporäre PHP-Datei aktualisiert. Dadurch muss das Template nicht bei jedem Seitenaufruf neu geparst werden.
• Bei Bedarf kann Smarty die endgültige XHTML-Ausgabe zwischenspeichern (englisch cachen). Das bedeutet, dass der Webserver praktisch bei einem Zugriff eine statische XHTML-Seite liefert, was besonders bei Datenbankzugriffen in PHP eine massive Entlastung des Servers und der Datenbank zur Folge hat. Der Programmierer muss nur darauf achten, dass nach einer Aktualisierung der Datenbank der Cache gelöscht wird. Da Datenbanken in vielen Fällen sehr viel öfter abgefragt als verändert werden, ist dies als besonderer Vorteil zu betrachten.

Aus dem ersten Punkt ergibt sich jedoch, dass eine Smarty-basierte Ausgabe niemals schneller sein kann als eine reine PHP-Ausgabe, selbst im optimalen Fall (ohne Schleifen und im Cache-Modus).

Entwicklungsgeschwindigkeit

Die Entwicklungsgeschwindigkeit von Projekten, die Smarty (oder allgemein Templatesysteme) verwenden, kann deutlich über der reiner PHP-Lösungen liegen. Dies ist insbesondere dann der Fall, wenn sich Programmierer und Designer bei großen Projekten in die Quere kommen, was Bearbeitungsengpässe zur Folge haben kann. Dann ermöglicht eine saubere Trennung von Code und Templates eine Arbeitsteilung, die sich in der Regel produktivitätssteigernd auf das Gesamtprojekt auswirkt.

Ob mit Smarty gegenüber anerkannten Entwicklungsmethoden zur Modularisierung von Software bessere Ergebnisse erzielt werden können, erscheint fraglich. Durch die zusätzliche Einarbeitungszeit in die Smarty-eigene Sprachsyntax kann die Entwicklungsgeschwindigkeit gegenüber anderen Lösungen sogar sinken.

Smarty in der Praxis

Smarty lässt sich in PHP sehr einfach einbinden:

<?php
require_once('/smarty/libs/Smarty.class.php');
$my_smarty = new Smarty();
$my_smarty->security        = true;
$my_smarty->secure_dir      = '/templates';
$my_smarty->compile_dir     = '/smarty_cache';
$my_smarty->left_delimiter  = '{..';
$my_smarty->right_delimiter = '..}';
$my_smarty->debugging       = false;
?>

Nachdem ein Objekt angelegt wurde, müssen die Verzeichnisse für die Templates und den Cache angegeben werden. Der Code, der an die Templates übergeben werden soll, muss zuvor registriert werden:

<?php
$my_smarty->assign('name', $name);
$my_smarty->assign('first_name', $first_name);
?>

Die Smarty-Templates selbst sind einfache XHTML-Dateien, die an den gewünschten Stellen die Smarty-Variablen und ggfs. Smarty-Steuerungscode (insbesondere Schleifenlogik) enthalten können.

Das folgende Beispiel demonstriert ein Smarty-Template ohne Steuerungslogik. Die Standardbegrenzer für Smarty sind { und }. Es hat sich jedoch in der Praxis als empfehlenswert herausgestellt, andere Begrenzer zu verwenden (siehe erstes PHP-Beispiel), da die geschweiften Klammern mit evtl. eingebettetem JavaScript kollidieren könnten.

Name: {.. $name ..}
Vorname: {.. $first_name ..}

Dieses Problem lässt sich jedoch umgehen, indem das JavaScript mit {literal}-Tags maskiert wird.

Vorteile einer eigenen Template-Syntax

• Einfachere Handhabung für Bearbeiter von Templates, da die Syntax für die Ausgabe optimiert ist
• Weniger erfahrene beziehungsweise vertrauenswürdige Personen können mit der Gestaltung des Layouts betraut werden, ohne die Sicherheit des Systems zu gefährden (etwa in Online-Communities), solange kein nativer PHP-Code in die Templates eingebunden werden kann. Aus Sicherheitsgründen kann (und sollte) dies in Smarty durch eine entsprechende Einstellung unterbunden werden

Nachteile und Kritik

PHP wurde bereits selbst als „Template-Engine“ entworfen: Es ist ohne erweiternde Softwarebibliotheken möglich, Textausgabe mit Variablen ("Platzhaltern") effizient und übersichtlich durchzuführen. Die Einführung einer eigenen Sprachsyntax wie bei Smarty ist deshalb nicht zwingend notwendig.

Nachteile der Syntax sind:

• Erhöhte Einarbeitungszeit (Lernkurve) für den Entwickler
• Verringerte Performance gegenüber einer PHP-nativen Ausgabe
• Allein durch die neue Sprachsyntax wird noch kein MVC-Prinzip umgesetzt, dafür ist zusätzlicher Aufwand erforderlich.
• Eine Webseite kann trotz Smarty-Einbindung fehlerhaft ausgegeben werden
• IDE-eigene Syntaxhervorhebungen greifen bei der Smarty-Syntax nicht - hier müssten Erweiterungen installiert werden
• Smarty bietet keine Möglichkeit, eine Ausgabe rekursiv zu veranlassen^[1]

Anwendungsbeispiele

Folgende Projekte nutzen Smarty:

• Zikula (PHP Framework)
• bBlog (Blog)
• Bigace (CMS)
• CMS Made Simple (CMS)
• Serendipity
• CpVES
• SugarCRM
• Bitweaver
• Oxid Shop
• PrestaShop
• Shopware
• WoltLab Burning Board

Literatur

• Joao Prado Maia, Hasin Hayder, Lucian Gheorghe: Smarty PHP Template Programming and Applications. Packt Publishing, April 2006, ISBN 1-904-81140-X (englisch)
• Thomas Frietsch: Realisierung einer PHP-Anwendung mit der Template-Engine Smarty. GRIN Verlag, März 2010, ISBN 3-640-57035-9 (deutsch)

Weblinks

• Offizielle Webpräsenz
• Einführung in PHP-Templatesysteme mit der Engine Smarty
• Schnelle Einführung in die Smarty Engine
• Überblick – Software, die Smarty verwendet
• Überblick – Open-Source-Projekte und Webseiten

Einzelnachweise

1. ↑ Kritik an Template-Engines in PHP