Handbuch für Template-Programmierer

camindo CMS liefert Inhalte mittels Templates aus, beispielsweise HTML auf einer Website. CMS-Befehle bereiten Inhalte auf und fügen diese dynamisch im Template ein. Beispiel für ein stark vereinfachtes Seitentemplate:

<html>
<body>
<h1>(CMS:TEXT title)</h1>
<div>(CMS:TEXT text)</div>
<div>(CMS:MEDIA field=bild_klein attr[id]=bild1)</div>
<div>erstellt: (CMS:DATE created_at format="dd.MM.y")</div>
</body>
</html>

CMS-Befehle dienen dabei nicht nur als Platzhalter. Sie stellen komplexe gekapselte Funktionalitäten dar, die mittels Parametern angepasst und miteinander kombiniert werden können. Das spart viel Entwicklungszeit. Zudem sind sie erprobt und gewährleisten Stabilität.

Beispiele dafür, was CMS-Befehle leisten:

• Inhalte bestimmter Kriterien aus der Datenbank ermitteln
• Inhalte aufbereiten
• Benutzereingaben prüfen, speichern oder versenden
• Registrierung von Websitebesuchern, An- und Abmeldung
• weitere Templates einbinden

Ausgabeformate: Neben Websites mit HTML-Seiten sind weitere Ausgabemedien und Publikationswege möglich. Inhalte können etwa als XML-Dateien, PDF-Dateien, E-Mails… formatiert werden und über eine URL zum Abruf bereitgestellt, als Dateien ins Dateisystem geschrieben oder über ein Netzwerk geschoben werden.

Template-Satz: Nicht jeder muss das Rad neu erfinden. Inhaltsbereiche (ihre Konfiguration inkl. Eingabefeldern, auf Wunsch mit Inhalten) und die zugehörigen Templates können im XML-Format exportiert werden. Beim Import in eine andere camindo-Installation bleiben die Beziehungen zwischen Bereichen und Templates bestehen. Der komplette Anwendungsteil ist sofort einsatzbereit. Das ermöglicht die einfache Integration fertiger Bausätze (Forum, Newsfeed, ...) oder auch den Export selbst entwickelter Anwendungen für die Wiederverwendung in späteren Projekten.

Inhalt

1. Grundlagen – wie eine Seite entsteht, Adressen, Syntax, Listen, Verknüpfungen, das Konzept „jeder Datensatz hat eine Seite“, Filter, Mehrsprachigkeit, Sicherheits-Header (CSS/JS/JSON ausliefern, Einbetten in Partnerwebsites), zeitgesteuerte Templates, Templates im Dateisystem
2. Template-Sätze – Funktionen kapseln, portabel halten, weitergeben und anpassen
3. Trigger-Templates – PHP-Methoden für die Ereignisse der Datensätze eines Bereichs (Speichern, Löschen …) und für die Aktionen der Lösch-Policies
4. Befehlsreferenz – eine Seite je Befehl (unten)

Wie Templates im Backend organisiert und den Inhaltsbereichen zugewiesen werden, beschreibt das Handbuch für Administratoren.

Befehlsreferenz

(CMS:BEFEHL wert parameter=wert parameter[schlüssel]="wert" …)

Befehlsname und Parameternamen sind unabhängig von Groß- und Kleinschreibung. Der erste Wert ohne = gilt als Hauptparameter des Befehls ((CMS:TEXT titel) = (CMS:TEXT field=titel)). Werte in Anführungszeichen dürfen PHP-Ausdrücke enthalten, so wie sie in einem PHP-String üblich sind ("{$set['x']}").

Ausgabeparameter sind bei den meisten Befehlen dieselben:
ifempty (Ersatz bei leerem Wert),
instead (Ersatz bei nicht leerem Wert),
prefix / suffix (nur bei nicht leerem Wert),
set (Ergebnis wird in die Variable $set[…] geschrieben, statt auf die Seite),
id (anderer Datensatz als Quelle),
replace (Teiltexte ersetzen) bei TEXT, DATE, DATETIME, TIME und NUMBER.

Ausgabe

Verknüpfungen

Abfragen

Navigation

Steuerung

Frontend-Editing

Community

Die Community-Funktionen richtet der Administrator ein (siehe Handbuch für Administratoren).

Zusatzmodul PDF

Das Zusatzmodul PDF (camindo/module-pdf) ergänzt die Befehle (CMS:PDF_…), mit denen Templates PDF-Dokumente erzeugen – Seite für Seite, auf Wunsch auf einer PDF-Vorlage wie einem Briefbogen, mit Texten, HTML, Bildern, Linien und Tabellen:

(CMS:PDF_INIT margins=25,20,30,20)
(CMS:PDF_PAGE briefbogen.pdf)
(CMS:PDF_FONT helvetica style=B size=16)
(CMS:PDF_TEXT "Rechnung {$cms['nummer']}" y=50)
(CMS:PDF_PRINT rechnung.pdf)

Die vollständige Befehlsliste enthält die Dokumentation des Moduls.

1 Grundlagen der Template-Programmierung

Was ein Template ist

Ein Template ist ein Textdokument – meist HTML –, in dem CMS-Befehle stehen. Die Befehle fragen Datensätze ab, setzen Inhalte ein, binden andere Templates ein, werten Formulare aus und steuern den Ablauf. Dazwischen darf PHP-Code stehen.

(CMS:INCLUDE header)
<h1>(CMS:TEXT title)</h1>
<div>(CMS:TEXT text)</div>
<div>(CMS:MEDIA field=bild_klein attr[id]=bild1)</div>
<div>erstellt: (CMS:DATE created_at format="dd.MM.y")</div>
(CMS:INCLUDE footer)

Beim Speichern übersetzt camindo CMS das Template in PHP. Zur Laufzeit wird nur noch dieses PHP ausgeführt – es braucht keine Template-Engine, die den Text bei jedem Aufruf neu auswertet.

Wie eine Seite entsteht

Ruft ein Besucher eine Adresse auf, ermittelt camindo CMS:

1. die Instanz – aus der Domain,
2. die Sprache – aus dem Sprachkürzel der Adresse, sonst aus der Spracheinstellung des Browsers, sonst die Hauptsprache,
3. den Datensatz – aus dem Slug oder der Nummer (record_id) in der Adresse; ohne Angabe den Start-Datensatz der Instanz,
4. das Template – aus der Adresse, aus dem Datensatz oder das Standard-Template seines Inhaltsbereichs.

Die Inhalte eines aufgerufenen Datensatzes stehen im Template zur Verfügung. Standardmäßig beziehen sich alle Ausgabe-Befehle auf diesen Datensatz – vgl. oben (CMS:TEXT title). Führt das Template eine Abfrage mittels CMS:SELECT durch, stehen die Inhalte der ermittelten Datensätze in gleicher Weise im Ergebnis-Template zur Verfügung; siehe unten Listen, Select, Ergebnisse.

Adressen

[/{sprache}]/{slug oder nummer}[,{template}]

Reine Ziffernfolgen sind immer Datensatznummern, alles andere ist ein Slug. Ist der erste Teil der Adresse der Slug-Prefix eines Inhaltsbereichs, wird der Rest nur in diesem Bereich gesucht; sonst der ganze Pfad in den Bereichen ohne Präfix. Das Sprachkürzel steht in der Adresse, sobald die Instanz mehr als eine Sprache führt. Adressen erzeugen Sie mit CMS:URL – nie von Hand, dann stimmen Sprache, Slug und Domain immer.

Besteht die Adresse nur aus dem Sprachkürzel (/en, ohne Schrägstrich am Ende), leitet camindo CMS auf die Startseite der Sprache um (/en/ oder /en_US/ – je nachdem, wie diese eingerichtet ist). Führt der Auftritt nur eine Sprache und hat ein Datensatz genau diesen Slug, wird stattdessen der Datensatz gezeigt. Adressen, unter denen es nichts gibt – unbekannter Datensatz, unbekannte Sprache, nicht freigegebenes Template –, antworten mit dem Status 404.

Syntax der CMS-Befehle

(CMS:BEFEHL wert parameter=wert parameter[schlüssel]="wert" …)

• Befehlsnamen und Parameternamen sind unabhängig von Groß- und Kleinschreibung.
• Parameter sind durch Leerzeichen getrennt; ein Befehl darf über mehrere Zeilen gehen.
• Die Reihenfolge, in der Parameter verarbeitet werden, bestimmt jeder Befehl selbst, nicht die Reihenfolge, in der die Parameter geschrieben werden.
• Der erste Wert ohne = gilt als Hauptparameter des Befehls: (CMS:TEXT titel) ist dasselbe wie (CMS:TEXT field=titel).
• Werte, die Leerzeichen enthalten, stehen in Anführungszeichen, einfache oder doppelte: (CMS:TEXT field="title") entspricht (CMS:TEXT field='title').
• Unterschlüssel in eckigen Klammern: filter[area]=artikel. Leere Klammern hängen an eine Liste an: sort[]=datum sort[]=titel. Wird derselbe Unterschlüssel mehrfach angegeben, entsteht ebenfalls eine Liste ([] ist im Gegensatz zur PHP-Syntax für Arrays optional).
• Statt = darf ein Vergleichsoperator zwischen Parameter und Wert stehen – ==, !=, !, !!, <, >, <=, >=, <<, >>: filter[preis] >= 100 ist dasselbe wie filter[preis]=">=100". Der Wert gilt dann unverändert, ein Operator an seinem Anfang wird nicht mehr ausgewertet: filter[code] < ">2" vergleicht mit dem Text „>2“. Bei = bleibt es wie gehabt – filter[code] = ">2" bedeutet „größer als 2“ (siehe Filter-Syntax).
• Der Zeilenumbruch hinter einem CMS-Befehl wird geschluckt, analog zu einem <?php … ?>-Block.
• Befehlsparameter in doppelten Anführungszeichen dürfen PHP-Variablen enthalten: attr[alt]="{$myvar}" (Parameter ohne Anführungszeichen werden intern wie Parameter mit doppelten Anführungszeichen behandelt).

Fehler – ein unbekannter Befehl, ein unbekannter Parameter, eine fehlende Klammer – verhindern das Speichern nicht. Die Detailansicht des Templates zeigt sie mit Zeilennummer an. Sie erscheinen auch auf der Startseite im Widget „Template-Meldungen“ – für den Fall, dass Templates über das Dateisystem bearbeitet werden.

CMS-Befehl und PHP-Code kombinieren

$set <?php … ?>-Blöcke dürfen frei im Template stehen, CMS-Befehle innerhalb von PHP-Blöcken führen allerdings zu Fehlern! Um Inhalte aus CMS-Befehlen in PHP-Blöcken zu verwenden, nutzen Sie den Parameter set (etwa set = myvar) und greifen den Inhalt im PHP-Block aus $set ($set['myvar']) auf.

$cms Inhalte aus dem aufgerufenen Datensatz stehen in $cms; ebenso Inhalte aus Datensätzen, die mittels CMS:SELECT ermittelt werden.

Für die Ausgabe sollten immer die CMS-Ausgabebefehle (etwa CMS:TEXT) verwendet werden. Diese Befehle kümmern sich um korrekte Formatierung, ein <?php echo $cms[…] ?> um nichts davon. Verwenden Sie $cms nur dort, wo ein Befehl einen Wert als Parameter braucht, etwa filter[kategorie]="{$cms['record_id']}".

Gemeinsame Parameter der Ausgabebefehle

(CMS:TEXT untertitel prefix="<h2>" suffix="</h2>")
(CMS:NUMBER preis format="%.2f" decimal="," suffix=" €" ifempty="auf Anfrage")

Werte in Attributen und Javascript

camindo CMS entfernt aus allen Datensatz-Inhalten Script, Event-Handler (onclick …), iframe, object, embed und javascript:-Links – beim Speichern und noch einmal bei der Ausgabe. HTML-Formatierung bleibt, deshalb gibt CMS:TEXT Inhalte unmaskiert aus.

Setzen Sie einen Wert in ein HTML-Attribut ein, maskieren Sie ihn mit specialchars=true – ein Anführungszeichen im Inhalt beendete sonst das Attribut:

<img src="…" alt="(CMS:TEXT title specialchars=true)">
<a href="(CMS:URL)" title="(CMS:TEXT teaser specialchars=true striptags=true lbrconvert=false)">…</a>

Dasselbe gilt für Formulareingaben, die Sie nach dem Absenden wieder ins Feld setzen:

<input name="data[nickname]" value="(CMS:TEXT useval="{$_POST['data']['nickname']}" specialchars=true)">

Befehle, die selbst maskieren: Einige Befehle maskieren ihre Ausgabe bereits mit htmlspecialchars. Dort entfällt specialchars – ein bereits maskierter Wert würde doppelt maskiert, aus & würde sichtbar &:

Was Sie einem dieser Befehle übergeben, muss deshalb unmaskierter Text sein – ohne HTML-Tags und Entities:

(CMS:TEXT title striptags=true ampconvert=false lbrconvert=false set=title)
(CMS:MEDIA bild attr[alt]="{$set['title']}")

Nie maskiert werden prefix, suffix, ifempty und instead – sie stammen aus dem Template und dürfen HTML enthalten. specialchars kennen nur CMS:TEXT und CMS:SNIPPET. Werte anderer Befehle, etwa CMS:MEDIA … subfield=filename, CMS:RELATION oder CMS:RAW, legen Sie für ein Attribut mit set ab und geben sie über CMS:TEXT maskiert aus:

(CMS:MEDIA dokument subfield=filename set=dateiname)
<a href="(CMS:MEDIA dokument subfield=path)" title="(CMS:TEXT useval="{$set['dateiname']}" specialchars=true lbrconvert=false)">…</a>

CMS:URL und CMS:MEDIA … subfield=path erzeugen nur URL-taugliche Zeichen, ebenso CMS:TEXT … urlencode=true – sie können ohne Maskierung in href und src stehen.

Braucht Javascript einen Wert, geben Sie ihn als data--Attribut aus und lesen ihn dort – so steht nie Inhalt im Script-Code selbst:

<div id="produkt" data-title="(CMS:TEXT title specialchars=true)"></div>
<script>var title = document.getElementById('produkt').dataset.title;</script>

Listen: SELECT und die Ergebnisschleife

Listen entstehen immer aus zwei Templates: Das aufrufende Template fragt mit CMS:SELECT ab und nennt ein Listentemplate. Das Listentemplate durchläuft die Treffer zwischen CMS:RESULT_START und CMS:RESULT_END.

Aufrufendes Template:

<h2>Aktuelle Meldungen</h2>
(CMS:SELECT meldungen_liste
  filter[area]=meldungen
  sort=datum
  order=desc
  limit=10
  noresult="<p>Keine Meldungen.</p>"
)

Listentemplate meldungen_liste:

<ul>
(CMS:RESULT_START)
  <li><a href="(CMS:URL)">(CMS:TEXT titel)</a> – (CMS:DATE datum)</li>
(CMS:RESULT_END)
</ul>

Innerhalb der Schleife ist die jeweilige Zeile der laufende Datensatz. Ein Listentemplate darf selbst wieder CMS:SELECT enthalten – etwa die Schlagwörter jedes Artikels.

Blätterfunktion: count=true zählt alle Treffer; CMS:JUMP_LIST, CMS:JUMP_PREV und CMS:JUMP_NEXT erzeugen daraus die Navigation.

Veröffentlichung: Templates finden nur veröffentlichte Datensätze – freigeschaltet, Veröffentlichungsdatum erreicht, Ablaufdatum nicht erreicht. Die Parameter future, archive lockern das je Abfrage, etwa für ein Archiv oder eine Terminvorschau.

Der Parameter state ist ausschließlich für Backend-interne Ansichten vorgesehen.

Bereiche ansprechen

Inhaltsbereiche werden über ihren Namen oder über ihre Nummer angesprochen (area_id): filter[area]=meldungen, filter[area]=12 oder filter[area_id]=12. Mehrere Bereiche trennen Sie durch Komma. Weil Feldnamen systemweit einheitlich sind, lassen sich mehrere Bereiche gemeinsam filtern und sortieren:

(CMS:SELECT zeitleiste
  filter[area]=meldungen,termine,blog
  filter[datum] >= 2026-01-01
  sort=datum
  order=desc
)

sort=area sortiert nach Bereich; _default steht in Filtern und Sortierung für das Hauptfeld jedes Bereichs, egal wie es dort heißt.

Übersichtsseite eines Bereichs

Die Adresse aus dem Slug-Prefix allein (/termine) ruft das Übersichts-Template des Bereichs auf – ohne Datensatz. An dessen Stelle stehen die Angaben des Bereichs:

So listet ein Übersichts-Template die Datensätze seines Bereichs, ohne dessen Namen fest einzutragen – und lässt sich für mehrere Bereiche verwenden:

<h1>(CMS:TEXT area_label specialchars=true)</h1>
(CMS:SELECT termin_liste
  filter[area]="{$cms['area_id']}"
  sort=datum order=asc
)

Verknüpfte Datensätze

Mit relation fragt CMS:SELECT die Datensätze ab, die mit dem laufenden (oder mit src_id genannten) Datensatz über ein Verknüpfungsfeld verbunden sind.

(CMS:SELECT galerie_liste
  relation=see_also
  sort="created_at desc"
)

Mit sort="_custom asc" erscheinen verknüpfte Datensätze in der Reihenfolge, die die Redaktion im Lookup-Feld (mittels der Pfeil-Schaltflächen) festgelegt hat:

(CMS:SELECT galerie_liste
  relation=bilder
  sort="_custom asc"
)

Nach Feldern verknüpfter Datensätze sortieren und filtern Sie mit der Punkt-Schreibweise: sort=autor.nachname.

Steht kein laufender Datensatz zur Verfügung und ist src_id nicht angegeben oder ungültig, findet die Suche mit dem Parameter relation nichts.

Das Konzept: Jeder Datensatz hat eine Seite

In camindo CMS hat jeder Datensatz eine eigene Seite im Frontend – nicht nur Artikel und Produkte, sondern auch jede Kategorie, jedes Schlagwort, jedes Material. Dafür braucht eine Website keine Parameter wie ?cat=12 oder ?tag=eiche:

1. Verlinken: Listen verlinken jeden Datensatz mit CMS:URL – die Kategorie ebenso wie das Produkt.
2. Standard-Template je Bereich: Jeder Inhaltsbereich bekommt ein Standard-Template – eine Kategorie-Seite, eine Schlagwort-Seite, eine Produkt-Seite. Mit einem Slug-Prefix erhält jede Art von Seite ihren eigenen Adressraum (/de/kategorie/wohnen, /de/schlagwort/eiche).
3. Verknüpfte Inhalte listen: Auf der Seite steht der Datensatz in $cms; seine verknüpften Datensätze fragt das Template direkt über ihn ab.

Kategorie-Seite (Standard-Template des Bereichs kategorien):

<h1>(CMS:TEXT titel)</h1>
(CMS:TEXT text prefix="<p>" suffix="</p>")
(CMS:SELECT produkt_liste
  relation=rel_produkte
  sort=position
  order=asc
)

Listentemplate produkt_liste – die Produkte verlinken wieder auf ihre eigene Seite:

<ul>
(CMS:RESULT_START)
  <li><a href="(CMS:URL)">(CMS:TEXT titel)</a></li>
(CMS:RESULT_END)
</ul>

Die Navigation ist ebenso einfach – eine Liste aller Kategorien mit Links:

(CMS:RESULT_START)
<a href="(CMS:URL)">(CMS:TEXT titel)</a>
(CMS:RESULT_END)

Welche Abfrage die verknüpften Datensätze liefert, hängt davon ab, von welcher Seite die Verknüpfung ausgeht:

Beziehungsfelder (relation, relation1) sind in beide Richtungen verknüpft: Beim Anlegen erzeugt camindo CMS im Zielbereich ein Gegenfeld namens rel_{bereichsname} (etwa rel_produkte), das die Verknüpfung von der anderen Seite führt. Die Kategorie-Seite fragt ihre Produkte deshalb mit relation=rel_produkte ab, die Produktseite ihre Kategorien mit relation=kategorien.

Verweisfelder (pointer, pointer1) sind gerichtet – sie können dafür auf mehrere Bereiche zeigen. Der Zieldatensatz kennt seine Verweise nicht; das Gegenstück ist ein Filter auf das Verweisfeld mit der Nummer des laufenden Datensatzes:

(CMS:SELECT produkt_liste
  filter[area]=produkte
  filter[kategorie]="{$cms['record_id']}"
)

Achtung: Die Nummer des laufenden Datensatzes steht in $cms['record_id'] – einen Schlüssel id gibt es nicht. Ein leerer Filterwert hebt den Filter auf: filter[kategorie]="{$cms['id']}" findet deshalb nicht keine, sondern alle Produkte.

