Formate als Elementschreibweise

Einleitung

Formate im eCMS sind Micro-Templates für Ihr Website Frontend. Fast alle Formate im eCMS können auch mit der eCMS-Elementschreibweise eingebunden werden. Dadurch erhalten Sie die Möglichkeit Formate beispielsweise innerhalb von Fließtexten zu nutzen.

Zum grundlegenden Verständnis, was Formate sind, empfehlen wir zuerst den Artikel Formate - die Grundlagen zu lesen.

Wie Sie die eCMS-Elementschreibweise nutzen können, erfahren Sie in diesem Artikel.

Syntax

Die eCMS-Elementschreibweise ist die Formateinbindung mit einem bestimmten Syntax. Dabei wird das Formatlabel eingerahmt von ${ und }$. Innerhalb dieser Zeichen können auch Parameter , in ( ) gesetzt, eingebettet und an das Format übergeben werden.

Der Syntax zusammengefügt:

${<format_label>(<Parameter>)}$

Das Formatlabel ist der Dateiname des Formates ohne die Endungen .class.php oder .inc.php.

Beispiel

Heißt Ihr Format beispielsweise:

mein_erstes_format.class.php

so ist die korrekte Elementschreibweise:

${mein_erstes_format}$

Unterstützt das Format zum Beispiel den Parameter parameter1 und wollen Sie diesem Parameter den Wert 25 übergeben, so können Sie dies wie folgt tun:

${mein_erstes_format(parameter1=25)}$

Sie haben einen weiteren Parameter parameter2 und dieser soll den Wert test erhalten, so können Sie den zweiten Parameter mit dem Pipe-Zeichen | vom ersten Parameter trennen. Die korrekte Schreibweise wäre dann:

${mein_erstes_format(parameter1=25|parameter2=test)}$

Wo kann ich die Elementschreibweise nutzen?

Wo Sie die Elementschreibweise nutzen können und ein paar häufig genutzte Formate in Elementschreibweise finden Sie unter eCMS Formate - Elemente Cheat-Sheet.

Einschränkungen der Elementschreibweise

Schachtelung

Bei der Nutzung der Elementschreibweise ist es nicht möglich diese zu schachteln. Unzulässig ist somit ein Konstrukt wie beispielsweise:

${mein_erstes_format(parameter=${mein_zweites_format}$)}$

Benötigte Datenabfrage

Eine weitere Einschränkung kann es geben, wenn das Format zur Ausgabe Daten aus einer Datenabfrage benötigt und diese aber nicht innerhalb des Formates abgefragt wird. Dies kann vorkommen, wenn der Formateprogrammierer explizit nur die Verwendung in einer Platzhalterkonfiguration mit Datenabfrage erlauben möchte.

Formulare in Fließtexten selbst zusammenstellen

Im Prinzip lassen sich Formulare mit Hilfe der Elementschreibweise zusammensetzen (z.B. durch eCMS-FORM, eCMS-INPUT-TEXT, ect.). Hierbei wird aber keine Formularverarbeitungslogik vermittelt, so dass damit erstellt Formulare unter Umständen nicht oder nicht richtig funktionieren werden.

Wir empfehlen daher, Formulare nur innerhalb von Formaten zu programmieren. Dort wiederum könnten die Elementschreibweisen eingesetzt werden, was aber aus Performance-Gründen ebenfalls nicht empfohlen wird (vgl. auch den nachfolgenden Punkt "Performance der Elementschreibweise")

Performance der Elementschreibweise

Um die Elementschreibweise im eCMS korrekt aufzulösen werden reguläre Ausdrücke (RegExpressions) verwendet. Dies ist naturgemäß immer langsamer als wenn die Formate z.B. über Platzhalterkonfigurationen direkt aufgerufen werden.

Wir empfehlen daher, die Elementschreibweise mit Bedacht einzusetzen und wenn möglich Formate direkt als Platzhalterkonfigurationen in eCMS Seiten zu integrieren. Formateprogrammierern empfehlen wir außerdem innerhalb von Formaten möglichst auf Elementschreibweisen zu verzichten und stattdessen die zahlreichen zur Verfügung stehenden Datenabfragen zu nutzen.