Einführung & Grundlagen

Konzepte, Tag-Grundlagen, Filter, Datums-Patterns, Redakteurs-Tags.

Filter

Um mittels Code einfacher zu filtern, gibt es die Hilfsklasse Records (siehe Beschreibung).

Filter können z.B. in Zusammenhang mit bx:containerfilter oder Container-Filteraction verwendet werden, um bestimmte Datensätze anzuzeigen.

Aufbau eines Filters

Filter werden in XML angegeben. Der grundlegende Aufbau ist folgender:

<filter>
  <filter-object>
    ...
  </filter-object>
  <filter-object>
    ...
  </filter-object>
  <order/> <!-- ab Version 2.5.7 -->
  <limit/> <!-- ab Version 2.5.7 -->
  <status/> <!-- ab Version 2.6.1 -->
</filter>

Eine Mehrfachverwendung von "filter-object" bewirkt eine UND-Verknüpfung dieser Objekte.

Objekte

Ein "filter-object" ist folgendermaßen aufgebaut:

<filter-object [required="true"]>
  <field>...</field>
  <field>...</field>
  <type>...</type>
  [
   <request-value>...</request-value>
  |<static-value>...</static-value>
  |<special-value>...</special-value>
  |<request-attribute>...</request-attribute>
  |<session-attribute>...</session-attribute>
  ]
</filter-object>

Eine Mehrfachverwendung von "field" bewirkt eine ODER-Verknüpfung der Felder. Die optionale Angabe von required="true" bewirkt, dass ein Wert, der zum Vergleichen übergeben wird (z.B. bei "request-value") auch vorhanden sein muss, d.h. wenn nichts übergeben wird, wird die Bedingung auch nicht erfüllt.

field

Der Name des zu überprüfenden Feldes wird angegeben. Falls das Feld eine Verknüpfung darstellt (Untercontainer, Einzelverknüpfung, Mehrfachverknüpfung), kann auch der Wert eines Feldes der Verknüpfung abgefragt werden, dazu einfach das gesuchte Unter-Feld mit einem Schrägstrich anfügen.

<field>feldname</field>
<field>feldname/unterfeld</field>     <!-- Untercontainerfeld -->

type

Hier wird die Art des Vergleiches angegeben. Je nach Typ des Feldes, das geprüft wird, sind verschiedene Vergleiche möglich. Diese sind der folgenden Tabelle zu entnehmen. Verglichen wird dabei der Feldwert mit dem Testwert, so ließt sich z.B. die erste Zeile der Tabelle "Feldwert enthält Testwert" oder die Zeile bei Bildern/Dokumenten "Feldwert ist leer".

