Die Template-Sprache #

Exponential rendert jede Seite, jede Mail und jedes PDF mit seiner eigenen Template-Sprache, bekannt als eZ TPL oder ezpl: Tags in geschweiften Klammern wie bei Smarty, aber mit Operatoren und Funktionen für Inhaltsobjekte, einer Fetch-API zum Lesen von Daten, einem Override-System zur Wahl von Templates und einem Compiler, der Templates in PHP umwandelt. Dieser Abschnitt dokumentiert die Sprache selbst, aus dem Code in lib/eztemplate/ und dem Kernel, auf 29 Seiten.

Jedes Beispiel auf diesen Seiten wurde auf einer Entwicklungsinstallation gerendert, der eigenen Installation des Projekts, gegen ihre echten Inhalte (die Website Fit & Healthy), mit der Ausgabe darunter, genau wie die Template-Engine sie erzeugt hat; die Beispiele wurden außerdem in einen Arbeitsordner kompiliert und verglichen. Wo eine Seite Code zeigt, der nicht ausgeführt wurde, sagt sie das und warum.

Für eine sanftere, aufgabenorientierte Einführung beginnen Sie mit dem Überblick über Templates für Designer und den Grundlagen der TPL-Syntax. Jeder Operator ist in Template-Operatoren dokumentiert.

Die Sprache #

