Cache-Block #

Diese Seite ist für Designer, die teure Teile eines Templates billig machen. Ein {cache-block} speichert die Ausgabe seines Inhalts und verwendet sie wieder, bis sich seine Schlüssel ändern oder er abläuft. Implementierung: lib/eztemplate/classes/eztemplatecachefunction.php und eztemplatecacheblock.php.

Inhalt #

1. Syntax und Parameter
2. Schlüssel
3. Ablauf
4. Sichere Muster
5. Fehler
6. Einstellungen und Leeren

Syntax und Parameter #

{cache-block keys=array( $module_result.uri, $current_user.role_id_list|implode( ',' ) ) expiry=3600}
    ...
{/cache-block}

Ohne keys ist die Position des Blocks im Template der einzige Schlüssel: eine Kopie für jede Seite und jeden Besucher.

Schlüssel #

Jeder Wert, der die Ausgabe ändert, muss in den Schlüsseln stehen:

subtree_expiry schließt auch ignore_content_expiry ein: Ein solcher Block läuft nur bei Veröffentlichungen unterhalb seines Knotens ab. Das Design simple verschlüsselt seinen ganzen Rahmen nach URI, Warenkorbzustand und Benutzer-ID; das Pagelayout der Administration baut einen Benutzer-Hash aus Rollen- und Einschränkungslisten.

Ablauf #

• Standard: zwei Stunden und bei jeder Veröffentlichung von Inhalten.
• Eine Fußzeile, die sich nie mit Inhalten ändert: ignore_content_expiry und ein langes expiry.
• Ein Menü einer Sektion: subtree_expiry mit dem Wurzelknoten der Sektion, sodass Veröffentlichungen anderswo ihn behalten.

Sichere Muster #

{* a top menu: same for everyone with the same roles on the same page *}
{cache-block keys=array( $module_result.uri, $current_user.role_id_list|implode( ',' ) ) subtree_expiry=2}
    {include uri='design:pagelayout/menu.tpl'}
{/cache-block}

{* a footer: same everywhere, changes rarely *}
{cache-block ignore_content_expiry expiry=86400}
    {include uri='design:pagelayout/footer.tpl'}
{/cache-block}

Fehler #

• Benutzerdaten ohne den Benutzer in den Schlüsseln: Der Name eines Besuchers wird anderen gezeigt.
• csp_nonce() innerhalb eines Blocks: Die gespeicherte Nonce ist bei jeder späteren Anfrage falsch, und das Skript wird blockiert.
• Ein Fetch innerhalb des Blocks, dessen Ergebnis außerhalb verwendet wird: Bei einem Cache-Treffer läuft der Fetch nicht.
• Schlüssel mit vielen verschiedenen Werten (vollständige Query-Strings, Zeitstempel): eine Datei pro Wert und keine Wiederverwendung. Wandeln oder reduzieren Sie sie (das Pagelayout der Administration wandelt seinen Sektionsfilter deshalb in eine Zahl um).
• Verschachtelte Cache-Blöcke: funktionieren, machen das Ungültigwerden aber schwer nachvollziehbar; vermeiden Sie sie.

Einstellungen und Leeren #

• site.ini [TemplateSettings] TemplateCache=enabled schaltet Cache-Blöcke ein (disabled: nie verwendet).
• DelayedCacheBlockCleanup (Standard disabled) lässt abgelaufene Teilbaum-Blöcke auf der Platte, damit ein Cronjob sie entfernt.
• Leeren: php bin/php/ezcache.php --clear-id=template-block.

Verwandte Seiten #

• Caching für Designer
• Run-once
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.