Feld-Typ Type Art des Vergleiches:
Feldwert ... [Testwert]
einzeiliger oder mehrzeiliger Text 1 enthält
2 beginnt mit
3 endet mit
4 ist gleich
5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
6 Mustervergleich (Regex)
7 enthält eines der Wörter von
(Wörter durch Leerzeichen oder Kommas trennen, findet auch Teilstrings)
8 ist eines der Wörter von
(Wörter durch Leerzeichen oder Kommas trennen, nur ganze Wörter)
9 enthält alle Wörter
(Wörter durch Leerzeichen oder Kommas trennen)
11 - 19 leer ODER Bedingung
Bedingung auch erfüllen, falls Feld leer ist (außer für type 5)
z.B.: type 14 für "ist gleich oder leer"
21 - 29 NICHT-Bedingung
kehrt die Bedingung um (außer für type 5)
z.B.: type 23 für "endet nicht mit"
31 - 39 leer ODER NICHT-Bedingung
Kombination von 11 - 19 und 21 - 29
z.B.: type 32 für "beginnt nicht mit oder ist leer"
Datum mit oder ohne Zeit 1 Feld ist größer (neuer) als übergebener Wert
2 Feld ist kleiner (älter) als übergebener Wert
3 ist gleich (Uhrzeit wird ignoriert)
4 ist ungleich (Uhrzeit wird ignoriert)
5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
6 ist im Jahr (vierstellig angeben)
7 ist im Monat (gültige Werte: 1-12)
8 ist am Tag (gültige Werte: 1-31)
11 Feld ist größer oder gleich als übergebener Wert
12 Feld ist kleiner oder gleich als übergebener Wert
21 Feld ist leer oder größer/gleich als übergebener Wert
22 Feld ist leer oder kleiner/gleich als übergebener Wert
31 Feld ist größer/gleich als heute + Testwert Tage
32 Feld ist kleiner/gleich als heute + Testwert Tage
nur (Uhr)Zeit 1 Feld ist größer (später)
2 Feld ist kleiner (früher)
3 Feld ist gleich
4 Feld ist ungleich
11 Feld ist größer/gleich
12 Feld ist kleiner/gleich
21 Feld ist leer oder größer/gleich
22 Feld ist leer oder kleiner/gleich
6 Feld ist in Stunde (0-23)
7 Feld ist in Minute (0-59)
8 Feld ist in Sekunde (0-59)
5 Feld ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
Zahl oder Preis 1 Feld ist größer gleich als übergebener Wert
2 Feld ist kleiner gleich als übergebener Wert
11 Feld größer als übergebener Wert
12 Feld kleiner als übergebener Wert
3 ist gleich
4 ist ungleich
5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
21 - 24 leer ODER Bedingung (1 bis 4)
31 - 32 leer ODER Bedingung (11 und 12)
Wahrheitswert (Boolean) 4 ist angehakt/gesetzt
5 ist leer (null)
Bild 1 bestimmte ID ist verknüpft
4 nicht-gelöschtes Bild ist verknüpft (ab v2.6.2)
5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
Dokument 5 ist leer
8 bestimmte ID ist verknüpft
Kartenkoordinaten 21 x ist gleich
26 y ist gleich
5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
Einzelverknüpfung 8 Datensatz-ID ist gleich
10 Datensatz-ID ist ungleich
Bei mehreren IDs, Filter mehrmals verwenden.
9 Datenlisten-ID ist gleich (nur bei alten Containern)
12 enthält eine der Datensatz-IDs von
(IDs durch Leerzeichen, Komma oder Semikolon trennen)
5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
4 ist verknüpft (ab 2.6.2)
3 ist aktiviert (ab 2.6.2)
Mehrfachverknüpfung 8 enthält Datensatz-ID
10 enthält Datensatz-ID nicht (ab v2.6.2)
12 enthält eine der Datensatz-IDs von
(IDs durch Leerzeichen, Komma oder Semikolon trennen)
14 enthält alle der angegebenen IDs
5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)
Untercontainer 5 ist leer (Feld soll leer sein: static-value: 1, Feld soll nicht leer sein: static-value: 0)

value

Der gesuchte Wert kann auf unterschiedliche Weise übergeben werden. Für <value>...</value> können die folgenden Abfragen eingesetzt werden.

request-value

Der Vergleich findet mit dem Wert eines Request-Parameters statt.

<request-value>Request-Parameter-Name</request-value>

request-attribute

Der Vergleich findet mit dem Wert eines Request-Attributes statt.

<request-attribute>Request-Attribut-Name</request-attribute>

session-attribute

Ein Session-Attribut wird mit dem Feld verglichen.

<session-attribute>Session-Attribut-Name</session-attribute>

static-value

Der Wert zum Vergleichen wird direkt übergeben.

<static-value>gesuchter Wert</static-value>

special-value

Es wird ein spezieller Wert zum Vergleich herangezogen.
TODAY Es wird mit dem heutigen Datum im Format dd.MM.yyyy verglichen. Um Tage dazu zu addieren (oder abzuziehen) kann das Attribut days verwendet werden (ganze Zahl, die auch negativ sein kann).
<special-value [days="n"]>TODAY</special-value>
NOW Es wird mit der aktuellen Zeit im Format dd.MM.yyyy mm:HH verglichen. Um Tage, Stunden oder Minuten dazu zu addieren (oder abzuziehen) können die Attribute days, hours oder minutes verwendet werden (ganze Zahl, die auch negativ sein kann).
<special-value [days="n"] [hours="n"] [minutes="n"]>NOW</special-value>
USERID Es wird mit der UserID des aktuellen (eingeloggten) Betrachters verglichen.
<special-value>USERID</special-value>
SESSIONID Die aktuelle SessionID wird abgeglichen.
<special-value>SESSIONID</special-value>
USERGROUPS Dieser Spezialwert erzeugt eine Zeichenkette, welche die ID des Users sowie die IDs der Gruppen, denen er angehört, enthält (jeweils durch Leerzeichen getrennt).
<special-value>USERGROUPS</special-value>
PARENTCONTAINER Es wird mit der ID des übergeordneten Containers verglichen.
<special-value>PARENTCONTAINER</special-value>