• Was die Template-Sprache ist: Die Template-Sprache von Exponential (eZ TPL, ezpl) auf einer Seite - eine Smarty-ähnliche Sprache für Dateien .tpl, wo sie genutzt wird (Designs, Modulansichten, Mail, PDF), die Teile der Engine in lib/eztemplate und was sie von Haus aus über Smarty hinaus kann.
• Geschichte der Template-Sprache: Wie die Template-Sprache gewachsen ist, nur aus dem erzählt, was das Repository festhält - die Git-Geschichte ab 2002, die Changelogs ab 2.9, der Compiler von 2003, die Syntax mit def/if/foreach von 2005 (Version 3.6), die let und section ersetzte, und was vom älteren Stil noch übrig ist.
• Smarty und die Template-Sprache nebeneinander: Eine Tabelle, die die Syntax von Smarty und die Template-Sprache von Exponential nebeneinanderstellt - Ausgabe, Modifikatoren und Operatoren, Zuweisung, Standardwerte, Bedingungen, Schleifen, Wechsel, include, literal, Begrenzer, Kommentare, capture, Maskierung, Daten, Caching und Vererbung - mit jedem Beispiel der Template-Sprache auf einer Entwicklungsinstallation gerendert.
• Templates nebeneinander - Exponential-Templates, Twig und Smarty: Ein Spickzettel, der dasselbe Template in die drei Engines stellt, die Exponential rendert - Ausgabe, Attribute, Variablen, Schleifen, Bedingungen, Cache-Blöcke, fetch, Übersetzungen, URLs, Includes, Sections, Sequenzen und Maskierung, jede Zeile von den Konvertern des Kernels umgewandelt und mit gleicher Ausgabe gerendert - dazu, wie jeder Operator und jede Template-Funktion in Twig geschrieben wird.
• Smarty und die Template-Sprache: die Unterschiede im Detail: Die Unterschiede, über die Smarty-Benutzer stolpern, jeder auf einer Entwicklungsinstallation gezeigt - keine Arithmetik oder Vergleiche in Infixschreibweise, kein PHP in Templates, keine automatische Maskierung, unbekannte Operatoren, die ihre Eingabe durchreichen, strenges def und set, Klammern in CSS und JavaScript, Operatoren als registrierte PHP-Klassen, fetch und Objekte, Overrides statt Vererbung, Namensräume und Leerraum.
• Ein Template von Smarty umziehen: Eine Anleitung zum Portieren - ein typisches Listen-Template aus Smarty in drei Schritten in die Template-Sprache übertragen (Variablen, Daten aus fetch, die Schleife mit Bedingungen, Links, Daten und Maskierung), jeder Schritt auf einer Entwicklungsinstallation gerendert, plus eine Checkliste der vorzunehmenden Ersetzungen.
• Von Exponential-Templates (.tpl) zu Twig-Templates (.twig) umziehen: Exponential rendert Twig-3-Templates (.twig, .html.twig) selbst, neben .tpl und .stpl - wann Sie .twig wählen, was sich ändert und was bleibt, eine Tabelle nebeneinander, der Konverter in beide Richtungen mit echter Ausgabe, und die Prüfung des Ergebnisses.
• Templates zwischen Template-Engines umwandeln: der Befehlsraum exp:template:convert in jede Richtung zwischen .tpl, .stpl und .twig - die sechs benannten Befehle, der allgemeine Befehl und der Diff, die Markierung, NOTE-Zeilen, Exit-Codes, Override-Regeln und ein Beispiel durch alle drei Engines.
• Von Exponential-Templates (.tpl) zu Exponential-Smarty-Templates (.stpl) umziehen: Exponential rendert Smarty-5-Templates (.stpl) selbst, neben .tpl - wann Sie welche Sprache wählen, was sich ändert und was bleibt, die Konvertierungsbefehle in beide Richtungen (exp:template:convert:tpl-to-stpl und exp:template:convert:stpl-to-tpl) mit jeder Option, die Markierung, NOTE-Zeilen und Exit-Codes, Beispiele, Hin- und Rückweg und eine Tabelle nebeneinander.
• Lexikalische Struktur: Wie der Parser ein Template liest - die Begrenzer, die Arten von Tags (Ausgabe-Tags, Funktions-Tags, End-Tags, Einzel-Tags), Kommentare, literal-Blöcke, ldelim und rdelim, eine Klammer in einem Tag maskieren, die Regel, die einen Zeilenumbruch um jedes Funktions-Tag entfernt, und wie Parserfehler Zeile und Spalte melden.
• Werte und Literale: Die Werte, die ein Template hinschreiben kann - Zeichenketten in einfachen oder doppelten Anführungszeichen (keine Interpolation von Variablen, die Escapes, die der Parser kennt), ganze Zahlen und Gleitkommazahlen, true() und false(), mit array() und hash() gebaute Arrays und Hashes, bloße Bezeichner und was für null steht - jedes auf einer Entwicklungsinstallation mit get_type gezeigt.
• Variablen im Detail: Die genauen Regeln von def, undef, set, let und default aus eZTemplateDefFunction und eZTemplateSetFunction - die Warnungen bei doppelter Definition, beim Setzen einer unbekannten Variablen und beim Aufheben einer, die def nicht angelegt hat, undef ohne Argumente, die Lebensdauer einer Variablen (die Datei, der let-Block) und set mit scope=relative, root oder global über ein include hinweg.
• Namensräume: Wie die Template-Engine Variablen auseinanderhält - der Wurzel- und der aktuelle Namensraum, die vier Arten, eine Variable zu benennen ($var, $ns:var, $:var, $#var), was include mit und ohne name= tut, die Namensräume, die section und let anlegen, und der Fehler bei einer Variablen im falschen Namensraum.
• Zugriff auf Attribute: Wie $a.b und $a[b] aufgelöst werden - Arrays nach Schlüssel, Objekte über attributes(), hasAttribute() und attribute(), Felder und Funktionsattribute von eZPersistentObject, dynamische Schlüssel, numerische Indizes, Attribute nach einem Operator, der Fehler mit seiner Liste von Wahlmöglichkeiten und die Operatoren attribute und dump, um in einen Wert hineinzusehen - gezeigt an Knoten 90 einer Entwicklungsinstallation.
• Operatoren in Ausdrücken: Wie Operatoren geschrieben und ausgewertet werden - die Pipe-Form und die Aufruf-Form, was der Eingabewert in jeder ist, Verkettung, Operatoren als Parameter verschachteln, Attribute nach einem Operator, Operatoren in Parametern von Funktionen, wie Parameter benannten Parametern mit Standardwerten zugeordnet werden und was bei einem unbekannten Operator oder einem fehlenden Parameter geschieht.
• Funktionen und Operatoren: Die zwei Arten benannter Dinge in der Template-Sprache verglichen - Template-Funktionen sind Tags, die Ausgabe schreiben und das Template steuern, Operatoren berechnen Werte - mit ihren Arrays zur Registrierung, den Methoden, die jede PHP-Klasse umsetzt, Block-Funktionen und Kindern, interpretierter Verarbeitung gegenüber kompilierter Transformation und wann Sie welches schreiben.
• Referenz der Kontrollstrukturen: Jeder Parameter von if, elseif und else, switch und case (match, in, key und der Standardfall), foreach (key, sequence, offset, max, reverse), for, while und do und die Schleifenhelfer delimiter (mit modulo), break, continue und skip - mit ihrem genauen Verhalten aus dem Code, jeder auf einer Entwicklungsinstallation gezeigt.
• Sections und foreach: Die Funktion section vollständig - Schleifen über Arrays, Zahlen und Zeichenketten, name und der Namensraum, den sie anlegt, var und der Iterator mit last-value, sequence, offset, max, reverse, show mit section-else, die Filter section-exclude und section-include und delimiter mit modulo - jede neben ihrer Entsprechung mit foreach, for oder if, alles auf einer Entwicklungsinstallation gerendert, plus der eine gefundene Unterschied im kompilierten Modus.

Das Objektmodell in Templates #

• Das Objektmodell in Templates: Wie ein Template die PHP-Objekte des Inhaltsmodells sieht - Knoten, Inhaltsobjekt, Version, Data Map, Inhaltsobjekt-Attribut und der Inhalt seines Datentyps - und das Attributprotokoll (attributes, hasAttribute, attribute), das die Engine für jeden Punkt in einem Variablenpfad nutzt, an echten Inhalten belegt.
• Referenz der Knotenattribute: Jedes Attribut, das ein Template von einem Knoten (eZContentObjectTreeNode) lesen kann - die 16 Datenbankfelder und die 35 Funktionsattribute seiner Definition, die PHP-Methode hinter jedem und der Wert, den jedes für einen echten Artikel auf einer Entwicklungsinstallation zurückgab.
• Referenz der Attribute von Inhaltsobjekten: Jedes Attribut, das ein Template von einem Inhaltsobjekt (eZContentObject) lesen kann - die 12 Datenbankfelder und die 65 Funktionsattribute seiner Definition, die PHP-Methode hinter jedem und der Wert, den jedes für einen echten Artikel auf einer Entwicklungsinstallation zurückgab.
• Referenz von Inhaltsattribut und Version: Jedes Attribut, das ein Template von einem Inhaltsobjekt-Attribut (eZContentObjectAttribute, die Einträge von data_map) und von einer Version (eZContentObjectVersion) lesen kann, mit der PHP-Methode hinter jedem, Werten einer Entwicklungsinstallation und dem, was .content für jeden Datentyp in den Inhalten einer Entwicklungsinstallation zurückgibt.
• Data Map und Inhalt: Die Felder eines Inhaltsobjekts in Templates lesen - data_map, has_content, content, die rohen data_text und data_int und attribute_view_gui - Feld für Feld an einem echten Artikel auf einer Entwicklungsinstallation belegt (ezstring, ezxmltext, ezimage, ezobjectrelationlist, eztags, Daten).

Templates von Modulansichten #

• Templates von Modulansichten: Wie eine Modulansicht ihre Templates rendert - die PHP-Seite (eZTemplate::factory(), setVariable(), fetch( 'design:...' )), das Array $Result, das eine Ansicht zurückgibt, und wie der Kernel es dem Pagelayout als $module_result zusammen mit den anderen Variablen des Pagelayouts übergibt - belegt durch nur lesendes Ausführen von content/view auf einer Entwicklungsinstallation.
• Referenz des Modulergebnisses: Jeder im Kernel gefundene Schlüssel von $Result / $module_result - content, path, title_path, content_info und seine 25 Schlüssel, view_parameters, pagelayout, navigation_part, left_menu, errorType und der Rest - mit dem Code, der jeden setzt, und den Werten, die content/view auf einer Entwicklungsinstallation zurückgab.
• Ansichtsparameter: Der Teil /(name)/value einer URL - wie eZURI ihn zerlegt, wie eZModule::run() ihn den ungeordneten Parametern und UserParameters einer Ansicht zuordnet, was content/view daraus macht ($view_parameters, eine Variable pro Name, content_info.offset) und wie er den Schlüssel des Content-View-Cache ändert - auf einer Entwicklungsinstallation belegt.
• Die persistente Variable, von innen: Wie $persistent_variable von einem Template einer Knotenansicht zum Pagelayout gelangt - der Kernel setzt sie auf false, liest sie nach dem Rendern aus dem Wurzel-Namensraum zurück, speichert sie in content_info und im Content-View-Cache und macht sie zu einem Override-Schlüssel - und warum scope='global' zählt, mit Namensräumen auf einer Entwicklungsinstallation belegt.

Compiler, Caches und Ressourcen #

• Der Template-Compiler: Wie eZTemplateCompiler ein gelesenes Template in PHP umwandelt - die Pipeline (Transformation der Knoten, statische Optimierungen, Zusammenfassen, Erzeugen von PHP), Name und Ordner der kompilierten Datei, die Hinweise von Operatoren und Funktionen, mit denen ein Operator zu Inline-PHP wird, der Rückfall processOperator, DevelopmentMode, die Einstellungen - mit erzeugtem Code einer Entwicklungsinstallation und einem echten Unterschied zwischen kompilierter und interpretierter Ausgabe.
• Template-Caches: Jeder Cache, den ein Template berührt - kompilierte Templates, der Template-Block-Cache von cache-block (Schlüssel, expiry, subtree_expiry, ignore_content_expiry und wie der Name der Cache-Datei gebaut wird), der Content-View-Cache und sein Schlüssel, der Cache der Template-Overrides, die Caches für Design-Basen und INI - mit den IDs von ezcache, die jeden leeren, und dem, was exp:velocity deploy leert.
• Template-Ressourcen und Overrides: Wie aus einem Template-Namen eine Datei wird - die Ressourcen design: und file:, die geordneten Design-Basen eines Siteaccess (Website-Design, zusätzliche Designs, Standard-Design, jedes zuerst mit seinen Designs von Erweiterungen), Regeln in override.ini mit ihren Match-Schlüsseln und ihrer Reihenfolge und wie include und die Ansichtsfunktionen sie nutzen - mit der echten Auflösung auf dem Siteaccess site einer Entwicklungsinstallation.
• Fehler und Fehlersuche: Die Meldungen, die die Template-Engine protokolliert - unbekannte Variable, unbekanntes Attribut, unbekannter Operator oder unbekannte Funktion, Parserfehler mit Zeile und Spalte, ein fehlendes Template, Fehlgebrauch von def/set/undef - jede auf einer Entwicklungsinstallation erzeugt, was die Engine in jedem Fall ausgibt, die Leerraumregel, die alle überrascht, und die Debug-Einstellungen (Debug, ShowXHTMLCode, ShowUsedTemplates, ShowTemplatePathComments, ShowMethodDebug, DisplayWarnings).

Die Sprache erweitern #

• Eigene Template-Funktionen: Eine Template-Funktion (ein Tag in geschweiften Klammern mit benannten Parametern und wahlweise einem Rumpf) in einer Erweiterung schreiben - functionList, hasChildren, attributeList, process, Parameter auswerten, den Rumpf rendern, Registrierung in eztemplateautoload.php, Hinweise zur Kompilierzeit - und die Funktionen des Kernels erweitern oder überschreiben, mit einer Beispielfunktion auf einer Entwicklungsinstallation gerendert.

Verwandte Seiten #

• Template-Operatoren: jeder Operator, Fetch-Aliase, Fetch-Funktionen
• Templates für Designer
• Referenz der Funktionen
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.