Templates debuggen #

Teil 2, Kapitel 15. Probleme mit Templates fallen in drei Gruppen: Es wird das falsche Template verwendet, eine Variable ist nicht das, was Sie denken, oder das Template enthält einen Fehler. Dieses Kapitel gibt Ihnen für jede Gruppe das Werkzeug. Schalten Sie zuerst die Debug-Ausgabe ein (Debug-Ausgabe und Logs für Entwickler).

Welches Template wird verwendet? #

Nur für die Entwicklung: Die Kommentare landen in jeder Ausgabe, auch in Mails, JSON, XML und RSS. Lassen Sie sie im Produktivbetrieb nie eingeschaltet.

Greift ein Override nicht, zeigt Ihnen die Tabelle der verwendeten Templates, was der Kernel angefordert hat (Source) und was er ausgewählt hat; vergleichen Sie das mit Ihrem Block in override.ini (Template-Overrides: die Grundlagen).

Was steckt in dieser Variablen? #

{$node|attribute( 'show', 1 )}

gibt eine Tabelle der Attribute der Variablen aus, eine Ebene tief (2 für zwei Ebenen). Bei einem Knoten listet sie name, node_id, object, data_map, url_alias und den Rest auf; so finden Sie den Namen des Attributs, das Sie brauchen. Entfernen Sie die Zeile vor dem Commit: Sie ist nur für Ihre Augen bestimmt. Beachten Sie, dass sie jedes Attribut liest, auch die teuren.

Werte, die Sie nicht in der Seite haben möchten, schreiben Sie in die Debug-Ausgabe:

{debug-log var=$node.name msg='the node name'}
{debug-log msg='reached the teaser branch'}

Die Engine gibt im Debug-Bericht Debug: (the node name) gefolgt vom Wert aus.

Wie lange dauert es? #

{debug-timing-point id='menu'}
    ... the expensive part ...
{/debug-timing-point}

setzt einen Zeitmesspunkt um einen Teil des Templates; debug-accumulator summiert wiederholte Blöcke. Die Zeiten erscheinen in der Zeittabelle der Debug-Ausgabe. Kombinieren Sie das mit [DatabaseSettings] SQLOutput=enabled, um zu sehen, welcher Fetch langsam ist.

Die Meldungen der Engine #

Jede Meldung nennt die Template-Datei sowie Zeile und Spalte, zum Beispiel full.tpl:12[5].

Veraltete Ausgabe #

Wenn Ihre Änderung nicht erscheint:

1. Ist das Template aus einer alten Version kompiliert? Leeren Sie den Template-Cache: php bin/php/ezcache.php --clear-tag=template.
2. Liegt die Seite im View-Cache? Leeren Sie ihn: php bin/php/ezcache.php --clear-tag=content.
3. Ist es eine neue Datei? Leeren Sie den Template-Override-Cache: --clear-id=template-override.
4. Liegt der Teil in einem {cache-block}? Leeren Sie --clear-id=template-block.
5. Velocity hält einen Response-Cache: ./console exp:velocity cache clear --apply.

Während Sie arbeiten, erspart Ihnen TemplateCompile=disabled Schritt 1 ganz.

Ein Vorgehen für eine kaputte Seite #

1. Lesen Sie die Fehler in der Debug-Ausgabe; der erste ist meist die Ursache.
2. Finden Sie das Template mit den Pfadkommentaren.
3. Geben Sie die Variablen, auf die Sie sich verlassen, mit attribute( 'show' ) aus.
4. Kürzen Sie das Template, bis der Fehler verschwindet; das Letzte, was Sie entfernt haben, ist das Problem.
5. Nehmen Sie die Debug-Zeilen wieder heraus, leeren Sie die Caches und prüfen Sie erneut.

eZpedias „Learning: Template Debugging“ beschreibt dieselben Werkzeuge aus den früheren Jahren.

Verwandte Seiten #

• Zurück: Die Template-Operatoren, die Builder am häufigsten nutzen
• Weiter: Caching und Templates
• Template-Pfadkommentare
• Die Exp Debug-Leiste
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.