clipboard-value

Es wird ein spezieller Clipboard-Wert zum Vergleich herangezogen.

system-value

Es wird der Wert einer Systemvariablen zum Vergleich herangezogen. Die Systemvariable wird unter "Systemeinstellungen" angelegt und gespeichert.

order

Hier wird ein Sortierfeld definiert.

<order field="{Feldname}" [direction="{ascending|descending}"] />

Bei "field" wird der Feldname angegeben, nach dem sortiert wird. Sortiert werden kann nach einzeiligen Text, Datumtypen und Zahlentypen. Bei "direction" wird "ascending" für aufsteigende Sortierung, und descending für absteigende Sortierung angegeben. Bei weglassen der Sortierrichtung wird aufsteigend sortiert.

Diese Funktion ist ab v2.5.7 verfügbar

limit

Hier wird eine Startposition und ein überlauf in der Ergebnisliste definiert

<limit [index="{feste Startposition}"] [max="{Anzahl bis überlauf}"] />

Bei "index" wird die Startposition in der Ergebnisliste angegeben. Standardwert ist 0 für den ersten Datensatz. Bei max wird angegeben, wie viele Datensätze maximal (je Seite) angezeigt werden. Standardwert ist -1 für keine Einschränkung. Bei Angabe von max im bx:containerfilter wird diese Einstellung überschrieben.

Diese Funktion ist ab v2.5.7 verfügbar

status

Es kann angegeben werden, ob aktive und/oder inaktive Datensätze gefiltert werden sollen.

<status active="{false| true}" inactive="{false| true}" />

Erklärt sich - glaube ich - von selbst.

Diese Funktion ist ab v2.6.1 verfügbar

ID-Filter

zum Filtern der Datensatz-ID oder mehrerer IDs - getrennt durch Komma

<filter-id type="include" request-value="paramname" />
<filter-id type="include" request/session-attribute="paramname" />
<filter-id type="include" system/clipboard-value="paramname" /> <!-- ab v2.6.2 -->
<filter-id type="include">feste_id</filter-id>

Gegenteil von include: exclude (schließt diese ID(s) aus) (weitere Erläuterungen folgen noch)

Beispiele

Datumsvergleich

<filter>
  <filter-object>
    <field>Datum</field>
    <type>11</type>
    <special-value days="-1">TODAY</special-value>
 </filter-object>
</filter>

Es werden nur Datensätze angezeigt, die maximal einen Tag alt sind.

Suche

<filter>
  <filter-object>
    <field>Kategorie</field>
    <type>8</type>
    <request-value>kat</request-value>
  </filter-object>
  <filter-object>
    <field>Titel</field>
    <field>Text</field>
    <type>1</type>
    <request-value>search</request-value>
  </filter-object>
  <filter-object>
    <field>Archiv</field>
    <type>4</type>
    <static-value>0</static-value>
  </filter-object>
</filter>

Nur Datensätze, die folgenden Kriterien entsprechen werden ausgegeben:

Parameter-Werte (Präfixe)

Mit den folgenden Präfixen kann man auf verschiedene Variablen zugreifen:

Diese Präfixe können als Wert jedes Tag-Attributes verwendet werden.

Nur bei bx:containerfilter:

ab 2.6.2.

Pattern bei Datum