Suchen und freie Filterkombinationen bleiben Parameter (?q=…), denn sie sind keine Datensätze. Alles, was ein Datensatz ist, hat dagegen seine eigene Adresse – und damit auch Seitentitel, Beschreibung und Frontend-Editing wie jede andere Seite.

Filter-Syntax

Die Werte in filter[…] folgen derselben Syntax wie die Suchmaske im Backend:

Der Operator darf auch zwischen Schlüssel und Wert stehen – praktisch, wenn der Wert aus einer Variablen kommt:

(CMS:SELECT sperrfrist_mail
  filter[area] = pressemeldungen
  filter[online_at] > {$set['last_run']}
  filter[online_at] <= {$set['this_run']}
  filter_mode[online_at] = AND
  future = true
)

entspricht filter[online_at]=">{$set['last_run']}" und filter[online_at]="<={$set['this_run']}". Mit einem solchen Operator ist der Wert selbst frei von Operatoren: Beginnt der Inhalt der Variablen mit <, > oder !, wird das als Text verglichen.

Ein Datumswert, der sich nicht auswerten lässt (etwa ein Unix-Zeitstempel wie $_SERVER['REQUEST_TIME']), wird ohne Meldung übergangen – die Liste zeigt dann alle Datensätze, als stünde der Filter nicht da. Für Analysen in Ihrer Entwicklungsumgebung hilft debug=true: Die erzeugte SQL-Abfrage wird angezeigt.

Textvergleiche nach Sprache: Text- und Zeichenfelder (auch _default) werden nach den Regeln der Sprachversion verglichen und sortiert, in der gesucht wird – abgeleitet aus dem Sprachkürzel, einzustellen ist nichts. Immer gilt: keine Unterscheidung von Groß-/Kleinschreibung und Akzenten (cafe findet „Café“), ß gleich ss. Dazu kommen die Regeln einzelner Sprachen:

Eigene Regeln haben außerdem Bulgarisch, Esperanto, Estnisch, Galicisch, Isländisch, Kroatisch und Bosnisch, Lettisch, Litauisch, Polnisch, Rumänisch, Russisch, Serbisch (lateinisch), Slowakisch, Slowenisch, Spanisch, Tschechisch, Ungarisch und Vietnamesisch. Alle übrigen Sprachen – auch Englisch – folgen den allgemeinen.

Das gilt für =, Platzhalter und Vergleiche wie > gleichermaßen, ebenso für Volltextfelder (Mueller findet „Müller“, Muller nicht). Im Backend ist es die Sprache, die für die Instanz des durchsuchten Bereichs eingestellt ist; führen die Instanzen einer Suche auf verschiedene Regeln, gelten nur die allgemeinen.

Verschiedene Filter werden immer mit UND verknüpft. Volltextfelder verstehen +muss -darfnicht; verschlüsselte Felder nur den exakten Wert.

In Bereichen mit Baumstruktur liefert filter[parent_id]=42 alle Nachkommen des Datensatzes 42, zusammen mit filter[depth]=1 nur die direkten Kinder – die Grundlage für Navigationen.

Templates einbinden und organisieren

CMS:INCLUDE bindet ein anderes Template ein – etwa Kopf und Fuß der Seite:

(CMS:INCLUDE layout.kopf)
<main>…</main>
(CMS:INCLUDE layout.fuss)

Template-Namen müssen nur innerhalb ihres Template-Bereichs eindeutig sein. Gibt es einen Namen in mehreren Bereichen, sprechen Sie ihn als bereichsname.templatename an. Einen Namen, der nicht eindeutig ist, meldet die Seite als Fehler.

Übliche Aufteilung:

Caching

Aufwendige Bausteine – eine Navigation aus vielen Abfragen, eine Produktliste – kann CMS:INCLUDE mit caching zwischenspeichern: (CMS:INCLUDE layout.navigation caching=1h) erzeugt die Navigation höchstens einmal in der Stunde je Website und Sprache. Wovon die Ausgabe sonst noch abhängt, gehört in cacheparams – siehe CMS:INCLUDE.

Mehrsprachigkeit

Ein Template gibt automatisch die Sprachversion des Aufrufs aus – bei fehlender Übersetzung die Hauptsprache. Links mit CMS:URL behalten die Sprache bei; mittels Parameter lang wird explizit auf eine andere Sprachversion verlinkt. Einen Sprachumschalter bauen Sie mit CMS:SELECT_LANGVERSION.

Datums- und Zahlenformate richten sich nach der Sprachversion; die Zeitzone ebenso.

Feste Beschriftungen („Weiterlesen“, „Suchen“) pflegt die Redaktion als eigenständige Datensätze (etwa in einem Bereich namens „Sonstige Texte“) in allen Frontend-Sprachen. In diesem Bereich sollte es ein einsprachiges slug-Feld und ein mehrsprachiges text-Feld geben. Dann arbeitet CMS:TEXT als Snippet-Lieferant, vgl. CMS:TEXT mit id-Parameter.

<a href="(CMS:URL)">(CMS:TEXT id=mysnippets.readmore)</a>

Frontend-Editing

CMS:FED setzt an einen Inhalt eine Bearbeiten-Markierung, die nur Benutzer mit eingeschaltetem Frontend-Editing sehen. Ein Klick öffnet die Eingabemaske des Datensatzes im Backend. CMS:FED_CODE gibt HTML nur in diesem Fall aus – etwa ein Stylesheet für die Markierungen.

Sicherheits-Header: CSS, Javascript, JSON und Einbetten

camindo CMS schickt vor jedem Template einige HTTP-Header mit, die der Browser als Schutz umsetzt:

X-Content-Type-Options: nosniff
X-Frame-Options: SAMEORIGIN
Content-Security-Policy: frame-ancestors 'self'
Referrer-Policy: strict-origin-when-cross-origin

Für gewöhnliche HTML-Seiten müssen Sie nichts tun. Zwei Fälle wirken sich aber aus – und die Ursache ist nicht auf den ersten Blick zu sehen:

Templates, die CSS, Javascript oder JSON ausliefern

Ein Template wird als text/html ausgeliefert, wenn es nichts anderes sagt. Wegen nosniff nimmt der Browser dann den Inhalt nicht als Stylesheet oder Script an, auch wenn er richtig ist. Die Seite sieht ungestaltet aus, das Script läuft nicht – und die Konsole des Browsers meldet etwas wie „refused to execute script … MIME type ('text/html') is not executable“ bzw. „… not a supported stylesheet MIME type“.

Setzen Sie deshalb am Anfang jedes solchen Templates den passenden Typ – vor jeder Ausgabe, ohne Leerzeile davor:

(CMS:HEADER "Content-Type: text/css; charset=utf-8")
(CMS:HEADER "Content-Type: text/javascript; charset=utf-8")
(CMS:HEADER "Content-Type: application/json; charset=utf-8")

Ausgaben in anderen Websites einbetten

Eine Seite der Website lässt sich nur innerhalb derselben Website in einem <iframe> zeigen. Das schützt Anmeldung, Profil und Warenkorb davor, dass eine fremde Seite sie unsichtbar überlagert und Besuchern Klicks unterschiebt (Clickjacking). Bindet eine Partnerwebsite eine Seite per <iframe> ein, bleibt der Rahmen deshalb leer oder zeigt eine Fehlerseite des Browsers; die Konsole meldet „Refused to frame … because an ancestor violates … frame-ancestors“ bzw. „… X-Frame-Options to 'sameorigin'“.

Soll ein Template eingebettet werden dürfen – ein Widget, ein Terminkalender für Partner –, geben Sie das nur in diesem Template frei: X-Frame-Options ohne Wert entfernen und die erlaubten Websites in frame-ancestors nennen:

(CMS:HEADER "X-Frame-Options:")
(CMS:HEADER "Content-Security-Policy: frame-ancestors 'self' https://www.partner.example https://*.partner.example")

Beide Zeilen gehören zusammen: Ein Browser, der X-Frame-Options noch sieht, verweigert den Rahmen trotz frame-ancestors. Nennen Sie die Partner einzeln – frame-ancestors * erlaubt jeder Website das Einbetten – auch das der Seiten mit Formularen. Andere Einbindungen sind nicht betroffen: Bilder, Downloads, per Javascript geladene Daten (JSON) und Links auf Ihre Website funktionieren ohne Freigabe.

Mehr zu den Header-Zeilen: CMS:HEADER.

Templates im Dateisystem

Jedes Template liegt als Datei unter var/templates/{instance_id}/{bereichsname}/{templatename}.cms.php. Sie können es dort mit einem Code-Editor bearbeiten und mit Git verwalten. camindo CMS übernimmt Änderungen minütlich (oder sofort über „Aktualisieren“ im Modul Templates) und übersetzt das Template neu. Umbenennen sollten Sie Templates im Backend – im Dateisystem gilt Umbenennen als Löschen und Neuanlegen, und die Zuweisungen gehen verloren. Fehlermeldungen erscheinen im Widget „Template-Meldungen“.

Editor-Unterstützung

Für Visual Studio Code gibt es die Erweiterung „camindo CMS Templates“ (github.com/dirkintelligence/camindo-vscode, auch im Visual Studio Marketplace und bei Open VSX). Sie färbt in *.cms.php-Dateien die CMS-Befehle lila und die PHP-Ausdrücke darin orange – wie die Ansicht im Backend –, ergänzt nach (CMS: die Befehlsnamen und danach die Parameter des Befehls und zeigt beim Überfahren deren Beschreibung, in derselben Sprache wie das Backend.

Die Erweiterung kennt die Befehle des Kerns und der Standardmodule. Bringen Ihre Module eigene Befehle mit, schreiben Sie die Befehlsliste Ihres Projekts mit

php Core/cron/camindo.php template commands --all --out=var/vscode

und tragen das Verzeichnis in der VS-Code-Einstellung camindo.commandsFile ein.

Zeitgesteuerte Templates

Ein Template mit der Verwendung „Zeitgesteuert“ (Reiter „Zugriff“ des Templates) läuft nicht als Seite, sondern als Aufgabe des Zeitplaners (Aufgabentyp „Template“, siehe Handbuch für Administratoren). Über eine Adresse ist es nie erreichbar.

Es läuft wie ein Seitenaufruf ohne Datensatz: in der Website seines Template-Bereichs, in der Sprache, die die Aufgabe nennt – mit deren Texten, Snippets, Datumsformaten und Zeitzone. Es gibt keinen Besucher, also keine Anmeldung und keinen Warenkorb. Die Aufgabe übergibt das Zeitfenster seit dem letzten erfolgreichen Lauf:

Beim ersten Lauf ist das Zeitfenster leer. Schlägt ein Lauf fehl, holt der nächste den ganzen Zeitraum nach – nichts geht verloren und nichts wird doppelt verarbeitet. Das Zeitfenster passt direkt in einen Filter; zwei Bedingungen für dasselbe Feld verknüpft filter_mode mit AND:

(CMS:SELECT sperrfrist_mail
  filter[area]=pressemeldungen
  filter[online_at] > {$set['last_run']}
  filter[online_at] <= {$set['this_run']}
  filter_mode[online_at]=AND
  future=true
)

Das Ergebnis-Template verschickt dann etwa mit CMS:EMAIL (submit=1) je Treffer eine Nachricht; CMS:URL mit absolute=true liefert die vollständige Adresse für Links. Meldet ein Befehl einen Fehler, gilt der Lauf als fehlgeschlagen. Was das Template ausgibt, speichert die Aufgabe auf Wunsch unter var/custom/ – so entsteht etwa eine Sitemap oder ein Feed als Datei.

Vorschau

Die Vorschau aus dem Backend zeigt auch unveröffentlichte Datensätze mit ihrem Template. Listen darin zeigen weiterhin nur veröffentlichte Datensätze, ebenso id=… und CMS:RELATION. In der Vorschau liefert $this->isPreview() true.

Listen-Templates für das Backend

Ein Inhaltsbereich kann ein Listen-Template haben, das nur im Backend verwendet wird: für eine zusätzliche Spalte der Datensatzliste und die ausführliche Vorschau in Lookup-Feldern. Im Template steht der Datensatz der Zeile als $cms bereit; die Ausgabebefehle CMS:TEXT, CMS:MEDIA… funktionieren wie im Frontend:

(CMS:MEDIA bild_klein width=60)
<small>(CMS:NUMBER preis format="%.2f" decimal="," suffix=" €")</small>

CMS:RELATION ist hier hilfreich, um das Hauptfeld verknüpfter Datensätze zu listen.

2 Template-Sätze

Gekapselte Funktionalität

Ein Template-Satz bündelt eine Funktion der Website: Templates, Inhaltsbereiche, ggf. Datensätze und Snippets. Beispiele:

Ein guter Template-Satz ist direkt betriebsbereit: Importieren, Inhalte eingeben, fertig. Und er ist anpassbar an den individuellen Aufbau einer Website, ohne dass die Funktion neu entwickelt werden muss. Weitergegeben wird er per XML-Export mit der Option „Templates für Import in Fremddatenbank optimieren“ (siehe Handbuch für Administratoren).

Regeln für portable Template-Sätze

Ein Ordner, ein Template-Bereich

Legen Sie die Inhaltsbereiche und den Template-Bereich eines Satzes gemeinsam in einen Ordner. So exportiert ein Klick den ganzen Satz, und beim Import ist klar, was zusammengehört.

Namen und Ids direkt im Befehlsparameter

Templates, Inhaltsbereiche, Datensätze werden in den Templates mittels ihrer ID oder ihres Namens (bzw. Slugs) angesprochen. In einer fremden Datenbank sind diese unter Umständen schon belegt; dann vergibt der Importer neue und passt die Templates daran an. Die Anpassung gelingt aber nur, wenn IDs, Namen, Slugs direkt in den Befehlsparametern stehen. Steht im Parameter eine PHP-Variable, die erst zur Laufzeit ihren Wert enthält, schlägt die Anpassung fehl.

Einheitliche Feldnamen

Für Ihre eigenen Template-Sätze: Verwenden Sie dieselben Feldnamen wie im Rest der Website (titel, datum, text, bild, slug). Dann funktionieren bereichsübergreifende Listen – etwa eine Zeitleiste aus News und Terminen – ohne Anpassung, und ein Template-Satz lässt sich leicht mit bestehenden Bereichen kombinieren.

Für Template-Sätze in anderen Datenbanken: Nutzen Sie die Namens-Präfixe, damit es beim Import nicht zu Typkonflikten kommt (siehe Reservierte Namens-Präfixe).

Logik und Gestaltung trennen

Halten Sie die Logik (Abfragen, Filter, Blätterfunktion, Formularauswertung) in wenigen Templates zusammen und die Gestaltung in eigenen, kleinen Bausteinen:

news_uebersicht     (CMS:SELECT news_liste filter[area]=meldungen … count=true)
news_liste          (CMS:RESULT_START) (CMS:INCLUDE news_teaser) (CMS:RESULT_END)
                    (CMS:JUMP_LIST …)
news_teaser         <article class="teaser"> … (CMS:TEXT titel) … </article>

Wer den Satz an ein anderes Design anpasst, ändert nur news_teaser und die übrigen Gestaltungsbausteine; die Funktion bleibt unberührt.

Das Layout der Website einbinden

Verwenden Sie feste Kopf- und Fuß-Templates; diese können einfach durch vorhandene ersetzt werden.

Texte in einem eigenen Inhaltsbereich

Feste Beschriftungen („Weiterlesen“, „Zurück zur Übersicht“, Fehlermeldungen von Formularen) gehören in einen eigenen Inhaltsbereich (etwa „Beschriftungen“). Eingebunden werden sie mittels CMS:TEXT, z. B. (CMS:TEXT id=beschriftungen.weiterlesen). So können sie einfach für die spätere Website angepasst / übersetzt werden.

Label als Custom-Snippets

Um auch Bereichsnamen und Eingabefelder mehrsprachig zu halten, können Custom-Snippets angelegt werden (siehe Modul Snippets). Die im Template-Satz verwendeten Snippets werden automatisch in die Export-Datei integriert.

Einstellungen als Datensatz

Soll die Redaktion das Verhalten eines Satzes steuern – Anzahl der Einträge je Seite, Titel der Übersichtsseite, ein Einleitungstext –, legen Sie dafür einen kleinen Inhaltsbereich „Einstellungen“ mit einem einzigen Datensatz an und lesen ihn über seinen Slug:

(CMS:TEXT einleitung id=news-einstellungen)
(CMS:NUMBER eintraege_je_seite id=news-einstellungen set=limit)
(CMS:SELECT news_liste filter[area]=meldungen limit="{$set['limit']}" count=true)

Beispielinhalte mitliefern

Ein paar Beispiel-Datensätze zeigen nach dem Import sofort, wie der Satz aussieht und funktioniert. Exportieren Sie sie mit, samt Bildern.

Dokumentieren

Legen Sie dem Satz eine kurze Beschreibung bei – als Hinweis des Ordners oder als Datensatz: welche Templates als Standard-Template zuzuweisen sind, welche Layout-Templates erwartet werden, welche Snippets und Konverter der Satz nutzt.

CSS als Template

Binden Sie das benötigte CSS als Template ein – so erscheint der Template-Satz sofort im gewollten Design. Der Nutzer kann das CSS jederzeit in eine Datei auslagern. Beachten Sie jedoch, dass dieses Template gesonderte Header-Anweisungen benötigt, siehe Templates, die CSS, Javascript oder JSON ausliefern.

Einen Template-Satz einsetzen

1. Importieren (Modul Inhalte → Startseite → Menü → Import), vorzugsweise zuerst in einer Testumgebung.
2. Mit der Vorschau testen – insbesondere Verweise, die das Importprotokoll als „nicht zugeordnet“ meldet.
3. Header und Footer anpassen oder durch eigene ersetzen.
4. Falls es sich beim Template-Satz um eine ganze Website handelt: Startseiten-Id oder Startseiten-Template in der Instanz eintragen.
5. Rechtliche Aspekte klären, ggf. Texte und Lösch-Policies anpassen.

3 Trigger-Templates

Ein Trigger-Template enthält PHP-Methoden, die camindo CMS bei Ereignissen der Datensätze eines Inhaltsbereichs aufruft – beim Anlegen, Speichern, Löschen, Wiederherstellen und bei den Aktionen einer Lösch-Policy. So lassen sich Inhalte beim Speichern aufbereiten (mehrere Felder zu einem zusammenfassen, Werte prüfen), verbundene Daten nachziehen oder personenbezogene Daten nach eigenen Regeln anonymisieren.

Die Methoden laufen, gleich woher die Änderung kommt: Eingabemaske, Frontend (CMS:SAVEDATA, CMS:USER_…), API, Import, Stapelverarbeitung, Papierkorb-Cronjob und Lösch-Policies.

Zuweisen

Ein Trigger-Template ist ein gewöhnliches Template in einem Template-Bereich. Sie weisen es in den Einstellungen des Inhaltsbereichs unter „Trigger-Templates“ zu (siehe Handbuch für Administratoren). Ein Bereich kann mehrere Trigger-Templates haben, und dasselbe Template darf mehreren Bereichen zugewiesen sein. So lassen sich wiederverwendbare Bausteine bilden – etwa ein Template, das in allen Bereichen Slugs pflegt, und daneben eines mit den Regeln eines einzelnen Bereichs.

Reihenfolge

Die Templates eines Bereichs laufen bei jedem Ereignis nacheinander in der angezeigten Reihenfolge; Sie ändern sie mit den Pfeil-Schaltflächen arrow_upward arrow_downward neben jedem Eintrag.

• Ein Template ohne die Methode des Ereignisses wird übergangen.
• Alle bekommen dieselben Variablen: Was ein Template an $data oder $affectedFields ändert, sieht das nächste schon.
• Wirft ein Template eine Ausnahme, laufen die folgenden nicht mehr, und der Vorgang wird abgebrochen (siehe Abbrechen).
• Jedes Template ist ein eigenes Objekt: Eigenschaften und Hilfsmethoden gleichen Namens in verschiedenen Templates stören sich nicht. Daten zwischen Templates tauschen Sie über $data aus.

Aufbau

Das Template enthält nur Methoden-Definitionen – keine Ausgabe, keine Anweisungen außerhalb der Methoden. camindo CMS setzt den übersetzten Code in den Rumpf einer Klasse; jede Methode wird so zur Methode eines Objekts:

<?php
// Trigger-Template "mitglieder_trigger" für den Bereich Mitglieder

function onSave(array &$affectedFields, array &$data, array &$previousData): void
{
    // Anzeigename aus Vor- und Nachname
    $data['name'] = trim(($data['vorname'] ?? '') . ' ' . ($data['nachname'] ?? ''));
    if (!in_array('name', $affectedFields, true)) $affectedFields[] = 'name';
}

private function normalize(string $text): string
{
    return trim(preg_replace('/\s+/', ' ', $text));
}

• Alle Ereignis-Methoden sind optional. Fehlt eine, passiert bei dem Ereignis nichts.
• Eigene Hilfsmethoden (private function …), Eigenschaften und Konstanten sind erlaubt.
• CMS:SELECT ist erlaubt, um Inhalte verknüpfter Datensätze zu ermitteln (Anmerkungen unten beachten!)
• Klassen sprechen Sie mit vollem Namen an (\Camindo\Core\Cms, \DateTimeImmutable) – use geht nicht, weil der Code mitten in einer Klasse steht.
• Ein Template, das sich nicht laden lässt (Syntaxfehler, Ausgabe außerhalb der Methoden), bricht den Vorgang mit einer Fehlermeldung ab. Datensätze ohne die vorgesehene Aufbereitung zu speichern wäre schlimmer.

Was im Template bereitsteht

Ereignisse

$previousData ist der gespeicherte Stand vor der Änderung (leer bei einem neuen Datensatz).

Abbrechen

Alle Ereignisse außer onCreate und onLoaded laufen in der Transaktion des Vorgangs. Eine Ausnahme bricht ihn ab und macht ihn vollständig rückgängig; die Meldung erscheint in der Eingabemaske bzw. als Fehler der API:

function onSave(array &$affectedFields, array &$data, array &$previousData): void
{
    if (($data['ende'] ?? '') !== '' && $data['ende'] < ($data['beginn'] ?? '')) {
        throw new \Exception('Das Ende liegt vor dem Beginn.');
    }
}

Zwischenspeichern

Wechselt ein Redakteur in der Eingabemaske den Reiter, speichert camindo CMS den Zwischenstand der Arbeitskopie – auch dabei laufen onSave und onSaved, mit $this->temporary = true. Aufwendige oder nach außen wirkende Schritte (E-Mails, Schnittstellen) gehören hinter if ($this->temporary) return;.

Verschieben

Wird ein Datensatz in einen anderen Bereich verschoben, gelten die Trigger-Templates des Zielbereichs. $data enthält dort schon die Felder des Zielbereichs, $previousData den Stand im Herkunftsbereich mit dessen Feldnamen.

Wiedereintritt

Speichert ein Template in onSaved() denselben Datensatz erneut, liefe es endlos. Ein Ereignis wird deshalb je Template für denselben Datensatz nicht verschachtelt ausgeführt: Beim erneuten Speichern laufen die übrigen Trigger-Templates des Bereichs, das gerade laufende nicht. Andere Datensätze – auch desselben Bereichs – lösen ihre Trigger normal aus.

Verknüpfte Inhalte abfragen

Die Inhalte des auslösenden Datensatzes stehen in $data (neuer Stand) und $previousData (vorheriger Stand) – mehrsprachige Felder mit allen Sprachen. Dort lesen und ändern Sie sie, nicht über CMS:TEXT.

Für andere Datensätze, etwa die verknüpften, können Sie CMS:SELECT wie in jedem Template verwenden. Während eine Methode läuft, enthält $cms nur record_id, die Nummer des auslösenden Datensatzes. Ein CMS:SELECT mit relation braucht deshalb kein src_id – und sollte keines haben (siehe unten):

function onSave(array &$affectedFields, array &$data, array &$previousData): void
{
    $isVariant = false;
?>
(CMS:SELECT
  relation=variante_von
  state=any archive=true future=true
  resulttemplate=shop.trigger_variante_gefunden
)
<?php
    $data['ist_variante'] = $isVariant ? 'ja' : '';
    if (!in_array('ist_variante', $affectedFields, true)) $affectedFields[] = 'ist_variante';
}

Das Ergebnis-Template (shop.trigger_variante_gefunden) läuft im Rumpf der Methode: Es sieht deren Variablen und $this und setzt hier nur $isVariant = true;. Es darf nichts ausgeben.

Beachten Sie die Grenzen:

• Neuer Stand der Verknüpfungen über $cms['record_id']. Während ein vorhandener Datensatz bearbeitet wird, hängen seine Verknüpfungen – ausgehende wie eingehende – an einer Arbeitskopie; erst nach dem Speichern gehen sie auf den Datensatz über. In onSave() – und in onSaved() beim Zwischenspeichern – enthält $cms['record_id'] deshalb die Nummer der Arbeitskopie: CMS:SELECT relation=… und CMS:RELATION ohne Quellangabe sehen so schon die geänderten Verknüpfungen, ebenso die Gegenrichtung („Wer verweist auf diesen Datensatz?“) mit dest_id="{$cms['record_id']}" bzw. filter[feld]="{$cms['record_id']}". $data['record_id'] ist dagegen immer die Nummer des Datensatzes selbst – damit erhalten Sie in onSave() den bisherigen Stand. In onSaved() nach dem endgültigen Speichern und in allen übrigen Methoden sind beide Nummern gleich.

• Eingebettete Inhalte beim Zwischenspeichern: Verknüpfungen eines Feldes mit eingebetteten Inhalten zeigen beim Zwischenspeichern auf deren Arbeitskopien, die CMS:SELECT nicht findet. Beim endgültigen Speichern sind diese Inhalte schon übernommen und werden gefunden.

• Veröffentlichung: CMS:SELECT findet auch hier nur, was die Website zeigen würde – freigegeben, Erscheinungsdatum erreicht, nicht abgelaufen. Geht es um die Struktur („Ist überhaupt ein Datensatz verknüpft?“), setzen Sie state=any archive=true future=true; sonst fehlen gesperrte, vordatierte und abgelaufene Datensätze. Datensätze im Papierkorb findet CMS:SELECT nie.

• Rechte: Die Abfrage sieht, was der Auslöser sehen darf. Das Ergebnis kann sich deshalb unterscheiden, je nachdem, wer speichert:

  Auslöser	Was CMS:SELECT findet
  Benutzer im Backend oder über die API	nur Inhalte der Instanzen, Bereiche und Sprachen, die seine Benutzergruppe lesen darf (Superuser: alle)
  Website (CMS:SAVEDATA, CMS:USER_…)	Inhalte der Instanz und ihrer lesbaren Instanzen
  Zeitplaner (auch später fällige Blöcke einer Lösch-Policy)	alle

• Sprache: Mehrsprachige Felder der gefundenen Datensätze erscheinen in einer Sprache – auf der Website in der Sprache der Seite, im Backend in der Inhaltssprache des Benutzers. Alle Sprachen liefert $this->record->load($id).

onPrivacyAction: Lösch-Policies

Eine Lösch-Policy legt fest, was beim Löschen eines Datensatzes geschieht. Was sich mit „Einzelne Felder überschreiben“ nicht ausdrücken lässt – verknüpfte Datensätze, Texte, die nur teilweise personenbezogen sind, mehrsprachige Inhalte je Sprache –, erledigt das Trigger-Template mit zwei Aktionen:

Jeder solche Block hat eine Kennung (Kleinbuchstaben, Ziffern, _). Sie kommt als $action an – daran unterscheidet das Template die Blöcke, etwa einen sofortigen Schritt und einen nach einem Jahr.

function onPrivacyAction(string $action, array &$data, array $context): void

Auf den Datensatz

$data enthält alle Felder des Datensatzes – mehrsprachige Felder als Array language_id => Wert, Dateifelder mit ihren Metadaten. Was die Methode an $data ändert, speichert camindo CMS anschließend:

• im Policy-Modus: ohne Pflichtfeld- und Formatprüfung und ohne Rechte der Benutzergruppe – „unique“ gilt weiter;
• Dateifelder, record_id, area_id, user_id und die übrigen Kennungen nicht. Eine Datei entfernen Sie mit „Einzelne Felder überschreiben“ (bild = "") im selben oder einem späteren Block;
• im Audit-Log als Aktion „nach Lösch-Policy angepasst“ (privacy), ohne die vorherigen Werte.

Liegt der Datensatz im Papierkorb ($context['deleted']), läuft die Methode ebenfalls – etwa um verknüpfte Daten aufzuräumen –, gespeichert wird am Datensatz dann aber nichts. Andere Datensätze bearbeitet die Methode selbst über $this->record oder $this->db.

Auf das Audit-Log

Für jeden Eintrag im Verlauf des Datensatzes wird die Methode mit dem Eintrag aufgerufen:

Geänderte Einträge schreibt camindo CMS zurück – in die Datei unter var/audit/ mit einem neuen Kontrollpunkt der Prüfsummenkette, label auch in die Datenbank. Einträge, die erst später entstehen (etwa beim endgültigen Löschen), durchlaufen die Methode nicht; planen Sie dafür einen späteren Block.

Hat der Bereich mehrere Trigger-Templates mit onPrivacyAction(), laufen sie nacheinander mit derselben Kennung; jedes prüft selbst, ob $action es betrifft.

Fehler

Hat keines der Trigger-Templates des Bereichs onPrivacyAction() oder wirft die Methode eine Ausnahme, scheitert der Auftrag: Er steht mit der Meldung im Log privacy und wird beim nächsten Lauf der Zeitplaner-Aufgabe „Lösch-Policies anwenden“ erneut versucht – höchstens 20-mal. Scheitert ein sofort fälliger Block, bricht das Löschen nicht ab: Die übrigen Blöcke laufen, der gescheiterte folgt mit dem nächsten Lauf.

CMS:DATE

Gibt den Datumsteil eines Datumswertes formatiert aus.

(CMS:DATE field [parameter=wert …])

Methode: Cms::cmsDate()
Ohne Schlüssel: der erste Wert ohne = gilt als field
Mindestens einer von: field, useval

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Gibt den Datumsteil eines Datums-/Zeitwertes aus. Quelle ist ein Datums- oder Datum-Zeit-Feld (Metafelder online_at, created_at, changed_at oder eigene Felder). Ohne format entscheidet die Sprache der Seite über die Schreibweise:

(CMS:DATE online_at)                            07.03.2024   (de)
(CMS:DATE online_at format="EEEE, d. MMMM y")   Donnerstag, 7. März 2024
(CMS:DATE online_at format="y-MM-dd")           2024-03-07

Typisch in Listen:

<time datetime="(CMS:DATE online_at format='y-MM-dd')">(CMS:DATE online_at)</time>

CMS:DATE, CMS:DATETIME und CMS:TIME sind derselbe Befehl mit unterschiedlichem Ausschnitt; alle drei kennen dieselben Parameter (CMS:DATETIME zusätzlich autotime).

Parameter im Einzelnen

id

id liest aus einem anderen Datensatz statt aus dem laufenden - record_id oder Slug, genau wie in der URL:

(CMS:DATE online_at id=1977)
(CMS:DATE online_at id=impressum)

field

field ist der Hauptparameter und darf ohne Schlüssel stehen - beide Zeilen sind gleich:

(CMS:DATE field=online_at)
(CMS:DATE online_at)

useval

useval nimmt statt eines Feldes einen Wert direkt aus dem Template - meist eine PHP-Variable oder ein zuvor mit set abgelegter Wert:

(CMS:DATE useval="2024-12-24")
(CMS:DATE useval="{$set['wert']}")

(CMS:DATE useval="{$set['user']['created_at']}")

format

format ist ein ICU-Muster (d Tag, MM Monat zweistellig, MMMM Monatsname, y Jahr, HH:mm Uhrzeit, EEEE Wochentag). Ohne format entscheidet die Sprache der Seite (im Backend die Locale des Benutzers):

(CMS:DATE online_at format="d. MMMM y")

Ausgabe: 7. März 2024

timezone

(CMS:DATE online_at timezone=true)

Ausgabe: 07.03.2024 Europe/Berlin

replace

replace ersetzt Teiltexte im fertig formatierten Wert - Kurzform mit ? als Trenner oder ein Eintrag je Suchtext:

(CMS:DATE online_at format="MMM y" replace="Jan.?Januar")
(CMS:DATE online_at format="MMM y" replace[Jan.]="Januar" replace[x]="y")

Ausgabe: Januar 2026 statt Jan. 2026

ifempty

ifempty ersetzt die gesamte Ausgabe, wenn die Quelle leer ist; prefix und suffix entfallen dann:

(CMS:DATE offline_at prefix="<p>" suffix="</p>" ifempty="unbegrenzt")

Als leer gelten auch die Platzhalter für „kein Datum“ und „kein Ende“, mit denen camindo CMS etwa ein unbegrenztes offline_at speichert (vor dem 2. Januar 1000 bzw. ab dem 31. Dezember 8999) – mit und ohne format.

instead

instead tauscht den Wert aus, sobald die Quelle nicht leer ist - nützlich, wenn nur das Vorhandensein zählt:

(CMS:DATE offline_at instead="befristet" ifempty="-")

prefix

prefix / suffix umschließen den Wert und erscheinen nur, wenn er nicht leer ist - so entsteht kein leeres veröffentlicht am:

(CMS:DATE online_at prefix="veröffentlicht am " suffix="")

suffix

(CMS:DATE online_at suffix=" (Erstveröffentlichung)")

Siehe prefix.

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['date'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:DATE online_at set=date)
<?php if ($set['date'] !== '') { ?> … <?php echo $set['date']; ?> … <?php } ?>

← Übersicht

CMS:DATETIME

Gibt Datum und Uhrzeit eines Datumswertes formatiert aus.

(CMS:DATETIME field [parameter=wert …])

Methode: Cms::cmsDatetime()
Ohne Schlüssel: der erste Wert ohne = gilt als field
Mindestens einer von: field, useval

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Gibt Datum und Uhrzeit aus. Wie CMS:DATE, nur mit Zeitanteil:

(CMS:DATETIME changed_at)                               07.03.2024, 14:30
(CMS:DATETIME changed_at format="dd.MM.y HH:mm")        07.03.2024 14:30
(CMS:DATETIME changed_at format="dd.MM.y HH:mm" autotime=true)

Mit autotime=true verschwindet die Uhrzeit, wenn im Wert keine gesetzt war (00:00:00) - für Termine „ganztägig“.

Parameter im Einzelnen

id

id liest aus einem anderen Datensatz statt aus dem laufenden - record_id oder Slug, genau wie in der URL:

(CMS:DATETIME changed_at id=1977)
(CMS:DATETIME changed_at id=impressum)

field

field ist der Hauptparameter und darf ohne Schlüssel stehen - beide Zeilen sind gleich:

(CMS:DATETIME field=changed_at)
(CMS:DATETIME changed_at)

useval

useval nimmt statt eines Feldes einen Wert direkt aus dem Template - meist eine PHP-Variable oder ein zuvor mit set abgelegter Wert:

(CMS:DATETIME useval="2024-03-07 14:30:00")
(CMS:DATETIME useval="{$set['wert']}")

format

format ist ein ICU-Muster (d Tag, MM Monat zweistellig, MMMM Monatsname, y Jahr, HH:mm Uhrzeit, EEEE Wochentag). Ohne format entscheidet die Sprache der Seite (im Backend die Locale des Benutzers):

(CMS:DATETIME online_at format="dd.MM.y HH:mm")

Ausgabe: 07.03.2024 14:30

autotime

Nur zusammen mit format: Enthält der Wert keine Uhrzeit (00:00:00), wird der Zeitanteil aus der Ausgabe entfernt:

(CMS:DATETIME event_at format="dd.MM.y HH:mm" autotime=true)

Ausgabe bei 2024-03-07 00:00:00: 07.03.2024 - bei 2024-03-07 14:30:00: 07.03.2024 14:30

timezone

timezone=true hängt den Namen der Zeitzone an, in der der Wert angezeigt wird:

(CMS:DATETIME online_at timezone=true)

Ausgabe: 07.03.2024, 14:30 Europe/Berlin

replace

replace ersetzt Teiltexte im fertig formatierten Wert - Kurzform mit ? als Trenner oder ein Eintrag je Suchtext:

(CMS:DATETIME changed_at replace=", ? um ")
(CMS:DATETIME changed_at replace[, ]=" um " replace[x]="y")

Ausgabe: 07.03.2024 um 14:30

ifempty

ifempty ersetzt die gesamte Ausgabe, wenn die Quelle leer ist; prefix und suffix entfallen dann:

(CMS:DATETIME event_at prefix="<p>" suffix="</p>" ifempty="Termin folgt")

Als leer gelten auch die Platzhalter für „kein Datum“ und „kein Ende“, mit denen camindo CMS etwa ein unbegrenztes offline_at speichert (vor dem 2. Januar 1000 bzw. ab dem 31. Dezember 8999) – mit und ohne format.

instead

instead tauscht den Wert aus, sobald die Quelle nicht leer ist - nützlich, wenn nur das Vorhandensein zählt:

(CMS:DATETIME event_at instead="Termin steht fest" ifempty="-")

prefix

prefix / suffix umschließen den Wert und erscheinen nur, wenn er nicht leer ist - so entsteht kein leeres Stand::

(CMS:DATETIME changed_at prefix="Stand: " suffix="")

suffix

(CMS:DATETIME changed_at suffix=" Uhr")

Siehe prefix.

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['changed'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:DATETIME changed_at set=changed)
<?php if ($set['changed'] !== '') { ?> … <?php echo $set['changed']; ?> … <?php } ?>

← Übersicht

CMS:EMAIL

Versendet eine E-Mail. Prüft auf Wunsch vorab die Pflichtfelder eines Formulars.

(CMS:EMAIL [parameter=wert …])

Methode: Email::cmsEmail()
Mindestens einer von: subject, subjecttemplate, body, bodytemplate
PHP-Schnipsel: include_and_stop (danach)

Parameter

² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Kontaktformular mit Pflichtfeldprüfung und Bestätigungsseite:

<?php $submit = $_POST['submit'] ?? ''; ?>
(CMS:EMAIL
  submit="$submit"
  to="info@example.com"
  fromname="Kontaktformular"
  subject="Kontaktanfrage"
  bodytemplate=contact_mail
  requiredfields="name,email,message"
  successtemplate=contact_thanks
)
(CMS:MESSAGE prefix="<div class=alert>" suffix="</div>")
<form method="post">
  <input name="data[name]"> <input name="data[email]" type="email">
  <textarea name="data[message]"></textarea>
  <button name="submit" value="1">Senden</button>
</form>

Der Ablauf:

1. Beim ersten Aufruf ist submit leer – der Befehl tut nichts, das Formular erscheint.
2. Nach dem Absenden prüft er die Pflichtfelder. Fehlt eines, wird nicht gesendet; CMS:MESSAGE zeigt die Meldung, und das Template läuft weiter – das Formular erscheint erneut.
3. Sonst baut er die E-Mail, versendet sie und bindet successtemplate ein. Die Seite endet danach. Ohne successtemplate läuft das Template einfach weiter.

Versendet wird über das in der Konfiguration eingetragene SMTP-Postfach (email.smtp), ersatzweise über die PHP-Funktion mail() – wie alle E-Mails des CMS. Scheitert der Versand, steht der Grund in var/log/{Datum}_mail.log (Modul Logdateien, Art „Nicht versendete E-Mails“).

Was der Befehl hinterlässt

<input name="data[email]" class="<?php echo in_array('email', $set['email_missing'] ?? []) ? 'error' : ''; ?>">

Meldungen

Fehler landen bei CMS:MESSAGE. Den Text bestimmt message[index], sonst gilt der Standardtext:

Die Standardtexte erscheinen in der Sprache der Seite.

Sicherheit

• Empfänger nie aus dem Formular übernehmen. Steht in to eine Eingabe des Besuchers, kann jeder über Ihr Formular E-Mails an beliebige Adressen schicken. Ist eine der Adressen in to ungültig, sendet der Befehl gar nicht.
• Kontaktformulare drosseln: throttle=true begrenzt die E-Mails je Besucher, formguard=true (mit (CMS:USER_TOKEN formguard=true) im Formular) hält Robots auf: (CMS:EMAIL submit="$submit" to="info@example.com" … throttle=true formguard=true). Bestellbestätigungen und andere E-Mails, deren Empfänger Sie selbst bestimmen, brauchen das nicht.
• Absender: Absender ist immer der Websitebetreiber, nie der Besucher: Viele Mailserver nehmen nur E-Mails an, deren Absender zur eigenen Domain passt. Setzen Sie die Adresse des Besuchers deshalb besser in den Text als in from; ohne from gilt die Absenderadresse aus der Konfiguration.
• Zeilenumbrüche in Betreff, Namen und Adressen werden entfernt – eingeschleuste Kopfzeilen (etwa ein zusätzliches Bcc:) sind damit ausgeschlossen.
• HTML-E-Mails: Eingaben des Besuchers im Body-Template mit (CMS:TEXT useval="{$_POST['data']['…']}" specialchars=true) ausgeben.
• Anhänge nur aus var/download/, var/upload/ und var/modules/ – Konfiguration, Protokolle und Sicherungen lassen sich nicht anhängen.

Parameter im Einzelnen

to

(CMS:EMAIL to="info@example.com" …)
(CMS:EMAIL to[]="info@example.com" to[]="vertrieb@example.com" …)

toname

Gilt nur, wenn genau ein Empfänger angegeben ist:

(CMS:EMAIL to="info@example.com" toname="Beispiel GmbH" …)

from

(CMS:EMAIL from="shop@example.com" …)

Ohne Angabe die Absenderadresse aus der Konfiguration (email.noreply, ersatzweise email.reply). Ist keine davon eingetragen, kann ohne from nicht gesendet werden.

fromname

(CMS:EMAIL fromname="Kontaktformular Beispiel GmbH" …)

contenttype

(CMS:EMAIL contenttype="text/html" bodytemplate=newsletter_html …)

Bei text/html erzeugt das CMS zusätzlich eine Textfassung für E-Mail-Programme ohne HTML-Darstellung.

subject

(CMS:EMAIL subject="Kontaktanfrage" …)

subjecttemplate

Betreff aus einem Template erzeugen (z. B. mit Feldern des laufenden Datensatzes). Tags, Entities und Zeilenumbrüche fallen weg:

(CMS:EMAIL subjecttemplate=order_subject …)

body

(CMS:EMAIL body="Neue Anfrage von {$_POST['data']['name']}" …)

bodytemplate

Nachrichtentext aus einem Template – dort stehen alle CMS-Befehle zur Verfügung, der laufende Datensatz, $set und die Formulardaten in $_POST. Variablen, die Sie im aufrufenden Template mit PHP gesetzt haben, sieht das Body-Template nicht; legen Sie sie bei Bedarf in $set ab.

(CMS:EMAIL contenttype="text/html" bodytemplate=contact_mail …)

contact_mail:

<p>Neue Anfrage von (CMS:TEXT useval="{$_POST['data']['name']}" specialchars=true)
(CMS:TEXT useval="{$_POST['data']['email']}" specialchars=true):</p>
<p>(CMS:TEXT useval="{$_POST['data']['message']}" specialchars=true)</p>

specialchars=true gehört zu HTML-Mails. In einer Textmail (text/plain, Standard) kann Besucher-Text nichts ausführen; specialchars würde dort nur Entities wie & sichtbar machen.

Template-Namen lassen sich wie bei CMS:INCLUDE mit dem Bereich angeben (bereich.name).

paths_absolute

Serverrelative Pfade (/media/…) in src, href, action, background, poster und url(…) des HTML-Bodys absolut machen:

(CMS:EMAIL contenttype="text/html" bodytemplate=newsletter_html paths_absolute=true …)

sender_url

Domain für paths_absolute, wenn nicht Protokoll und Hauptdomain der Instanz gelten sollen; ohne Protokoll gilt das der Instanz:

(CMS:EMAIL paths_absolute=true sender_url="https://www.example.com" …)

debug

E-Mail nur ins Logfile var/log/{Datum}_mail-debug.log schreiben, nicht senden – zum Testen eines Formulars. Der Befehl verhält sich sonst wie beim echten Versand (Pflichtfelder, successtemplate):

(CMS:EMAIL debug=true …)

requiredfields

Pflichtfelder im Request-Array data[…] (bzw. dem über data benannten Array); fehlt eines, wird nicht gesendet und CMS:MESSAGE zeigt die Meldung. Bei Feldern mit mehreren Werten (Checkbox-Gruppe data[themen][]) genügt ein ausgewählter Wert:

(CMS:EMAIL requiredfields="name,email,message" …)

data

Name des Request-Arrays mit den Formulardaten (Standard data, also $_POST['data']):

<input name="form[name]">
(CMS:EMAIL data=form requiredfields="name" …)

submit

Der Befehl läuft nur, wenn submit einen Wert hat – beim ersten Aufruf des Formulars also nicht:

<?php $submit = $_POST['submit'] ?? ''; ?>
(CMS:EMAIL submit="$submit" …)
<button name="submit" value="1">Senden</button>

successtemplate

Nach erfolgreichem Versand wird dieses Template eingebunden und die Seite beendet (ohne CMS:CONTINUE):

(CMS:EMAIL successtemplate=contact_thanks …)

message

Eigene Meldungstexte je Fehlerfall (Indizes siehe Meldungen):

(CMS:EMAIL message[required]="Bitte alle Pflichtfelder ausfüllen." …)

attachment

Dateien relativ zum var-Verzeichnis anhängen – nur aus download/, upload/ und modules/:

(CMS:EMAIL attachment[]="download/agb.pdf" …)

throttle

(CMS:EMAIL throttle=true …)
(CMS:EMAIL throttle=newsletter …)

Ein eigener Name braucht eine Grenze in der Konfiguration (user.throttle.newsletter, Systemadministrator); fehlt sie, gilt die von true.

formguard

(CMS:EMAIL formguard=true …)
<form method="post">(CMS:USER_TOKEN formguard=true) …</form>

← Übersicht

CMS:MEDIA

Erzeugt ein Image-Tag oder gibt den Inhalt einer Mediendatei in Textform aus.

(CMS:MEDIA field [parameter=wert …])

Methode: Cms::cmsMedia()
Ohne Schlüssel: der erste Wert ohne = gilt als field
Mindestens einer von: field, useval

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Quelle ist ein Upload-Feld. Ohne subfield entsteht ein <img>-Tag mit den gespeicherten Maßen, alt ist der ursprüngliche Dateiname:

(CMS:MEDIA image)

Ausgabe: <img src="/media/1/12/1977,strand.jpg?v=3" alt="strand.jpg" width="1200" height="800">

Der Pfad trägt den ursprünglichen Dateinamen hinter einem Komma (sprechende URL für Browser und Suchmaschinen, als Slug ohne Endung); die Datei selbst heißt 1977.jpg – eine Rewrite-Regel im Medienverzeichnis wirft den Namensteil ungeprüft weg. ?v= trägt die Versionsnummer der Datei: nach einem neuen Upload ändert sich die Adresse, der Browser lädt die Datei neu.

Mit subfield wird ein Einzelwert der Datei ausgegeben - so lassen sich beliebige Tags bauen oder Downloads verlinken:

<a href="(CMS:MEDIA document subfield=path)">
  (CMS:MEDIA document subfield=filename) ((CMS:MEDIA document subfield=size))
</a>

Ausgabe: <a href="/media/1/13/1977,agb.pdf?v=3">agb.pdf (123.5 KB)</a>

Kein Bild hochgeladen? ifempty liefert den Ersatz - prefix/suffix entfallen dann:

(CMS:MEDIA image width=300 height="" prefix="<figure>" suffix="</figure>" ifempty="<img src='/static/placeholder.png'>")

Verfügbare subfield-Werte

url ist ein Alias für path (Schreibweise aus C9-Vorabversionen). Bei mehrsprachigen Upload-Feldern liefert der Befehl die Datei der aktuellen Sprache bzw. die der Hauptsprache als Fallback (1977_2,strand.jpg).

Geschützte Dateien (Feldoption „nur für angemeldete Frontend-User“): Der Verweis zeigt automatisch auf /file.php, das die Frontend-Session prüft. auth=true erzwingt diesen Weg auch für ungeschützte Felder, download="name" bietet die Datei zum Herunterladen an.

Parameter im Einzelnen

id

id liest aus einem anderen Datensatz statt aus dem laufenden - record_id oder Slug, genau wie in der URL:

(CMS:MEDIA image id=1977)
(CMS:MEDIA image id=impressum)

field

Name des Upload-Feldes; darf ohne Schlüssel stehen:

(CMS:MEDIA field=image)
(CMS:MEDIA image)

subfield

Einzelwert statt <img>-Tag (Liste siehe oben):

<img src="(CMS:MEDIA image subfield=path)" alt="(CMS:TEXT title specialchars=true)" loading="lazy">
Dateityp: (CMS:MEDIA document subfield=mime_type)

Einzelwerte über subfield werden nicht maskiert. path enthält nur URL-taugliche Zeichen und kann direkt in src oder href stehen. Den ursprünglichen Dateinamen (filename) wählt der Hochladende – in einem Attribut maskieren Sie ihn über CMS:TEXT:

(CMS:MEDIA document subfield=filename set=dateiname)
<a href="(CMS:MEDIA document subfield=path)" title="(CMS:TEXT useval="{$set['dateiname']}" specialchars=true lbrconvert=false)">…</a>

path und file unterscheiden sich im Zweck - Verweis für den Browser gegenüber Zugriff durch PHP:

(CMS:MEDIA document subfield=path)      /media/1/13/1977,agb.pdf?v=3
(CMS:MEDIA document subfield=file)      /var/www/example/public/media/1/13/1977.pdf

(CMS:MEDIA document subfield=file set=file)
<?php echo filesize($set['file']) > 5e6 ? 'große Datei' : ''; ?>

auth

Verweis über /file.php erzwingen - etwa, damit eine Vorschau denselben Zugriffsweg nimmt wie das geschützte Original:

<p>Vorschau: (CMS:MEDIA thumb)</p>
<p>Original (nur angemeldet): (CMS:MEDIA image auth=true)</p>

Bei Feldern mit der Option „nur für angemeldete Frontend-User“ gilt das automatisch.

download

Datei zum Herunterladen anbieten; download ist der Dateiname beim Speichern, die Endung wird ergänzt:

<a href="(CMS:MEDIA document subfield=path download="AGB-2026")">AGB herunterladen</a>

Ausgabe: <a href="/file.php?file=13/1977&v=2&download=AGB-2026">AGB herunterladen</a>

width

Breite des <img>-Tags; ohne Angabe die gespeicherte Bildbreite. Ein leerer Wert lässt das Attribut weg, der Browser rechnet dann proportional:

(CMS:MEDIA image width=300 height="")

Ausgabe: <img src="/media/1/12/1977,strand.jpg?v=3" alt="strand.jpg" width="300">

height

(CMS:MEDIA image width="" height=200)
(CMS:MEDIA image width="100%" height="")

attr

Weitere Attribute; Schlüssel = Attributname. Vorhandene (src, alt, width, height) lassen sich damit überschreiben:

(CMS:TEXT title striptags=true ampconvert=false lbrconvert=false set=title)
(CMS:MEDIA image attr[alt]="{$set['title']}" attr[class]="hero" attr[loading]="lazy")

CMS:MEDIA maskiert alle Attributwerte des <img>-Tags selbst mit htmlspecialchars – auch die aus attr. Übergeben Sie deshalb unmaskierten Text, ohne specialchars=true; sonst wird doppelt maskiert und aus & wird sichtbar &. Aus dem Attributnamen entfernt der Befehl alle Zeichen außer Buchstaben, Ziffern, _ und -.

autoformat

Betrifft nur subfield=size: Standardmäßig lesbar (123.5 KB), mit false in Bytes:

(CMS:MEDIA document subfield=size)                   123.5 KB
(CMS:MEDIA document subfield=size autoformat=false)  126464

instead

Fester Text, wenn eine Datei vorhanden ist (das Tag bzw. der Einzelwert selbst wird nicht ausgegeben):

Bild: (CMS:MEDIA image instead="vorhanden" ifempty="fehlt")

ifempty

Ersatz, wenn keine Datei vorhanden ist (bzw. der Einzelwert leer oder 0):

(CMS:MEDIA image ifempty="<img src='/static/placeholder.png' alt=''>")
(CMS:MEDIA image subfield=width ifempty="unbekannt")

prefix

prefix / suffix umschließen den Wert und erscheinen nur, wenn er nicht leer ist - so entsteht kein leeres <figure></figure>:

(CMS:MEDIA image prefix="<figure>" suffix="</figure>")

suffix

(CMS:MEDIA image suffix="</figure>")

Siehe prefix.

useval

Statt eines Feldes ein Datei-Array übergeben - z. B. aus einem mit CMS:SAVEDATA gesicherten Datensatz. Parameterwerte im Template sind immer Strings; ein Array lässt sich deshalb nur per direktem PHP-Aufruf der Methode übergeben. field darf dabei nicht angegeben sein – es hätte Vorrang und läse das Feld des laufenden Datensatzes. Weil das Datei-Array die Feld-Id nicht enthält, gehören field_id und record_id ausdrücklich hinein:

(CMS:SAVEDATA author id="{$cms['author_id']}")
<?php $this->cms->cmsMedia([
    'useval' => $GLOBALS['author']['portrait'] + ['record_id' => $GLOBALS['author']['record_id'], 'field_id' => 17],
    'width'  => 80, 'height' => '',
]); ?>

17 steht hier für die Id des Upload-Feldes portrait. Einfacher ist fast immer (CMS:MEDIA portrait id="{$cms['author_id']}") - id lädt den fremden Datensatz direkt und findet das Feld über seinen Namen.

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['img'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:MEDIA image subfield=path set=img)
<?php if ($set['img'] !== '') { ?> … <?php echo $set['img']; ?> … <?php } ?>

← Übersicht

CMS:MESSAGE

Erzeugt eine Textausgabe aus aktuellen Fehlermeldungen.

(CMS:MESSAGE useval [parameter=wert …])

Methode: Cms::cmsMessage()
Ohne Schlüssel: der erste Wert ohne = gilt als useval

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Gibt die Meldungen aus, die Befehle dieser Seite abgelegt haben - typischerweise Feldfehler von CMS:USER_INPUT, CMS:USER_LOGIN oder CMS:USER_REGISTER. Ohne Meldung bleibt der Befehl still:

(CMS:USER_LOGIN container=members submit="$submit" successtemplate=welcome)
<p class="error">(CMS:MESSAGE)</p>

Mehrere Meldungen werden mit <br> getrennt. Eine Umrahmung gibt es nur über prefix/suffix – sie erscheint nur, wenn es Meldungen gibt:

(CMS:MESSAGE prefix="<div class=alert>" suffix="</div>")

Parameter im Einzelnen

useval

Eigenen Text statt der Systemmeldungen ausgeben (die Meldungen werden dann ignoriert; ist useval leer, erscheinen wieder die Meldungen):

(CMS:MESSAGE useval="{$set['hinweis']}" prefix="<p class=hint>" suffix="</p>")

Der Text wird unverändert ausgegeben. Setzen Sie hier keine Werte aus dem Request ($_GET, $_POST) ein – dafür gibt es (CMS:TEXT useval="…" specialchars=true).

prefix

(CMS:MESSAGE prefix="<div class=alert>" suffix="</div>")

Ohne Angabe werden die Meldungen ohne Umrahmung ausgegeben.

suffix

(CMS:MESSAGE prefix="<ul class=errors><li>" suffix="</li></ul>")

ifempty

Text, wenn keine Meldung vorliegt:

(CMS:MESSAGE ifempty="Alles in Ordnung.")

instead

Fester Text, sobald eine Meldung vorliegt - wenn der Wortlaut nicht angezeigt werden soll:

(CMS:MESSAGE instead="Bitte prüfen Sie Ihre Eingaben.")

set

Meldungen für PHP bereitstellen, etwa um sie neben dem jeweiligen Feld zu zeigen:

(CMS:MESSAGE set=errors)
<?php if ($set['errors'] !== '') { ?><div class="alert"><?php echo $set['errors']; ?></div><?php } ?>

← Übersicht

CMS:NUMBER

Gibt einen Zahlenwert formatiert aus.

(CMS:NUMBER field [parameter=wert …])

Methode: Cms::cmsNumber()
Ohne Schlüssel: der erste Wert ohne = gilt als field
Mindestens einer von: field, useval

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Gibt einen Zahlenwert formatiert aus. Ohne weitere Parameter erscheint die Zahl so, wie sie gespeichert ist - mit Punkt als Dezimaltrenner und ohne Tausendertrennzeichen:

(CMS:NUMBER price)                                        1234.5
(CMS:NUMBER price decimal="," thousands_separator=".")    1.234,5
(CMS:NUMBER price decimals=2 decimal="," thousands_separator="." suffix=" €")   1.234,50 €

Rechnen vor der Ausgabe (mul, add), Dateigrößen lesbar machen (sizefactor):

(CMS:NUMBER price mul=1.19 decimals=2 decimal="," suffix=" € inkl. MwSt.")
(CMS:NUMBER filesize sizefactor=1024)                     15.2 MB

Ergibt die Rechnung 0, erscheint 0 (formatiert, z. B. 0,00 mit decimals=2):

(CMS:NUMBER useval="{$a}" add=-1)                          0  (bei $a = 1)

Sobald prefix, suffix oder ifempty angegeben ist, gilt der Wert 0 dagegen als leer - eine Preisangabe mit 0 bleibt also ohne €. Maßgeblich ist der Zahlenwert nach mul/add, nicht der formatierte Text: auch 0.00 (mit decimals oder format) gilt dann als leer. Eine leere Quelle (Feld ohne Inhalt, leeres useval) ergibt immer eine leere Ausgabe - auch mit mul/add.

Parameter im Einzelnen

id

id liest aus einem anderen Datensatz statt aus dem laufenden - record_id oder Slug, genau wie in der URL:

(CMS:NUMBER price id=1977)
(CMS:NUMBER price id=impressum)

field

field ist der Hauptparameter und darf ohne Schlüssel stehen - beide Zeilen sind gleich:

(CMS:NUMBER field=price)
(CMS:NUMBER price)

useval

useval nimmt statt eines Feldes einen Wert direkt aus dem Template - meist eine PHP-Variable oder ein zuvor mit set abgelegter Wert:

(CMS:NUMBER useval="{$this->db->num_rows_unlimited}")
(CMS:NUMBER useval="{$set['wert']}")

Komma als Dezimaltrenner wird verstanden: useval="3,5" ergibt 3.5.

ifempty

Mit ifempty gilt auch der Zahlenwert 0 als leer - egal, wie er formatiert würde:

(CMS:NUMBER stock ifempty="ausverkauft" suffix=" Stück")

Ausgabe bei stock = 0: ausverkauft - bei 12: 12 Stück

instead

instead ersetzt die Quelle (nicht das Ergebnis), wenn sie nicht leer ist - Rechnung und Formatierung laufen danach auf dem neuen Wert:

(CMS:NUMBER price instead=99 decimal=",")

mul

(CMS:NUMBER price mul=1.19 decimals=2 decimal="," suffix=" €")   Bruttopreis
(CMS:NUMBER share mul=100 suffix=" %")                           0.25 → 25 %

add

(CMS:NUMBER price add=4.90 decimals=2 decimal="," suffix=" € inkl. Versand")

mul wird vor add angewendet: Ergebnis = Quelle × mul + add.

format

sprintf()-Muster; es bestimmt die Ausgabe allein, decimal, thousands_separator, decimals und nullcent bleiben dann außen vor. Für Preise mit Dezimalkomma und Tausenderpunkt ist deshalb decimals der richtige Parameter, format für Sonderfälle wie führende Nullen:

(CMS:NUMBER price format="%.2f")        1234.50
(CMS:NUMBER position format="%03d")     007

decimals

Feste Anzahl Nachkommastellen, kaufmännisch gerundet - die Trennzeichen aus decimal und thousands_separator gelten weiter:

(CMS:NUMBER price decimals=2 decimal="," thousands_separator=".")

Ausgabe bei 1234.5: 1.234,50 - bei 19.999: 20,00

Ein Betrag in Cent (Feldtyp Währung) wird mit mul=0.01 zu Euro:

(CMS:NUMBER cur_preis mul=0.01 decimals=2 decimal="," suffix=" €")

decimal

(CMS:NUMBER price decimal=",")

Ausgabe: 1234,5

thousands_separator

(CMS:NUMBER views thousands_separator=".")
(CMS:NUMBER views thousands_separator=" ")

Ausgabe: 1.234.567 bzw. 1 234 567

nullcent

Ersatz für fehlende Nachkommastellen (ohne Angabe: keiner) - für Preise, die immer zwei Stellen zeigen sollen:

(CMS:NUMBER price decimal="," nullcent="00" suffix=" €")

Ausgabe bei 1234: 1234,00 € - bei 1234.5 bleibt 1234,5 € (nur fehlende Nachkommastellen werden ersetzt; für festes Runden decimals=2 nutzen).

replace

replace ersetzt Teiltexte im fertig formatierten Wert - Kurzform mit ? als Trenner oder ein Eintrag je Suchtext:

(CMS:NUMBER price replace=".00?")
(CMS:NUMBER price replace[.00]="" replace[x]="y")

Ausgabe bei 12.00: 12

prefix

Erscheint nur, wenn der formatierte Wert weder leer noch 0 ist:

(CMS:NUMBER discount prefix="- " suffix=" %")

suffix

(CMS:NUMBER price suffix=" €")

Siehe prefix.

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['price'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:NUMBER price set=price)
<?php if ($set['price'] !== '') { ?> … <?php echo $set['price']; ?> … <?php } ?>

Der gespeicherte Wert ist ein String in der formatierten Schreibweise.

sizefactor

Dateigröße lesbar machen (Bytes → KB / MB / GB); 1024 für binäre, 1000 für dezimale Einheiten:

(CMS:NUMBER filesize sizefactor=1024)      15.2 MB
(CMS:NUMBER filesize sizefactor=1000)      15.9 MB

Für Upload-Felder geht das auch direkt mit (CMS:MEDIA image subfield=size).

← Übersicht

CMS:RAW

Gibt einen Inhalt unformatiert aus.

(CMS:RAW field [parameter=wert …])

Methode: Cms::cmsRaw()
Ohne Schlüssel: der erste Wert ohne = gilt als field

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Gibt den Feldinhalt ohne jede Aufbereitung aus - kein Maskieren, keine Umwandlung von Zeilenumbrüchen, keine Entities. Gedacht für Felder, die fertiges HTML enthalten (Editor-Felder) oder für Werte, die unverändert in PHP/JavaScript landen sollen:

<div class="content">(CMS:RAW html_text)</div>

Dem Inhalt muss man vertrauen: Was ein Redakteur ins Feld schreibt, landet unverändert auf der Seite – bis auf aktive Inhalte (<script>, <iframe>, Event-Handler, javascript:-Links), die camindo CMS schon beim Speichern und beim Lesen aus der Datenbank entfernt. Für Texte aus Benutzereingaben (ugc-Bereiche) CMS:TEXT mit specialchars=true verwenden.

Die Ausgabeparameter ifempty, instead, prefix, suffix und set wirken wie bei allen Ausgabebefehlen.

Parameter im Einzelnen

id

id liest aus einem anderen Datensatz statt aus dem laufenden - record_id oder Slug, genau wie in der URL:

(CMS:RAW html_text id=1977)
(CMS:RAW html_text id=impressum)

field

field ist der Hauptparameter und darf ohne Schlüssel stehen - beide Zeilen sind gleich:

(CMS:RAW field=html_text)
(CMS:RAW html_text)

ifempty

ifempty ersetzt die gesamte Ausgabe, wenn die Quelle leer ist; prefix und suffix entfallen dann:

(CMS:RAW html_text prefix="<p>" suffix="</p>" ifempty="<p>Kein Inhalt.</p>")

instead

instead tauscht den Wert aus, sobald die Quelle nicht leer ist - nützlich, wenn nur das Vorhandensein zählt:

(CMS:RAW html_text instead="vorhanden" ifempty="-")

prefix

prefix / suffix umschließen den Wert und erscheinen nur, wenn er nicht leer ist - so entsteht kein leeres <section></section>:

(CMS:RAW html_text prefix="<section>" suffix="</section>")

suffix

(CMS:RAW html_text suffix="</section>")

Siehe prefix.

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['html'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:RAW html_text set=html)
<?php if ($set['html'] !== '') { ?> … <?php echo $set['html']; ?> … <?php } ?>

← Übersicht

CMS:SNIPPET

Gibt ein Snippet (Textbaustein) in der Sprache des Aufrufs aus.

(CMS:SNIPPET key [parameter=wert …])

Methode: Cms::cmsSnippet()
Ohne Schlüssel: der erste Wert ohne = gilt als key

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden. […] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Feste Beschriftungen einer Website – „Weiterlesen“, „In den Warenkorb“, Überschriften von Listen – pflegt die Redaktion als Snippets der Instanz in allen Sprachen (Modul Snippets, siehe Handbuch für Administratoren). Das Template gibt sie mit CMS:SNIPPET aus, immer in der Sprache des Aufrufs; fehlt eine Übersetzung, erscheint der englische Text (en_US):

<a class="more" href="(CMS:URL)">(CMS:SNIPPET custom.weiterlesen)</a>

custom. meint das Snippet-Set der Instanz. Ohne Präfix sind die Snippets des Cores gemeint – im Frontend nur die allgemeinen, nicht die der Backend-Oberfläche.

In einem Attribut maskieren Sie den Text mit specialchars=true:

<button aria-label="(CMS:SNIPPET custom.menue specialchars=true)">…</button>

Platzhalter. param[name] ersetzt {name} im Snippet. So bleibt die Wortstellung Sache der Übersetzung – etwa das Währungszeichen vor oder hinter dem Betrag:

Snippet custom.preis:   en "€{betrag}"   de "{betrag} €"
(CMS:NUMBER preis mul=0.01 format="%.2f" set=betrag)
(CMS:SNIPPET custom.preis param[betrag]="{$set['betrag']}")

Beginnt ein Snippet mit einer ICU-Nachricht ({anzahl, plural, one {# Artikel} other {# Artikel}}), füllt param deren Werte:

(CMS:SNIPPET custom.treffer param[anzahl]="{$set['count']}")

Schlüssel aus dem Datensatz. Der Schlüssel darf PHP-Variablen enthalten – etwa, um einen Auswahlwert zu übersetzen:

(CMS:SNIPPET "custom.status_{$cms['status']}" ifempty="–")

Gibt es das Snippet nicht, steht der Schlüssel selbst auf der Seite – so fällt ein fehlender Text beim Entwickeln auf. ifempty gibt stattdessen einen Ersatz aus.

Innerhalb eines Parameters eines anderen Befehls lässt sich CMS:SNIPPET nicht verschachteln; dort liefert {$this->cms->snippet('custom.weiterlesen')} den Text:

(CMS:TEXT teaser suffix=" {$this->cms->snippet('custom.weiterlesen')}")

← Übersicht

CMS:TEXT

Gibt einen Text formatiert aus.

(CMS:TEXT field [parameter=wert …])

Methode: Cms::cmsText()
Ohne Schlüssel: der erste Wert ohne = gilt als field
Mindestens einer von: field, useval, id

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Der Standardbefehl für Feldinhalte. Er liest ein Feld des laufenden Datensatzes, wandelt Zeilenumbrüche in <br>, maskiert alleinstehende & und gibt das Ergebnis aus:

<h1>(CMS:TEXT title)</h1>
<p>(CMS:TEXT text)</p>

Ein Feld nur ausgeben, wenn es gefüllt ist - prefix/suffix erscheinen nur bei nicht leerem Wert:

(CMS:TEXT teaser prefix="<p class=teaser>" suffix="</p>")

Wert für PHP zwischenspeichern statt ausgeben:

(CMS:TEXT title set=title)
<title><?php echo $set['title']; ?> – Beispiel GmbH</title>

Statuswert in Text übersetzen:

(CMS:TEXT status_id if[0]="online" if[1]="gesperrt" if[2]="unbestätigt" else="unbekannt")

Reihenfolge der Verarbeitung: Quelle → if/else → replace → trim → striptags → limit → (markdown bzw. urlencode beenden hier) → entitydecode → specialchars bzw. ampconvert → urlconvert / emailconvert → lbrconvert → iso/charset → ifempty / instead / prefix / suffix → Ausgabe oder set.

Parameter im Einzelnen

id

id liest aus einem anderen Datensatz - record_id oder Slug, wie in der URL. Nur bei CMS:TEXT darf id allein stehen: dann wird das Feld text gelesen. Wie in der URL muss der Datensatz veröffentlicht sein (freigegeben, Veröffentlichungsdatum erreicht; ein abgelaufener bleibt lesbar), sonst ist der Wert leer – auch in der Vorschau des Backends.

(CMS:TEXT title id=1977)          Titel des Datensatzes 1977
(CMS:TEXT id=impressum)           Feld "text" des Datensatzes mit dem Slug "impressum"

field

field ist der Hauptparameter und darf ohne Schlüssel stehen - beide Zeilen sind gleich:

(CMS:TEXT field=title)
(CMS:TEXT title)

useval

useval nimmt statt eines Feldes einen Wert direkt aus dem Template - meist eine PHP-Variable oder ein zuvor mit set abgelegter Wert:

(CMS:TEXT useval="{$_GET['q']}" specialchars=true)
(CMS:TEXT useval="{$set['wert']}")

Werte aus dem Request ($_GET, $_POST) immer mit specialchars=true ausgeben – sonst kann ein präparierter Link beliebiges HTML und Script in die Seite setzen.

Damit lassen sich die Text-Filter (striptags, specialchars, limit …) auch auf fremde Werte anwenden.

ifempty

ifempty ersetzt die gesamte Ausgabe, wenn die Quelle leer ist; prefix und suffix entfallen dann:

(CMS:TEXT teaser prefix="<p>" suffix="</p>" ifempty="Kein Teaser vorhanden.")

Achtung: Ist die Quelle leer, werden auch alle Umwandlungen übersprungen - der ifempty-Text wird unverändert ausgegeben.

instead

instead tauscht den Wert aus, sobald die Quelle nicht leer ist - nützlich, wenn nur das Vorhandensein zählt:

(CMS:TEXT image instead="✔ Bild vorhanden" ifempty="-")

entitydecode

Standardmäßig werden Entities (&, ä, –) zurück in Zeichen gewandelt. Für Inhalte, die die Entities behalten sollen (z. B. für XML-Feeds):

(CMS:TEXT text entitydecode=false)

trim

(CMS:TEXT title trim=true prefix="[" suffix="]")

Ausgabe: [Hallo Welt] statt [ Hallo Welt ]

striptags

HTML- und Script-Tags entfernen, etwa für Teaser aus einem HTML-Feld oder für Meta-Tags. Jedes Tag wird durch ein Leerzeichen ersetzt (aus <p>a</p><p>b</p> wird a b), der Text zwischen den Tags bleibt stehen:

<meta name="description" content="(CMS:TEXT text striptags=true limit=160 lbrconvert=false)">

if

Wertetabelle: Trifft der Wert einen Schlüssel, wird der Eintrag zur neuen Quelle. Zwei Schreibweisen - Unterschlüssel oder Kurzform mit Fragezeichen:

(CMS:TEXT status_id if[0]="online" if[1]="gesperrt")
(CMS:TEXT status_id if="0?online" if[]="1?gesperrt")

Nicht getroffene Werte bleiben unverändert - außer else ist angegeben.

Enthält der Ersatztext eines Ziffern-Schlüssels selbst ein Fragezeichen, nehmen Sie die Kurzform: if[]="1?Wirklich?". Bei if[1]="Wirklich?" wäre nicht zu erkennen, ob 1 der Suchwert ist oder die Kurzform Wirklich → `gemeint war (in PHP sind beide Schreibweisen der Schlüssel1). Für Text-Schlüssel (if[aktiv]="Ja?"`) gilt das nicht.

else

(CMS:TEXT status_id if[0]="online" else="nicht online")

Ausgabe bei status_id = 2: nicht online

replace

Teiltexte in der Quelle ersetzen - Kurzform mit ? oder ein Eintrag je Suchtext:

(CMS:TEXT text replace="\n?<br><br>" lbrconvert=false)
(CMS:TEXT title replace[GmbH]="Gesellschaft mbH" replace[&]="und")

Wie bei if gilt: Ersatztexte mit Fragezeichen für einen Ziffern-Suchtext in der Kurzform schreiben (replace[]="0?null?").

limit

Text auf eine Zeichenzahl kürzen; ein angehängtes s kürzt am letzten Wortende („soft“). Angehängt wird das Snippet ellipsis (…):

<p>(CMS:TEXT text striptags=true limit=200s)</p>
<td>(CMS:TEXT title limit=30)</td>

lbrconvert

Standardmäßig werden Zeilenumbrüche zu <br>. Für Inhalte in <pre>, in Attributen oder in JavaScript abschalten:

<pre>(CMS:TEXT code lbrconvert=false)</pre>

specialchars

Alle Sonderzeichen maskieren (< → <, " → " …) - für Attribute und für Inhalte, die kein HTML enthalten dürfen:

<input value="(CMS:TEXT title specialchars=true lbrconvert=false)">

urlconvert

Adressen (http://…, https://…, www.…) im Text klickbar machen:

(CMS:TEXT text urlconvert=true target=_blank urllimit=24)

Ausgabe: <a href="https://example.com/sehr/lange/adresse" target="_blank">https://example.com/sehr…</a>

emailconvert

E-Mail-Adressen verlinken; encrypt setzt den Link per JavaScript zusammen, sodass die Adresse nicht im Quelltext steht. Das <script> dafür trägt die Nonce der Seite und läuft deshalb auch unter einer durchgesetzten Script-Policy (CMS:CSP):

(CMS:TEXT contact emailconvert=true)
(CMS:TEXT contact emailconvert=encrypt emailtext="E-Mail schreiben")

emaillimit

Sichtbaren Teil einer verlinkten Adresse kürzen:

(CMS:TEXT contact emailconvert=true emaillimit=12)

Ausgabe: <a href="mailto:redaktion@example.com">redaktion@ex…</a>

emailtext

Fester Linktext statt der Adresse (nur mit emailconvert):

(CMS:TEXT contact emailconvert=true emailtext="Kontakt aufnehmen")

target

Link-Target für die von urlconvert erzeugten Links:

(CMS:TEXT text urlconvert=true target=_blank)

markdown

Gibt ein Feld aus, das Markdown enthält – etwa eines mit der Extension Markdown (visuell) – und wandelt es in HTML um:

<div class="text">(CMS:TEXT text markdown=true)</div>

Umgewandelt wird mit Parsedown; HTML im Text wird maskiert, Links auf javascript: und ähnliche Ziele werden entschärft. Zusätzlich zum üblichen Markdown versteht der Parameter die Formate der Extension Markdown (visuell):

markdown beendet die Verarbeitung: entitydecode, specialchars, lbrconvert, urlconvert usw. entfallen. prefix, suffix, ifempty und set wirken wie gewohnt.

urlencode

Den Wert als URL-Bestandteil kodieren. Alle weiteren Umwandlungen entfallen dann:

<a href="/suche?q=(CMS:TEXT title urlencode=true)">ähnliche Artikel</a>

Ausgabe: /suche?q=Hallo%20Welt

urllimit

Sichtbare Länge automatisch verlinkter Adressen (Standard 80 Zeichen, 0 = ungekürzt):

(CMS:TEXT text urlconvert=true urllimit=30)

ampconvert

Standardmäßig wird ein alleinstehendes & zu &, vorhandene Entities bleiben. Abschalten, wenn der Inhalt bereits vollständig maskiert ist:

(CMS:TEXT html_snippet ampconvert=false)

prefix

prefix / suffix umschließen den Wert und erscheinen nur, wenn er nicht leer ist - so entsteht kein leeres <p class=teaser></p>:

(CMS:TEXT teaser prefix="<p class=teaser>" suffix="</p>")

suffix

(CMS:TEXT author_name suffix=" (Autor)")

Siehe prefix.

iso

Ausgabe nach ISO-8859-1 umkodieren (Kurzform für charset=ISO-8859-1), etwa für alte Schnittstellen:

(CMS:TEXT title iso=true)

charset

(CMS:TEXT title charset=windows-1252)

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['title'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:TEXT title set=title)
<?php if ($set['title'] !== '') { ?> … <?php echo $set['title']; ?> … <?php } ?>

← Übersicht

CMS:TIME

Gibt die Uhrzeit eines Datums- oder Zeitwertes formatiert aus.

(CMS:TIME field [parameter=wert …])

Methode: Cms::cmsTime()
Ohne Schlüssel: der erste Wert ohne = gilt als field
Mindestens einer von: field, useval

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Gibt nur die Uhrzeit eines Datums-/Zeitwertes aus:

(CMS:TIME event_at)                    14:30
(CMS:TIME event_at format="HH:mm:ss")  14:30:00
(CMS:TIME event_at suffix=" Uhr")      14:30 Uhr

Ohne format werden volle Minuten ohne Sekunden gezeigt.

Parameter im Einzelnen

id

id liest aus einem anderen Datensatz statt aus dem laufenden - record_id oder Slug, genau wie in der URL:

(CMS:TIME event_at id=1977)
(CMS:TIME event_at id=impressum)

field

field ist der Hauptparameter und darf ohne Schlüssel stehen - beide Zeilen sind gleich:

(CMS:TIME field=event_at)
(CMS:TIME event_at)

useval

useval nimmt statt eines Feldes einen Wert direkt aus dem Template - meist eine PHP-Variable oder ein zuvor mit set abgelegter Wert:

(CMS:TIME useval="2024-03-07 14:30:00")
(CMS:TIME useval="{$set['wert']}")

format

format ist ein ICU-Muster (d Tag, MM Monat zweistellig, MMMM Monatsname, y Jahr, HH:mm Uhrzeit, EEEE Wochentag). Ohne format entscheidet die Sprache der Seite (im Backend die Locale des Benutzers):

(CMS:TIME online_at format="HH:mm")

Ausgabe: 14:30

h:mm a ergibt die 12-Stunden-Schreibweise (2:30 PM).

timezone

(CMS:TIME event_at timezone=true)

Ausgabe: 14:30 Europe/Berlin

replace

replace ersetzt Teiltexte im fertig formatierten Wert - Kurzform mit ? als Trenner oder ein Eintrag je Suchtext:

(CMS:TIME event_at replace=":?.")
(CMS:TIME event_at replace[:]="." replace[x]="y")

Ausgabe: 14.30

ifempty

ifempty ersetzt die gesamte Ausgabe, wenn die Quelle leer ist; prefix und suffix entfallen dann:

(CMS:TIME event_at prefix="<p>" suffix="</p>" ifempty="ganztägig")

instead

instead tauscht den Wert aus, sobald die Quelle nicht leer ist - nützlich, wenn nur das Vorhandensein zählt:

(CMS:TIME event_at instead="mit Uhrzeit" ifempty="-")

prefix

prefix / suffix umschließen den Wert und erscheinen nur, wenn er nicht leer ist - so entsteht kein leeres ab Uhr:

(CMS:TIME event_at prefix="ab " suffix=" Uhr")

suffix

(CMS:TIME event_at suffix=" Uhr")

Siehe prefix.

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['time'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:TIME event_at set=time)
<?php if ($set['time'] !== '') { ?> … <?php echo $set['time']; ?> … <?php } ?>

← Übersicht

CMS:URL

Erzeugt die URL eines Datensatzes.

(CMS:URL id [parameter=wert …])

Methode: Cms::cmsUrl()
Ohne Schlüssel: der erste Wert ohne = gilt als id

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Erzeugt die Frontend-URL eines Datensatzes - mit Slug, wenn er einen hat, sonst mit der record_id; bei mehrsprachigen Auftritten immer mit Sprachsegment:

<a href="(CMS:URL)">(CMS:TEXT title)</a>

Ausgabe: <a href="/de/hallo-welt">Hallo Welt</a>

Auf eine andere Ansicht desselben Datensatzes verweisen (template), auf einen anderen Datensatz (id) oder in eine andere Sprache (lang):

(CMS:URL template=print)                /de/hallo-welt,print
(CMS:URL 1977)                          /de/1977   (Datensatz ohne Slug)
(CMS:URL impressum lang=en)             /en/legal-notice   (Slug der Zielsprache)
(CMS:URL farben/blau)                   /de/farben/blau   (Bereich mit Slug-Prefix)

Führt der Inhaltsbereich des Datensatzes einen Slug-Prefix (Einstellung des Bereichs, z. B. farben), steht er vor dem Slug: /de/farben/blau. Der Präfix gilt je Sprache – mit lang also der Präfix der Zielsprache. Ein id mit Slug meint den Pfad, wie er in der Adresse steht (id=farben/blau); id=blau findet nur einen Datensatz eines Bereichs ohne Präfix.

Sprachumschalter - in einem CMS:SELECT_LANGVERSION-Listentemplate. Die Zeilen dort sind Sprachen, keine Datensätze; CMS:URL ohne id verweist deshalb auf den Datensatz der Seite:

<a href="(CMS:URL lang="{$cms['code']}")">(CMS:TEXT endonym)</a>

Absolute URL für Feeds, E-Mails oder og:url:

<link rel="canonical" href="(CMS:URL absolute=true)">

Parameter im Einzelnen

id

Datensatz, auf den verwiesen wird; ohne Angabe der laufende. Darf ohne Schlüssel stehen:

(CMS:URL 1977)
(CMS:URL id=impressum)
(CMS:URL "{$cms['parent_id']}")       Verweis auf den Elternknoten

area

Verweist auf die Übersicht eines Bereichs: die Adresse, die nur aus seinem Slug-Präfix besteht, in der Sprache des Aufrufs bzw. aus lang. Sie zeigt das Übersichts-Template des Bereichs (Einstellung des Bereichs, „Template-Zuweisung“):

<a href="(CMS:URL area=termine)">Alle Termine</a>        /de/termine
(CMS:URL area=termine lang=en)                         /en/events

Hat der Bereich keinen Slug-Präfix, bleibt die Ausgabe leer. Im Übersichts-Template selbst gibt es keinen laufenden Datensatz; CMS:URL ohne id verweist dort auf dieselbe Übersicht – ein Sprachumschalter mit CMS:SELECT_LANGVERSION funktioniert deshalb wie auf jeder Datensatzseite.

template

Zweiter URL-Teil (nach dem Komma): das Template, mit dem der Datensatz gezeigt werden soll - Name oder bereich.name:

(CMS:URL template=print)
(CMS:URL template=artikeltemplates.print)

Ausgabe: /de/hallo-welt,print

lang

Sprachversion, auf die der Link zeigt (Kürzel aus der Sprachverwaltung); ohne Angabe die Sprache des laufenden Aufrufs:

(CMS:URL lang=en)

Führt der Auftritt nur eine Sprache, steht nie ein Sprachsegment in der URL. Ein Kürzel, das die Website nicht führt, wird übergangen – die URL behält die Sprache des Aufrufs.

Ist das Feld slug des Bereichs mehrsprachig, hat jede Sprachversion ihren eigenen Slug - und die Ziel-URL muss den Slug der Zielsprache tragen, denn aufgelöst wird er in der Sprache der URL. CMS:URL setzt ihn deshalb bei lang selbst ein:

Seite /de/esstisch-nord-180

(CMS:URL lang=en)        /en/dining-table-nord-180
(CMS:URL lang=sv)        /sv/matbord-nord-180

Ist der Slug in der Zielsprache nicht übersetzt, steht dort der Slug der Hauptsprache. Führt die Instanz des Datensatzes die Zielsprache nicht, gilt ihre Hauptsprache. Findet sich kein Slug, steht die record_id in der URL (bei canonical = 1 leitet die Seite von dort auf den Slug um). Je Datensatz und Sprache kostet das eine Datenbankabfrage, die für den Aufruf gemerkt wird; ohne lang oder bei einem einsprachigen Slug-Feld keine.

protocol

Nur zusammen mit absolute bzw. host:

(CMS:URL absolute=true protocol=https)

Ausgabe: https://www.example.com/de/hallo-welt

host

Andere Domain; impliziert absolute=true:

(CMS:URL host=shop.example.com)

Ausgabe: https://shop.example.com/de/hallo-welt (Protokoll der Instanz)

absolute

Vollständige URL mit Protokoll und Haupt-Domain der Instanz:

<link rel="canonical" href="(CMS:URL absolute=true)">

Ausgabe: <link rel="canonical" href="https://www.example.com/de/hallo-welt">

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['url'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:URL  set=url)
<?php if ($set['url'] !== '') { ?> … <?php echo $set['url']; ?> … <?php } ?>

← Übersicht

CMS:XML

Erzeugt eine XML-Deklaration.

(CMS:XML encoding [parameter=wert …])

Methode: Cms::cmsXml()
Ohne Schlüssel: der erste Wert ohne = gilt als encoding

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

encoding und version werden mit htmlspecialchars maskiert ausgegeben.

Anwendung

Erzeugt die XML-Deklaration <?xml version="1.0" encoding="utf-8"?>. Sie muss das erste Zeichen der Ausgabe sein - der Befehl steht deshalb in der ersten Zeile eines Feed-Templates, ohne Leerzeile davor:

(CMS:XML)
<rss version="2.0">
  <channel>
    <title>(CMS:TEXT title specialchars=true lbrconvert=false)</title>
    (CMS:SELECT filter[area]=artikel limit=20 resulttemplate=rss_item)
  </channel>
</rss>

Dazu passend (CMS:HEADER "Content-Type: application/rss+xml; charset=utf-8") – er gibt selbst nichts aus und steht deshalb vor (CMS:XML) in derselben Zeile bzw. ohne Leerzeile dazwischen:

(CMS:HEADER "Content-Type: application/rss+xml; charset=utf-8")(CMS:XML)
<rss version="2.0">

Die Deklaration in ein Template zu tippen ginge nicht: <?xml würde PHP als öffnendes Tag lesen.

Parameter im Einzelnen

encoding

(CMS:XML encoding=ISO-8859-1)

Ausgabe: <?xml version="1.0" encoding="ISO-8859-1"?> - die Inhalte dann mit charset=ISO-8859-1 ausgeben.

version

(CMS:XML version=1.1)

← Übersicht

CMS:ZIP

Bietet die Dateien mehrerer Datensätze als ZIP-Archiv zum Download an und beendet die Seite.

(CMS:ZIP field=feld[,feld…] filter[…]=wert | relation=feld | ids=… | source=basket [parameter=wert …])

Methode: CmsZip::cmsZip() (nachgeladener Dienst, siehe unten)
Ohne Schlüssel: der erste Wert ohne = gilt als field
Pflicht: field und eine Auswahl: filter, relation, ids oder source

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Pressebilder einer Meldung, alle Motive eines Modells, die Auswahl aus einem Leuchtkasten: CMS:ZIP packt die Dateien mehrerer Datensätze in ein Archiv und schickt es dem Besucher als Download. Die Seite endet damit – was danach im Template steht, erscheint nur, wenn kein Archiv entstanden ist.

Der Befehl gehört deshalb an den Anfang eines eigenen Templates, vor jede Ausgabe (das Frontend puffert nicht; nach der ersten Ausgabe meldet der Befehl einen Fehler). Ein eigenständiges Template, das ohne Datensatz aufgerufen wird, eignet sich gut:

(CMS:NUMBER useval="{$_GET['id']}" set=zip_id)
(CMS:ZIP relation=bilder src_id="{$set['zip_id']}" sort="_custom asc"
         field="fil_druck,fil_web" name="Pressebilder" credits="titel,bildunterschrift,bildnachweis")
(CMS:INCLUDE layout_kopf)
(CMS:MESSAGE prefix="<div class='fehler'>" suffix="</div>")
(CMS:INCLUDE layout_fuss)

Verlinkt wird es mit der Id des Datensatzes, dessen Bilder gemeint sind:

(CMS:URL id=0 template=pressebilder_zip set=zip_url)
<a href="<?php echo $set['zip_url']; ?>?id=(CMS:TEXT record_id)">Alle Bilder als ZIP</a>

CMS:NUMBER macht aus dem Adressparameter eine Zahl. Fehlt er, ist src_id leer – dann gibt es keine Dateien, nie „alle“.

Welche Datensätze. Die Auswahl folgt denselben Regeln wie CMS:SELECT: filter, relation mit src_id oder ids. Es zählen nur veröffentlichte Datensätze aus den Instanzen der Website (future und archive wie bei CMS:SELECT). Eine Angabe ist Pflicht – ohne Auswahl entsteht kein Archiv.

Mit source=basket kommen die Datensätze aus dem Warenkorb der Session (CMS:USER_BASKET). Eine eigene Kategorie trennt den Leuchtkasten vom Einkauf:

(CMS:USER_BASKET add variable=bilder category=2)       im Template des Leuchtkastens
(CMS:ZIP source=basket category=2 field=fil_web name=Auswahl)   im Download-Template

Welche Datei. field nennt ein oder mehrere Datei-Felder. Je Datensatz kommt die erste Datei ins Archiv, die der Besucher auch einzeln abrufen dürfte – dieselbe Prüfung wie beim Download über file.php. Ist ein Feld nur für angemeldete Besucher freigegeben, erhält es nur, wer mit einem passenden Profil angemeldet ist; alle anderen bekommen das nächste Feld der Liste. So liefert field="fil_druck,fil_web" der angemeldeten Presse die Druckversion, allen anderen die Web-Version. Datensätze ohne erlaubte Datei werden übergangen.

Dateinamen. filenames legt die Namen im Archiv fest:

Die Endung wird ergänzt, wenn das Muster sie nicht enthält; doppelte Namen erhalten -2, -3 …

Bildnachweise. credits legt eine CREDITS.txt bei – je Datei ihr Name und darunter die Inhalte der genannten Felder, etwa Titel, Bildunterschrift und Fotograf.

Grenzen. Ein Archiv enthält höchstens user.zip.max_files Dateien (Standard 100) mit zusammen user.zip.max_mb MB (Standard 500). maxfiles und maxsize können diese Werte für ein Template nur verkleinern. Überschreitet die Auswahl die Größe, entsteht kein Archiv.

Fertige Archive bleiben user.zip.retention_hours Stunden (Standard 24) im Zwischenspeicher; dieselbe Auswahl wird aus dem Speicher geliefert. Neue Archive sind je Herkunft gedrosselt (user.throttle.zip_ip, Standard 30 je Stunde).

Meldungen. Entsteht kein Archiv, läuft das Template weiter. CMS:MESSAGE gibt die Meldung aus, $set['zip_error'] nennt den Grund:

Die Texte kommen aus den Core-Snippets zip_error_empty, zip_error_limit und zip_error_throttled; message[empty]=… usw. ersetzt sie im Template.

← Übersicht

CMS:RELATION

Wichtig: CMS:RELATION ist nur für Templates des Backends gedacht (Listen-, Trigger-Templates). Es prüft keine Zugriffsrechte: Es liefert die verknüpften Datensätze unabhängig von Instanz- und Bereichsrechten. Wie bei CMS:SELECT zählen aber nur veröffentlichte Ziele (freigegeben, Veröffentlichungsdatum erreicht, Ablaufdatum nicht erreicht) – auch im Backend und in der Vorschau; future, archive und state lockern das. Datensätze im Papierkorb und Arbeitskopien erscheinen nie.

Gibt das Hauptfeld (Titel) aller Datensätze aus, die über ein Verknüpfungsfeld mit dem aktuellen Datensatz verbunden sind – in der bevorzugten Sprachversion des Backends (je Instanz; führt eine Instanz sie nicht, deren Hauptsprache). Datensätze mit leerem Hauptfeld erscheinen nicht.
Für Frontend-Templates nutzen Sie (CMS:SELECT relation=…)

(CMS:RELATION field [parameter=wert …])

Methode: Cms::cmsRelation()
Ohne Schlüssel: der erste Wert ohne = gilt als field

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Gibt das Hauptfeld (Titel) aller Datensätze aus, auf die ein Verweisfeld des laufenden Datensatzes zeigt - in der im Backend festgelegten Reihenfolge:

Themen: (CMS:RELATION topics separator=", ")

Ausgabe: Themen: Reisen, Fotografie, Island

Der Befehl liefert nur die Titel. Sollen die verknüpften Datensätze selbst ausgegeben werden (mit Bild, Link, Datum …), ist CMS:SELECT relation=topics der richtige Weg:

(CMS:SELECT relation=topics resulttemplate=topic_badge)

Rückwärts-Verknüpfungen (welche Artikel zeigen auf dieses Thema?) gehen über CMS:SELECT filter[topics]="{$cms['record_id']}".

Parameter im Einzelnen

field

Name des Verweisfeldes; darf ohne Schlüssel stehen:

(CMS:RELATION field=topics)
(CMS:RELATION topics)

id

Die Verweise eines anderen Datensatzes - per record_id oder Slug, wie in der URL. Der Datensatz muss wie in der URL veröffentlicht sein, sonst bleibt die Ausgabe leer:

(CMS:RELATION topics id=1977)
(CMS:RELATION topics id=island-reise)

limit

(CMS:RELATION topics limit=3 separator=", ")

Es werden höchstens drei Titel ausgegeben - die ersten drei in der Reihenfolge des Verweisfeldes.

future

Auch Ziele, deren Veröffentlichungsdatum noch nicht erreicht ist:

(CMS:RELATION termine future=true separator=", ")

archive

Auch abgelaufene Ziele:

(CMS:RELATION topics archive=true)

state

Alle Ziele unabhängig vom Status – etwa in einem Listen-Template des Backends:

(CMS:RELATION topics state=any future=true archive=true)

lang

Noch nicht umgesetzt - es gilt die Sprache des Aufrufs.

(CMS:RELATION topics lang=en)

separator

(CMS:RELATION topics separator=", ")
(CMS:RELATION topics separator="</li><li>" prefix="<ul><li>" suffix="</li></ul>")

Die zweite Zeile ergibt eine Liste: <ul><li>Reisen</li><li>Fotografie</li></ul>.

prefix

prefix / suffix umschließen den Wert und erscheinen nur, wenn er nicht leer ist - so entsteht kein leeres Themen::

(CMS:RELATION topics prefix="Themen: " suffix="")

suffix

(CMS:RELATION topics suffix=".")

Siehe prefix.

ifempty

ifempty ersetzt die gesamte Ausgabe, wenn die Quelle leer ist; prefix und suffix entfallen dann:

(CMS:RELATION topics prefix="<p>" suffix="</p>" ifempty="keine Themen zugeordnet")

instead

instead tauscht den Wert aus, sobald die Quelle nicht leer ist - nützlich, wenn nur das Vorhandensein zählt:

(CMS:RELATION topics instead="Themen vorhanden" ifempty="-")

set

set gibt nichts aus, sondern legt das Ergebnis unter $set['topics'] für das umgebende PHP oder einen späteren Befehl ab:

(CMS:RELATION topics set=topics)
<?php if ($set['topics'] !== '') { ?> … <?php echo $set['topics']; ?> … <?php } ?>

← Übersicht

CMS:SELECT

Durchsucht die Datenbank anhand der angegebenen (Filter-)Kriterien und liefert die gefundenen Datensätze zurück.

(CMS:SELECT resulttemplate [parameter=wert …])

Methode: Cms::cmsSelect()
Ohne Schlüssel: der erste Wert ohne = gilt als resulttemplate
Mindestens einer von: filter, relation
PHP-Schnipsel: push_result (davor) · include, pop_result (danach)

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.
² mindestens einer der mit ² markierten Parameter muss angegeben werden.

[…] – der Parameter nimmt Unterschlüssel an, z. B. name[schlüssel]=wert.

Anwendung

Fragt Datensätze ab und bindet für die Treffer das resulttemplate ein; darin läuft CMS:RESULT_START … CMS:RESULT_END über die Zeilen. Der Befehl ist der Kern jeder Liste.

Gefunden werden nur veröffentlichte Datensätze: freigegeben (status_id 0), Erscheinungsdatum (online_at) erreicht, Ende (offline_at) nicht erreicht. Die Parameter future, archive und state lockern das je Abfrage - auch in der Vorschau aus dem Backend, die zwar einen unveröffentlichten Datensatz zeigt, aber darin die Listen so, wie die Website sie zeigt.

<h2>Neueste Artikel</h2>
(CMS:SELECT artikel_teaser
  filter[area]=artikel
  sort=online_at order=desc
  limit=10
  noresult="<p>Noch keine Artikel.</p>"
)

Listentemplate artikel_teaser:

<ul>
(CMS:RESULT_START)
  <li><a href="(CMS:URL)">(CMS:TEXT title)</a> – (CMS:DATE online_at)</li>
(CMS:RESULT_END)
</ul>

Häufige Muster:

Ein Datensatz nach Slug:          (CMS:SELECT detail filter[slug]=impressum limit=1)
Nur ein Thema:                    (CMS:SELECT liste filter[area]=artikel filter[topics]=42)
Suche im Titel:                   (CMS:SELECT liste filter[area]=artikel filter[title]="*{$_GET['q']}*")
Zeitraum:                         (CMS:SELECT liste filter[area]=artikel filter[online_at] >= 2026-01-01)
Verknüpfte Datensätze:            (CMS:SELECT topic_badge relation=topics)
Kinder im Baum:                   (CMS:SELECT nav filter[parent_id]="{$cms['record_id']}" filter[depth]=1 sort=position order=asc)
Blätterbare Liste:                (CMS:SELECT liste filter[area]=artikel limit=20 skip="{$_REQUEST['skip']}" count=true)
Suchformular mit Sortierung:      (CMS:SELECT liste filter[area]=artikel limit=20 count=true request="filter[title],sort,order,skip")

Mehrere Werte für dasselbe Feld werden mit OR verknüpft (filter_mode[feld]=AND schaltet um); verschiedene Felder immer mit AND. Vergleichsoperatoren stehen zwischen Schlüssel und Wert (filter[preis] > 100, filter[farbe] != rot) oder direkt vor dem Wert (">100"); Platzhalter und (empty) gehören in den Wert (Hen*) - die vollständige Filtersyntax steht in den Grundlagen.

Ein CMS:SELECT darf innerhalb eines Listentemplates stehen (verschachtelte Listen); das äußere Ergebnis wird automatisch beiseitegelegt und danach fortgesetzt.

Parameter im Einzelnen

resulttemplate

Listentemplate für die Treffer; darf ohne Schlüssel stehen. Name oder bereich.name:

(CMS:SELECT resulttemplate=artikel_teaser filter[area]=artikel)
(CMS:SELECT artikel_teaser filter[area]=artikel)
(CMS:SELECT artikeltemplates.artikel_teaser filter[area]=artikel)

noresulttemplate

Template ohne Treffer - etwa mit einem Suchformular oder Hinweistext:

(CMS:SELECT suchergebnis filter[area]=artikel filter[title]="*{$_GET['q']}*" noresulttemplate=suche_leer)

noresult

Kurzer Text ohne Treffer, ohne eigenes Template:

(CMS:SELECT liste filter[area]=artikel noresult="<p>Keine Einträge.</p>")

filter

Schlüssel = Feldname (eigene Felder, Metafelder wie record_id, status_id, online_at, parent_id, user_id, das virtuelle slug, _default für das Hauptfeld, area für den Bereichsnamen), Wert = Suchwert mit optionalem Operator:

filter[area]=artikel                     Bereich nach Name (Zahl = area_id)
filter[area]=artikel,news                zwei Bereiche (OR)
filter[title]="Hen*"                     beginnt mit
filter[price] > 100                      größer als
filter[price]=">100"                     dasselbe, Operator im Wert
filter[price]=">100 AND <500"            Ausdruck in einem Feld
filter[online_at]=2026                   das ganze Jahr
filter[termin] >= today                  ab heute (0 Uhr, Zeitzone des Aufrufs)
filter[online_at] > utc_now-7d           die letzten sieben Tage, in UTC gerechnet
filter[teaser]="(empty)"                 leer / nicht übersetzt
filter[bild]="(empty)"                   Datei-Feld ohne Datei
filter[topics]=42                        Verweisfeld zeigt auf Datensatz 42
filter[topics]="(empty)"                 Verweisfeld ohne Verweis
filter[relation_any]=42                  irgendein Verweisfeld zeigt auf 42
filter[topics.title]="Island"            Feld des verknüpften Datensatzes
filter[tags]=a filter[tags]=b            zwei Werte, OR (siehe filter_mode)
filter[parent_id]=17 filter[depth]=1     direkte Kinder von 17
filter[parent_id]=null filter[depth]=1   oberste Ebene (Datensätze ohne Elterndatensatz)

filter[depth] ist kein Filter auf die Einrückung eines Datensatzes, sondern gibt an, wie viele Ebenen unterhalb von filter[parent_id] durchsucht werden: 1 = nur direkte Kinder, 2 = bis zu den Enkeln, ohne Angabe = alle Nachkommen. Ohne filter[parent_id] bleibt es wirkungslos (Hinweis beim Speichern des Templates bzw. mit debug=true); filter[depth]=0 liefert keine Datensätze. Der Wert unter „Einzurückende Stellen“ in der Datensatzinfo (0 = oberste Ebene) ist dagegen absolut – die oberste Ebene finden Sie mit filter[parent_id]=null filter[depth]=1.

Textfelder werden nach den Regeln der Sprache verglichen und sortiert, in der gesucht wird: Groß-/Kleinschreibung und Akzente spielen keine Rolle, ß gleich ss, im Deutschen außerdem ä gleich ae (filter[title]="Mue*" findet „Müller“), im Schwedischen dagegen ist ö ein eigener Buchstabe (o findet kein ö). Die Regeln ergeben sich aus dem Sprachkürzel; siehe Grundlagen.

Ein leerer Wert hebt den Filter auf - praktisch für optionale Filter aus dem Request, gefährlich bei Tippfehlern: filter[kategorie]="{$cms['id']}" (den Schlüssel id gibt es nicht, richtig ist record_id) liefert alle Datensätze.

filter_mode

Verknüpfung mehrerer Werte desselben Feldes (Standard OR):

(CMS:SELECT liste filter[area]=artikel filter[tags]=reisen filter[tags]=island filter_mode[tags]=AND)

Findet Artikel, die beide Tags tragen.

filter_op

Vergleichsoperator getrennt vom Wert - gleichwertig zur Schreibweise im Wert und zum Operator zwischen Schlüssel und Wert:

(CMS:SELECT liste filter[area]=artikel filter[price]=100 filter_op[price]=">")
(CMS:SELECT liste filter[area]=artikel filter[price]=">100")
(CMS:SELECT liste filter[area]=artikel filter[price] > 100)

skip

Offset für die Blätterfunktion; meist aus dem Request. skip wirkt nur zusammen mit limit – ohne limit wird es ignoriert, die Abfrage liefert dann alle Treffer ab dem ersten:

(CMS:SELECT liste filter[area]=artikel limit=20 skip="{$_REQUEST['skip']}" count=true)

Die Blätterleiste (CMS:JUMP_LIST) steht im resulttemplate liste.

limit

(CMS:SELECT teaser filter[area]=artikel limit=3)

Höchstens drei Treffer. Ohne limit (oder mit 0) liefert die Abfrage alle Treffer – bei großen Bereichen gehört deshalb immer ein limit dazu. limit ist zugleich die Seitengröße der Blätterbefehle CMS:JUMP_LIST, CMS:JUMP_PREV und CMS:JUMP_NEXT im resulttemplate; ohne limit gibt es keine Blätterleiste.

sort

Sortierfeld, Richtung über order oder direkt im Wert:

sort=online_at order=desc
sort="title asc"
sort=position order=asc                     Reihenfolge aus dem Backend (Baum/Liste)
sort=_default                               Hauptfeld des Bereichs
sort=area                                   nach Bereichsname
sort=author.name                            Feld des verknüpften Datensatzes
sort[]=status_id sort[]=title order[]=asc order[]=asc

order

Richtung zu sort: asc (Standard, sobald sort angegeben ist) oder desc. Ohne sort sortiert der Befehl nach changed_at desc – die zuletzt geänderten zuerst.

(CMS:SELECT liste filter[area]=artikel sort=title order=asc)

lang

Noch nicht umgesetzt - es gilt die Sprache des Aufrufs.

relation

Treffer sind die Datensätze, auf die das Verweisfeld des Quell-Datensatzes zeigt - ohne src_id die des laufenden Datensatzes. Die Reihenfolge des Verweisfeldes liefert sort=_custom; ohne sort gilt die Standardsortierung (changed_at desc):

(CMS:SELECT topic_badge relation=topics)
(CMS:SELECT galerie relation=bilder sort="_custom asc")

Mehrere Feldnamen, kommagetrennt, gelten als ODER; ANY meint irgendein Verweisfeld. sort=_custom und nextof setzen genau einen Feldnamen voraus.

(CMS:SELECT teaser relation="topics,tags")
(CMS:SELECT teaser relation=any)

Die umgekehrte Richtung - Datensätze, die auf den laufenden zeigen:

(CMS:SELECT produkt_liste relation=rel_produkte)
(CMS:SELECT produkt_liste filter[area]=produkte filter[kategorie]="{$cms['record_id']}")
(CMS:SELECT verweis_liste relation=any dest_id="{$cms['record_id']}")

Die erste Zeile gilt für Beziehungsfelder (relation): Sie haben im Zielbereich ein Gegenfeld rel_{bereichsname}. Verweisfelder (pointer) haben keins - ihr Gegenstück ist der Filter auf das Verweisfeld (zweite Zeile). Siehe Jeder Datensatz ist eine Seite.

src_id

Quell-Datensatz für relation, wenn nicht der laufende gemeint ist:

(CMS:SELECT topic_badge relation=topics src_id=1977)
(CMS:SELECT topic_badge relation=topics src_id="{$set['user_id']}")

Ein leerer Wert oder 0 meint ebenfalls den laufenden Datensatz. Gibt es keinen – etwa in einem eigenständigen Template ohne Datensatz –, findet die Abfrage nichts (und nicht etwa alle Datensätze des Bereichs).

dest_id

Die Rückrichtung zu relation: Treffer sind die Datensätze, die über das Verweisfeld – mit relation=any über irgendeines – auf dest_id zeigen, etwa „Wo wird dieses Bild verwendet?":

(CMS:SELECT verweis_liste relation=any dest_id="{$cms['record_id']}")
(CMS:SELECT artikel_liste relation=topics dest_id=1977)

Mit dest_id setzt der Befehl ohne src_id keinen laufenden Datensatz als Quelle ein. Dasselbe als Filterwert, auch für mehrere Ziele: filter[relation_any]="1977,1978".

nextof

Nur zusammen mit relation: statt aller verknüpften Datensätze die Nachbarn des Datensatzes nextof in derselben Verweisliste - die Einträge hinter ihm bei order=asc (Standard), die vor ihm bei order=desc, jeweils in der Reihenfolge der Liste (die Sortierung ist damit festgelegt, sort wird ignoriert). Mit limit=1 ist das der nächste bzw. vorige Datensatz - etwa für „weiter“/„zurück“ in einer Bildergalerie, deren Bilder am Artikel 2422 hängen:

(CMS:SELECT galerie_weiter relation=bilder src_id=2422 nextof="{$cms['record_id']}" limit=1)
(CMS:SELECT galerie_zurueck relation=bilder src_id=2422 nextof="{$cms['record_id']}" order=desc limit=1)

Steht nextof nicht in der Liste, gibt es keine Treffer.

count

Gesamtzahl unabhängig von limit/skip ermitteln - Grundlage für CMS:JUMP_* und für Angaben wie „Treffer 21–40 von 137“:

(CMS:SELECT liste filter[area]=artikel limit=20 skip="{$_REQUEST['skip']}" count=true)

Im resulttemplate liste stehen dann zwei Zahlen: $this->db->num_rows sind die Treffer dieser Seite (höchstens limit), $this->db->num_rows_unlimited alle Treffer der Abfrage:

(CMS:NUMBER useval="{$this->db->num_rows_unlimited}") Treffer
(CMS:RESULT_START) … (CMS:RESULT_END)
(CMS:JUMP_LIST)

Beide Zahlen gelten nur im resulttemplate: Nach dem CMS:SELECT ist wieder das umgebende Ergebnis aktiv – dieselbe Regel, die verschachtelte Listen möglich macht. Wird nur die Zahl gebraucht, zählt hits=false im aufrufenden Template.

hits

hits=false zählt nur (count=true ist damit eingeschlossen): Es werden keine Datensätze geladen und kein resulttemplate eingebunden – der Name muss trotzdem angegeben werden. Die Gesamtzahl steht danach im aufrufenden Template in $this->db->num_rows_unlimited:

(CMS:SELECT x filter[area]=artikel filter[topics]=42 hits=false)
(CMS:NUMBER useval="{$this->db->num_rows_unlimited}") Artikel zu diesem Thema

Ist die Zahl 0, gelten noresult bzw. noresulttemplate wie gewohnt:

(CMS:SELECT x filter[area]=artikel filter[topics]=42 hits=false noresult="Noch keine Artikel zu diesem Thema.")

Steht das zählende CMS:SELECT in einem resulttemplate, ersetzt die Zahl dort die Gesamtzahl des umgebenden Ergebnisses; $this->db->num_rows und die laufende Ergebnisschleife bleiben unberührt. Eine Blätterleiste (CMS:JUMP_LIST) des umgebenden Ergebnisses gehört dann vor das zählende CMS:SELECT.

archive

Abgelaufene Datensätze (offline_at erreicht) einbeziehen - z. B. für ein Archiv vergangener Veranstaltungen:

(CMS:SELECT archiv filter[area]=events archive=true sort=online_at order=desc)

Ein abgelaufener Datensatz bleibt übrigens unter seiner eigenen Adresse erreichbar; er fehlt nur in Listen ohne archive.

future

Vordatierte Datensätze (online_at noch nicht erreicht) einbeziehen - z. B. eine Vorschau auf kommende Beiträge:

(CMS:SELECT demnaechst filter[area]=artikel future=true filter[online_at] > now)

debug

SQL und Bind-Werte der Abfrage ausgeben (nur zur Entwicklung). Darüber stehen verworfene Filter mit Begründung – etwa ein unbekannter Feldname oder filter[depth] ohne filter[parent_id]:

(CMS:SELECT liste filter[area]=artikel debug=true)

sql

Roh-SQL für die WHERE-Klausel - nur für den Support, keine Benutzereingaben hineinreichen:

(CMS:SELECT liste filter[area]=artikel sql="AND `record`.`record_id` % 2 = 0")

set

Die gesamte Ausgabe – das Listentemplate mit allen Treffern, bei noresult dessen Text – landet in $set statt auf der Seite. So lässt sich etwa eine Adresse aus einer Abfrage in einem anderen Befehl weiterverwenden:

(CMS:SELECT url_only filter[area]=seiten filter[kennung]=warenkorb limit=1 set=warenkorb_url)
<a class="cart" href="<?php echo $set['warenkorb_url']; ?>">…</a>
(CMS:TEXT titel prefix="<a href='{$set['warenkorb_url']}'>" suffix="</a>")

Auch die Ausgabe von debug=true und PHP-Hinweise aus dem Listentemplate stehen dann in $set und nicht auf der Seite – zum Untersuchen set vorübergehend weglassen. Endet die Seite innerhalb der Abfrage (etwa durch ein Success-Template), wird das bis dahin Erzeugte normal ausgegeben.

state

Ohne Angabe nur freigegebene Datensätze (status_id 0). Eine Status-Id findet nur Datensätze mit genau diesem Status, any hebt den Statusfilter auf:

(CMS:SELECT liste filter[area]=artikel state=2)
(CMS:SELECT liste filter[area]=artikel state=any)

request

Übernimmt Filter, Sortierung und Blättern aus der URL (GET oder POST) – für Suchformulare und sortierbare Listen, ohne jeden Wert einzeln in den Befehl zu schreiben. Angegeben wird, was übernommen werden darf, als Kommaliste oder Array:

request="sort,order,skip"                                  nur Sortierung und Blättern
request="filter[title],filter[price],filter_op[price]"     Suche in Titel und Preis
request[]=sort request[]="filter[title]"                   dasselbe als Array

Erlaubt sind skip, limit, sort, order sowie filter, filter_op und filter_mode nur mit Feldname (filter[title]). Ein filter ohne Feldname und all werden ignoriert und als Fehler gemeldet – sonst dürfte ein Besucher nach jedem Feld der gefundenen Datensätze suchen, auch nach Feldern, die die Seite gar nicht anzeigt, etwa einer internen Notiz.

In der URL heißen die Schlüssel wie im Befehl, nur filterop und filtermode ohne Unterstrich: ?filter[title]=Hen*&sort=title&order=desc&skip=20.

(CMS:SELECT liste filter[area]=artikel limit=20 count=true request="filter[title],sort,order,skip")

Die URL kann die Abfrage nur einschränken, nie erweitern:

• Werte im Befehl haben Vorrang. Für ein Feld, das der Befehl filtert, übernimmt request weder Werte noch filter_op/filter_mode – ?filter[area]=intern oder ?filterop[area]=!= ändern an filter[area]=artikel nichts. Felder eines verknüpften Datensatzes zählen zum Verweisfeld (autor.name gehört zu autor), area und area_id gelten als dasselbe Feld.
• skip, limit, sort und order aus dem Befehl ersetzen den Wert der URL vollständig. limit aus der URL gilt nur als positive Zahl – „unbegrenzt“ lässt sich nicht anfordern.
• Verschlüsselte Felder finden nur den exakten Wert; Platzhalter (*) und Größer/Kleiner liefern keine Treffer.
• Passwortfelder lassen sich grundsätzlich weder filtern noch sortieren.

← Übersicht

CMS:SELECT_LANGVERSION

Liefert die verfügbaren Sprachen als Datensätze zurück.

(CMS:SELECT_LANGVERSION resulttemplate)

Methode: Cms::cmsSelectLanguages()
Ohne Schlüssel: der erste Wert ohne = gilt als resulttemplate
PHP-Schnipsel: push_result (davor) · include, pop_result (danach)

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Stellt die Sprachen des Auftritts als Ergebnismenge bereit - Hauptsprache zuerst - und bindet das resulttemplate ein. Jede Zeile trägt language_id, code, label, endonym und current (1 = Sprache des laufenden Aufrufs). Damit entsteht ein Sprachumschalter:

<ul class="lang">
(CMS:SELECT_LANGVERSION lang_item)
</ul>

Listentemplate lang_item:

(CMS:RESULT_START)
<li<?php if ($cms['current']) echo ' class="active"'; ?>>
  <a href="(CMS:URL lang="{$cms['code']}")" hreflang="(CMS:TEXT code)">(CMS:TEXT endonym)</a>
</li>
(CMS:RESULT_END)

Die Zeilen sind keine Datensätze; CMS:URL ohne id verweist deshalb auf den äußeren Datensatz - den der Seite bzw. die Zeile der umgebenden Ergebnisschleife -, nur in der jeweils anderen Sprache. Ist das Feld slug mehrsprachig, setzt CMS:URL den Slug der Zielsprache ein (/de/esstisch-nord-180 → /en/dining-table-nord-180), siehe CMS:URL. Bei nur einer Sprache enthält die Ergebnismenge genau eine Zeile.

Auf einer Seite ohne Datensatz (eigenständiges Template, /de/0,suche) gibt es keinen äußeren Datensatz; das Template gehört dann ausdrücklich in den Verweis:

<a href="(CMS:URL lang="{$cms['code']}" template=suche)">(CMS:TEXT endonym)</a>

Parameter im Einzelnen

resulttemplate

Listentemplate; darf ohne Schlüssel stehen:

(CMS:SELECT_LANGVERSION resulttemplate=lang_item)
(CMS:SELECT_LANGVERSION lang_item)

← Übersicht

CMS:RESULT_START

Markiert den Beginn einer Schleife zur Verarbeitung von CMS:SELECT-Ergebnissen.

(CMS:RESULT_START)

Kein Methodenaufruf – die Wirkung steckt allein im PHP-Schnipsel
PHP-Schnipsel: loop_start (danach)

Parameter

Dieser Befehl hat keine Parameter.

Anwendung

Öffnet die Schleife über die Treffer eines CMS:SELECT (bzw. CMS:SELECT_LANGVERSION, CMS:USER_BASKET function=load). Steht im Listentemplate; alles zwischen CMS:RESULT_START und CMS:RESULT_END wird je Treffer ausgeführt, die Befehle darin lesen aus der aktuellen Zeile:

<table>
(CMS:RESULT_START)
<tr>
  <td><?php echo $this->cms->row_no + 1; ?></td>
  <td><a href="(CMS:URL)">(CMS:TEXT title)</a></td>
  <td>(CMS:DATE online_at)</td>
</tr>
(CMS:RESULT_END)
</table>

Innerhalb der Schleife stehen zur Verfügung: $cms (die aktuelle Zeile als Array), $this->cms->row_no (0-basierte Zeilennummer), $this->db->num_rows (Treffer auf dieser Seite) und $this->db->num_rows_unlimited (Gesamtzahl bei count=true).

Der Befehl hat keine Parameter und erzeugt keinen Methodenaufruf - er wird direkt zu einer for-Schleife kompiliert.

← Übersicht

CMS:RESULT_END

Markiert das Ende einer Schleife zur Verarbeitung von CMS:SELECT-Ergebnissen.

(CMS:RESULT_END)

Kein Methodenaufruf – die Wirkung steckt allein im PHP-Schnipsel
PHP-Schnipsel: loop_end (danach)

Parameter

Dieser Befehl hat keine Parameter.

Anwendung

Schließt die mit CMS:RESULT_START geöffnete Schleife:

(CMS:RESULT_START)
  <li>(CMS:TEXT title)</li>
(CMS:RESULT_END)

Jedes CMS:RESULT_START braucht genau ein CMS:RESULT_END im selben Template - der Compiler erzeugt daraus { und }; ein fehlendes Ende führt zu einem PHP-Syntaxfehler beim Aufruf der Seite.

← Übersicht

CMS:JUMP_LIST

Erzeugt eine Blätter-Navigation (Pagination), z. B. 1 … 5 | 6 | 7 | 8 | 9 … 15.

(CMS:JUMP_LIST separator [parameter=wert …])

Methode: Pagination::cmsJumpList()
Ohne Schlüssel: der erste Wert ohne = gilt als separator

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Blätterleiste zu einem CMS:SELECT mit count=true. Die Seitengröße ist das limit der Abfrage; ohne limit gibt es keine Seiten und der Befehl gibt nur ifempty aus. Der aktuelle Versatz kommt aus $_REQUEST['skip'].

Der Befehl steht im resulttemplate des CMS:SELECT (vor oder hinter der Ergebnisschleife): Nur dort gelten Trefferzahl und limit dieser Abfrage – hinter dem CMS:SELECT im aufrufenden Template ist wieder das äußere Ergebnis aktiv.

(CMS:SELECT liste filter[area]=artikel limit=20 skip="{$_REQUEST['skip']}" count=true)

Template liste:

(CMS:RESULT_START)
  <h2>(CMS:TEXT titel)</h2>
(CMS:RESULT_END)
<nav class="pager">
(CMS:JUMP_PREV) (CMS:JUMP_LIST separator=" | ") (CMS:JUMP_NEXT)
</nav>

Ausgabe: ❮❮ 1 … 5 | 6 | 7 | 8 | 9 … 15 ❯❯

Die Links behalten alle übrigen Parameter der aktuellen URL (Suchbegriff, Filter) und setzen nur skip neu. Passt das Ergebnis auf eine Seite, wird nichts ausgegeben (bzw. ifempty).

Bootstrap-artige Leiste:

(CMS:JUMP_LIST
  prefix="<ul class=pagination>" suffix="</ul>"
  tpl_link="<li><a href='{href}'>{page}</a></li>"
  tpl_active="<li class=active><span>{page}</span></li>"
  ellipsis="<li class=disabled><span>…</span></li>"
  separator=""
)

Parameter im Einzelnen

skip

Versatz der aktuellen Seite, falls er nicht aus $_REQUEST['skip'] kommt:

(CMS:JUMP_LIST skip="{$offset}")

maximum

Anzahl der mitwandernden Seitenverweise (ohne erste/letzte Seite):

(CMS:JUMP_LIST maximum=5)

Ausgabe auf Seite 7 von 15: 1 … 5 6 7 8 9 … 15

boundaries

Verweise auf erste und letzte Seite unterdrücken:

(CMS:JUMP_LIST boundaries=false)

Ausgabe: 5 6 7 8 9 statt 1 … 5 6 7 8 9 … 15

separator

Text zwischen zwei Seitenverweisen; darf ohne Schlüssel stehen:

(CMS:JUMP_LIST " | ")
(CMS:JUMP_LIST separator=" · ")

tpl_link

Vorlage je Seitenverweis; {href} und {page} werden ersetzt:

(CMS:JUMP_LIST tpl_link="<a class=page href='{href}'>{page}</a>")

tpl_active

Vorlage für die aktuelle Seite:

(CMS:JUMP_LIST tpl_active="<span class='page current'>{page}</span>")

ellipsis

Platzhalter für ausgelassene Seiten (zwischen erster/letzter Seite und dem mitwandernden Bereich):

(CMS:JUMP_LIST ellipsis=" ··· ")

replace

Einfache Ersetzung im fertigen HTML, Trenner ? (nur ein Paar):

(CMS:JUMP_LIST replace="<strong>?<strong class=current>")

prefix

Erscheint nur, wenn eine Leiste ausgegeben wird:

(CMS:JUMP_LIST prefix="<nav class=pager>" suffix="</nav>")

suffix

(CMS:JUMP_LIST suffix="</nav>" prefix="<nav>")

ifempty

Ausgabe, wenn alles auf eine Seite passt (oder das CMS:SELECT kein limit hat):

(CMS:JUMP_LIST ifempty="<span class=muted>alle Einträge</span>")

set

(CMS:JUMP_LIST set=pager)
<?php if ($set['pager'] !== '') { ?><nav><?php echo $set['pager']; ?></nav><?php } ?>

← Übersicht

CMS:JUMP_NEXT

Erzeugt einen Weiterblättern-Verweis.

(CMS:JUMP_NEXT tpl_link [parameter=wert …])

Methode: Pagination::cmsJumpNext()
Ohne Schlüssel: der erste Wert ohne = gilt als tpl_link

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Verweis auf die nächste Seite einer blätterbaren Liste (CMS:SELECT mit count=true und limit). Der Befehl steht wie CMS:JUMP_LIST im resulttemplate der Abfrage, hier bei limit=20:

(CMS:JUMP_PREV) Seite <?php echo intdiv((int)($_REQUEST['skip'] ?? 0), 20) + 1; ?> (CMS:JUMP_NEXT)

Ausgabe: ❮❮ Seite 3 ❯❯

Gibt es keine nächste Seite – auch wenn alles auf eine Seite passt –, erscheint tpl_inactive (Standard: das Symbol ohne Link). Die Seitengröße ist das limit des CMS:SELECT; ohne limit erscheint nur ifempty.

Parameter im Einzelnen

skip

(CMS:JUMP_NEXT skip="{$offset}")

tpl_link

Vorlage mit Link; {href} wird ersetzt. Darf ohne Schlüssel stehen:

(CMS:JUMP_NEXT "<a class=next href='{href}'>weiter ›</a>")

tpl_inactive

Vorlage ohne nächste Seite ({href} wird auch hier ersetzt – mit der Adresse, die die nächste Seite hätte):

(CMS:JUMP_NEXT tpl_link="<a href='{href}'>weiter ›</a>" tpl_inactive="<span class=disabled>weiter ›</span>")

replace

(CMS:JUMP_NEXT replace="❯❯?→")

prefix

(CMS:JUMP_NEXT prefix="<li class=next>" suffix="</li>")

suffix

(CMS:JUMP_NEXT suffix="</li>" prefix="<li>")

ifempty

(CMS:JUMP_NEXT ifempty="")

Greift nur, wenn das CMS:SELECT kein limit hat; Standard ist leer.

set

(CMS:JUMP_NEXT set=next)

← Übersicht

CMS:JUMP_PREV

Erzeugt einen Zurückblättern-Verweis.

(CMS:JUMP_PREV tpl_link [parameter=wert …])

Methode: Pagination::cmsJumpPrev()
Ohne Schlüssel: der erste Wert ohne = gilt als tpl_link

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Verweis auf die vorherige Seite - Gegenstück zu CMS:JUMP_NEXT, wie dieses im resulttemplate eines CMS:SELECT mit limit (das limit ist die Seitengröße):

<nav>(CMS:JUMP_PREV "<a href='{href}'>‹ zurück</a>" tpl_inactive="") (CMS:JUMP_NEXT "<a href='{href}'>weiter ›</a>" tpl_inactive="")</nav>

Auf der ersten Seite erscheint tpl_inactive (hier leer), sonst der Link – auch wenn alles auf eine Seite passt.

Parameter im Einzelnen

skip

(CMS:JUMP_PREV skip="{$offset}")

tpl_link

(CMS:JUMP_PREV "<a class=prev href='{href}'>‹ zurück</a>")

tpl_inactive

(CMS:JUMP_PREV tpl_inactive="<span class=disabled>‹ zurück</span>")

replace

(CMS:JUMP_PREV replace="❮❮?←")

prefix

(CMS:JUMP_PREV prefix="<li class=prev>" suffix="</li>")

suffix

(CMS:JUMP_PREV suffix="</li>" prefix="<li>")

ifempty

(CMS:JUMP_PREV ifempty="")

Greift nur, wenn das CMS:SELECT kein limit hat; Standard ist leer.

set

(CMS:JUMP_PREV set=prev)

← Übersicht

CMS:CONTINUE

Setzt die Template-Abarbeitung trotz eines Success-Templates fort.

(CMS:CONTINUE)

Methode: Cms::cmsContinue()

Parameter

Dieser Befehl hat keine Parameter.

Anwendung

Befehle mit successtemplate (CMS:USER_LOGIN, CMS:USER_LOGIN_CODE, CMS:USER_INPUT, CMS:USER_REGISTER, CMS:USER_REGISTER_CONFIRM, CMS:USER_PW, CMS:USER_DELETE, CMS:EMAIL) binden im Erfolgsfall ihr Template ein und beenden danach die Seite; ebenso CMS:USER_PROTECT und CMS:USER_PW mit ihrem errortemplate und CMS:USER_LOGIN mit dem codetemplate. Steht CMS:CONTINUE vor dem Befehl, läuft das Template nach dem eingebundenen Template stattdessen weiter:

(CMS:CONTINUE)
(CMS:USER_INPUT
  container=comments
  submit="$submit"
  successtemplate=comment_saved
)
<h2>Alle Kommentare</h2>
(CMS:SELECT comment_list
  filter[area]=comments
)

Ohne CMS:CONTINUE würde nach comment_saved nichts mehr ausgegeben - mit ihm erscheint die Bestätigung oberhalb der Liste. Das Flag gilt genau einmal: Der nächste dieser Befehle, der tatsächlich ein Template einbindet, verbraucht es.

← Übersicht

CMS:CSP

Ändert die Script-Policy (Content-Security-Policy) dieser Seite: weitere Script-Quellen, Formularziele oder ein anderer Modus.

(CMS:CSP [parameter=wert …])

Methode: Cms::cmsCsp()

Parameter

Anwendung

Für jede Website lässt sich im Backend eine Script-Policy einschalten (Instanz, Abschnitt „Script-Policy (CSP)“). Dann laufen nur noch Scripts,

• die die Nonce der Seite tragen (ein Zufallswert je Aufruf) – im Template schreiben Sie dafür <script(CMS:NONCE)>, siehe CMS:NONCE, oder
• die von der eigenen Website oder aus den eingetragenen Quellen geladen werden (<script src="/js/app.js">).

Code, der über Inhalte in die Seite gerät (ein Kommentar mit <script>, ein Bild mit onerror), trägt keine Nonce und läuft nicht. Voreinstellung ist „aus“; „Nur melden“ lässt alles laufen und schreibt Verstöße ins Protokoll csp – so sieht man vor dem Durchsetzen, was blockiert würde.

CMS:CSP passt die Policy für eine Seite an, etwa die Kasse mit dem Script des Zahlungsanbieters:

(CMS:CSP script="https://js.stripe.com" form="https://checkout.stripe.com")

Der Befehl muss vor der ersten Ausgabe stehen, am besten ganz oben im Template; steht er später oder ist mode unbekannt, legt er eine Fehlermeldung ab (CMS:MESSAGE). Mehrere Aufrufe sammeln Quellen, getrennt durch Leerzeichen oder Komma. Erlaubt sind Host-Angaben (https://js.example.com, *.example.com, mit Port oder Pfad); Schlüsselwörter wie 'unsafe-inline' und reine Schemata wie https: werden verworfen – sie höben die Policy auf.

Was die Policy blockiert und wie es richtig geht:

Beim Speichern eines Templates meldet der Editor jedes <script> ohne (CMS:NONCE), jedes on…=-Attribut und jedes javascript: als Hinweis; auf der Startseite sammelt sie das Widget „Template-Meldungen“ – auch für Templates, die im Dateisystem bearbeitet werden.

Wer eine ganz eigene Policy will (auch für Styles, Bilder, Verbindungen), sendet sie mit CMS:HEADER und holt die Nonce mit (CMS:NONCE format=value).

Parameter im Einzelnen

script

(CMS:CSP script="https://maps.example.com https://cdn.example.com")

form

(CMS:CSP form="https://www.paypal.com")

mode

Eine Seite mit einem alten Widget vorübergehend ausnehmen oder nur melden lassen:

(CMS:CSP mode=report)
(CMS:CSP mode=off)

← Übersicht

CMS:HEADER

Sendet einen HTTP-Header.

(CMS:HEADER text [parameter=wert …])

Methode: Cms::cmsHeader()
Ohne Schlüssel: der erste Wert ohne = gilt als text

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Sendet einen HTTP-Header. Muss vor der ersten Ausgabe stehen - also am Anfang des Templates, vor jedem HTML und ohne Leerzeile davor:

(CMS:HEADER "Content-Type: application/json; charset=utf-8")
{"title": (CMS:TEXT title specialchars=true lbrconvert=false prefix='"' suffix='"')}

Weitere typische Fälle:

(CMS:HEADER "Content-Type: application/rss+xml; charset=utf-8")
(CMS:HEADER "Cache-Control: no-store")
(CMS:HEADER "HTTP/1.1 404 Not Found")

Weiterleitung – CMS-Befehle lassen sich nicht ineinander schachteln; die Adresse kommt deshalb erst per set in $set und dann in den Header:

(CMS:URL id=startseite set=ziel)
(CMS:HEADER "Location: {$set['ziel']}")

Liefert ein Template CSS, Javascript oder JSON aus, gehört der passende Content-Type an den Anfang – camindo CMS sendet X-Content-Type-Options: nosniff, der Browser führt ein Script mit dem Standardtyp text/html deshalb nicht aus:

(CMS:HEADER "Content-Type: text/javascript; charset=utf-8")

Ist schon etwas ausgegeben, wird eine Fehlermeldung abgelegt (CMS:MESSAGE) und der Header nicht gesendet.

Parameter im Einzelnen

text

Die Header-Zeile; darf ohne Schlüssel stehen:

(CMS:HEADER text="X-Robots-Tag: noindex")
(CMS:HEADER "X-Robots-Tag: noindex")

overwrite

Standardmäßig ersetzt ein Header einen vorherigen desselben Namens; overwrite=false hängt einen weiteren an:

(CMS:HEADER "Link: </style.css>; rel=preload; as=style")
(CMS:HEADER "Link: </app.js>; rel=preload; as=script" overwrite=false)

Voreinstellungen ersetzen oder entfernen

camindo CMS sendet vor dem Template einige Sicherheits-Header:

X-Frame-Options: SAMEORIGIN
Content-Security-Policy: frame-ancestors 'self'
X-Content-Type-Options: nosniff
Referrer-Policy: strict-origin-when-cross-origin
Cache-Control: private, no-cache

Die Seite lässt sich damit nur innerhalb der eigenen Website in einen Rahmen legen (Hintergrund und Fehlerbilder: Grundlagen). Jeder dieser Header lässt sich ersetzen; ohne Wert wird er entfernt. Eine Seite, die ein Partner einbetten darf:

(CMS:HEADER "X-Frame-Options:")
(CMS:HEADER "Content-Security-Policy: frame-ancestors 'self' https://partner.example")

Ist für die Website eine Script-Policy eingeschaltet (Backend, Instanz), sendet camindo stattdessen script-src 'self' 'nonce-…' samt frame-ancestors 'self'; für einzelne Seiten passen Sie sie mit CMS:CSP an.

Eine eigene Content-Security-Policy ersetzt die Voreinstellung – nehmen Sie frame-ancestors dann mit auf (die Nonce der Seite liefert CMS:NONCE):

(CMS:HEADER "Content-Security-Policy: frame-ancestors 'self'; script-src 'self' https://cdn.example")

Zwischenspeichern (Cache)

Seiten werden bei jedem Aufruf neu erzeugt. Mit der Voreinstellung Cache-Control: private, no-cache speichert kein Proxy und kein CDN die Seite, und der Browser fragt vor jeder Anzeige erneut beim Server an – geänderte Inhalte erscheinen sofort. Die Zurück-Schaltfläche des Browsers bleibt trotzdem schnell.

Gehört eine Seite einem einzelnen Besucher – es läuft eine Sitzung eines Frontend-Users (auch ein Warenkorb ohne Anmeldung, siehe CMS:USER_BASKET) oder das Frontend-Editing ist eingeschaltet –, sendet camindo stattdessen Cache-Control: private, no-store: Die Seite wird nirgends gespeichert.

Eine Seite, die sich selten ändert, darf länger zwischengespeichert werden:

(CMS:HEADER "Cache-Control: public, max-age=3600")

Setzen Sie den Header an den Template-Anfang. Läuft danach noch ein CMS:USER_*-Befehl mit einer Sitzung, gilt wieder private, no-store – persönliche Seiten landen so in keinem Zwischenspeicher.

← Übersicht

CMS:INCLUDE

Bindet ein Template ein.

(CMS:INCLUDE template)
(CMS:INCLUDE template caching=5m cacheparams=$params)

Methode: Cms::cmsInclude()
Ohne Schlüssel: der erste Wert ohne = gilt als template
PHP-Schnipsel: include_cached (danach)

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Bindet ein anderes Template an dieser Stelle ein - für Kopf- und Fußbereiche, Navigationen, wiederkehrende Blöcke:

(CMS:INCLUDE header)
<main>
  <h1>(CMS:TEXT title)</h1>
  (CMS:INCLUDE text_image_block)
</main>
(CMS:INCLUDE footer)

Das eingebundene Template sieht denselben Datensatz ($cms), dieselben $set-Werte und, innerhalb einer Ergebnisschleife, dieselbe Zeile. Ein Name ohne Bereich muss im Zugriffsbereich der Instanz eindeutig sein, sonst bereich.name:

(CMS:INCLUDE templates.header)

Die Verschachtelungstiefe ist durch admin.max_include_depth (Standard 20) begrenzt - ein Template, das sich selbst einbindet, bricht mit einer Fehlermeldung ab.

Parameter im Einzelnen

template

Name oder bereich.name (keine Id); darf ohne Schlüssel stehen. Im Backend-Editor ist der Wert ein Link auf das Template:

(CMS:INCLUDE template=header)
(CMS:INCLUDE header)
(CMS:INCLUDE templates.header)
(CMS:INCLUDE "{$set['layout']}")        dynamisch

set

Die Ausgabe des eingebundenen Templates landet in $set statt auf der Seite – etwa um einen Baustein zweimal zu verwenden oder an einen anderen Befehl weiterzugeben:

(CMS:INCLUDE preis set=preis)
<p class="preis"><?php echo $set['preis']; ?></p>
<meta property="product:price" content="(CMS:TEXT useval="{$set['preis']}" striptags=true specialchars=true)">

Mit caching kommt auch der abgefangene Text aus dem Cache.

caching

Schaltet den Ausgabe-Cache für diesen Aufruf ein: Beim ersten Aufruf läuft das Template wie gewohnt, seine Ausgabe wird unter var/cache/include/ abgelegt. Jeder weitere Aufruf mit denselben Angaben liefert innerhalb der Frist diese Datei aus – das Template, seine Abfragen und eingebundenen Templates laufen dann nicht.

(CMS:INCLUDE navigation caching=1h)
(CMS:INCLUDE footer caching=1d)
(CMS:INCLUDE teaser caching="{$set['cache_time']}")

Ein ungültiger Wert (caching=5x) erscheint als Fehlermeldung; das Template läuft dann ohne Cache.

cacheparams

Der Cache unterscheidet von selbst nach Website und Sprache. Hängt die Ausgabe von weiteren Dingen ab – dem Datensatz, der Seite einer Liste, einem Filter, dem angemeldeten Kunden –, gehören sie in cacheparams. Für jeden anderen Wert entsteht eine eigene Cache-Datei.

Erlaubt sind null, true/false, Zahlen, Texte und Arrays. Eine Variable ohne Anführungszeichen wird unverändert übergeben, auch ein Array:

<?php $params = ['id' => $cms['record_id'], 'seite' => (int)($_GET['skip'] ?? 0)]; ?>
(CMS:INCLUDE produktliste caching=10m cacheparams=$params)
(CMS:INCLUDE produkt_box caching=1h cacheparams=$cms['record_id'])
(CMS:INCLUDE produkt_box caching=1h cacheparams="produkt-{$cms['record_id']}")

Arrays werden als Ganzes verglichen – dieselben Schlüssel in anderer Reihenfolge ergeben eine andere Cache-Datei.

Was der Cache beachtet

• Wird das eingebundene Template geändert, gelten seine Cache-Dateien sofort nicht mehr. Ändern sich dagegen Inhalte im Backend, sieht der Besucher sie erst nach Ablauf der Frist. Wählen Sie die Frist danach, wie schnell Änderungen sichtbar werden müssen.
• Ein Template, das selbst Templates einbindet, legt deren Ausgabe mit ab. Ändert sich ein solches inneres Template, bleibt die gecachte Ausgabe bis zum Ablauf der Frist.
• Gespeichert wird nur die Ausgabe. Was das Template sonst tut – Werte in $set setzen, CMS:HEADER, CMS:CSP, Cookies, E-Mails –, geschieht bei einem Treffer nicht. Solche Befehle gehören ins aufrufende Template.
• Die Nonce der Script-Policy (CMS:NONCE) ist in jeder Auslieferung die aktuelle.
• Formulare mit Sicherheits-Token (CMS:USER_TOKEN, CMS:USER_INPUT) und persönliche Inhalte angemeldeter Kunden nicht cachen – oder den Kunden in cacheparams aufnehmen.
• Meldet ein Befehl beim Erzeugen einen Fehler, wird die Ausgabe nicht abgelegt.
• In der Vorschau aus dem Backend und bei eingeschaltetem Frontend-Editing gilt kein Cache.
• Rufen viele Besucher gleichzeitig ein abgelaufenes Template auf, erzeugt es nur einer; die anderen warten kurz und bekommen dann das Ergebnis.

Aufgeräumt werden abgelaufene Dateien von der Zeitplaner-Aufgabe „Frontend-Cache aufräumen“; ganz geleert wird der Cache mit php Core/cron/camindo.php cache include. Beides richtet der Systemadministrator ein.

← Übersicht

CMS:NONCE

Gibt die Nonce der Seite aus – für jedes Script im Template.

(CMS:NONCE [parameter=wert …])

Methode: Cms::cmsNonce()

Parameter

Anwendung

Ist die Script-Policy der Website durchgesetzt (siehe CMS:CSP), laufen nur Scripts mit der Nonce der Seite – einem Zufallswert, der mit jedem Aufruf wechselt. Schreiben Sie deshalb jedes Script im Template so:

<script(CMS:NONCE)>
document.querySelectorAll('[data-confirm]').forEach(function (form) {
  form.addEventListener('submit', function (ev) {
    if (!confirm(form.dataset.confirm)) ev.preventDefault();
  });
});
</script>

Auch eingebundene Dateien bekommen sie, wenn sie nicht von der eigenen Website kommen:

<script src="https://cdn.example.com/lib.js"(CMS:NONCE)></script>

camindo CMS setzt die Nonce nicht selbst ein. Fehlt sie, meldet der Template-Editor beim Speichern einen Hinweis („script without (CMS:NONCE)“), ebenso das Widget „Template-Meldungen“ auf der Startseite. Solange die Script-Policy aus ist, schadet das Attribut nicht – schreiben Sie es trotzdem gleich mit, dann lässt sich die Policy später einschalten, ohne die Templates zu ändern.

onclick="…", onsubmit="…" und href="javascript:…" laufen unter der Policy gar nicht, auch nicht mit Nonce: verlegen Sie den Code in ein <script(CMS:NONCE)> mit addEventListener (Beispiel oben).

Erzeugt PHP das Tag, holen Sie die Nonce mit set:

(CMS:NONCE set=nonce)
<?php echo '<script' . $set['nonce'] . '>var shop = ' . json_encode($config) . ';</script>'; ?>

Für eine eigene Policy per CMS:HEADER:

(CMS:NONCE format=value set=nonce)
(CMS:HEADER "Content-Security-Policy: default-src 'self'; script-src 'self' 'nonce-{$set['nonce']}'")

Eine Seite, die ein Proxy oder Cache mit fester Nonce ausliefert, schützt nicht mehr – Seiten mit Script-Policy nicht als Ganzes cachen.

Parameter im Einzelnen

format

<script(CMS:NONCE)>…</script>
(CMS:NONCE format=value)

set

(CMS:NONCE set=nonce)

← Übersicht

CMS:SAVEDATA

Speichert die Daten des aktuellen Datensatzes in der angegebenen Variable.

(CMS:SAVEDATA phpvar [parameter=wert …])

Methode: Cms::cmsSaveData()
Ohne Schlüssel: der erste Wert ohne = gilt als phpvar

Parameter

¹ kann ohne Schlüssel als erster Wert angegeben werden.

Anwendung

Legt einen kompletten Datensatz als Array in einer globalen PHP-Variable ab - für Logik, die mit den Ausgabebefehlen allein nicht zu schreiben ist:

(CMS:SAVEDATA article)
<?php if ($article['price'] > 100 && $article['stock'] > 0) { ?>
  <span class="badge">Premium</span>
<?php } ?>

Mit id einen anderen Datensatz laden, etwa den Elternknoten, um mit seinen Werten zu rechnen:

(CMS:SAVEDATA parent id="{$cms['parent_id']}")
<?php if ($parent['price'] > $cms['price']) { ?> … <?php } ?>

Geht es nur um die Ausgabe von Feldern eines anderen Datensatzes, brauchen Sie CMS:SAVEDATA nicht – die Ausgabebefehle lesen mit id selbst:

<a href="(CMS:URL "{$cms['parent_id']}")">(CMS:TEXT title id="{$cms['parent_id']}")</a>
<footer>(CMS:TEXT footer_text id=konfiguration)</footer>