Pattern Entsprechung
d Tages im Monat ohne vorangestellter 0 bei einstelligen Zahlen (z.B. 5.12.2013)
dd Tages im Monat mitvorangestellter = (z.B. 05.12.2013)
M Monatsangabe ohne vorangestellter 0 bei einstelligen Zahlen (z.B. 12.5.2016)
MM Monatsangabe mit vorangestellter 0 (z.B. 12.05.2016)
MMM Monatsangebe als Text (z.B. 12.Mai.2016)
yy Zahresangabe zweistellig (z.B. 12.05.16), führt evtl. zu Missverständnissen (2016 oder 1916?)
yyyy Jahresangabe vierstellig (z.B. 12.05.2016)
EE Wochentagsausgabe als Text gekürzt (z.B. Mo, Di, Mi...)
EEE Wochentagsausgabe als Text ungekürzt (z.B. Montag, Dienstag, Mittwoch...)
H Ausgabe der Stunde ab 0 Uhr ohne vorangestellter 0 bei einstelligen Zahlen (z.B. 3:40 Uhr)
HH Ausgabe der Stunde ab 0 Uhr mit vorangestellter 0 (z.B. 03:40 Uhr)
mm augabe der minuten (z.B. 03:40 Uhr)
ss Ausgabe der Sekunden (z.B. 03:23:34 Uhr)

Weitere Infos und Ausgabemöglichkeiten auf der offiziellen JavaDoc-Seite

Beispiele

<bx:tools.datum pattern="dd.MM.yyyy HH:mm:ss"/>

Ausgabe eines Zeitstempels, z.B. 13.03.2016 13:48:33

Angebote im Monat <bx:recordfield.Datum pattern="MMM"/>

Ausgabe des Monatsnamen

Redakteurs-Tags

Titel

<bx:tag.{titel} />

Alle Unterstriche / Underscores ( _ ) im {titel} Platzhalter werden in der Verwaltung durch Leerzeichen ersetzt. Zum Beispiel wird dann aus

<bx:text.Haupt_Titel />

dieses Feld in der Verwaltung:

image2014-1-26 23:12:4.png

Mehrfachverwendung

Wird der gleiche {titel} mehrfach in einem Template oder in mehreren Templates im selben Menüpunkt verwendet, so stellt sich das Tag in der Verwaltung nur einmal dar. Der Redakteur muss den gewünschten Inhalt also nur an einer Stelle einpflegen. Alle gleichnamigen Tags werden dann mit diesem Inhalt versorgt.

Es ist darauf zu achten, nur gleichartige Tags mit dem selben {titel} zu versehen. So machen z.B. <bx:text.Titel /> und <bx:bild.Titel /> im selben Menüpunkt keinen Sinn.

Rechts neben dem Titel in der Verwaltung wird angezeigt, in welchen Templates ein Tag mit diesem Titel verwendet wird. Wird ein Tag in mehreren Templates verwendet, sieht dies z.B. so aus:

image2014-1-26 23:12:14.png

Es wird versucht etwaige Parameter der Tags sinnvoll zusammenzufassen. So wird z.B. bei bx:text der maximale Wert aller Tags für maxlength genommen.

Kommentar

<bx:tag.{titel} [comment="{kommentar}"] />

In {kommentar} kann ein zusätzlicher Beschreibungstext angegeben werden, der in der Verwaltung unterhalb des Titels angezeigt wird. Beispiel:

Eingabefeld mit Kommentar

<bx:text.Titel comment="Dies ist der große Titel direkt unter dem Headerbild." />

image2014-1-26 0:26:36.png

Admin-Mode

<bx:tagname.Titel admin-mode="config" />

Erzwingt, daß das Tag bei den Tageinstellungen (anstatt bei Dateneingabe) angezeigt wird. So sehen es die Redakteure nicht mehr und können es nicht mehr kaputtmachen. Bei <bx:containerfilter> wird das schon automatisch so gemacht. Jetzt lässt es sich auch per Parameter bei anderen Tags steuern.

Beispiele

<bx:text.farbcode admin-mode="config"/>
<bx:textarea.xml type="plain" wrap="off" admin-mode="config"/>
<bx:pageinclude.teaserpfad admin-mode="config"/>

Einige Beispiele, wo dies sinnvoll sein könnte.

Admin-Titel

<bx:tagname.Titel admin-title="{anderer Titel}" />

In Verwaltung wird ein anderer Titel ausgeben als der beim Tag angegebene.

Beispiele

<bx:bild.picture admin-title="Großes Logo"/>

genauere Bezeichnung des "picture"

<bx:textarea.Haedline admin-title="Headline"/>

im Nachhinein einen Schreibfehler zu korrigieren, wenn das Design schon oft in Gebrauch ist

Diese Tags können sich in der Verwaltung darstellen: