define

Syntax der Funktion define

Der Grundaufbau der Funktion define sieht wie folgt aus:

Definition einer String-Konstante:

<CMS_FUNCTION name="define" resultname="BEZEICHNER">
  <CMS_PARAM name="source" value="KONSTANTE" />
</CMS_FUNCTION>

Definition unter Verwendung von Ausdrücken:

<CMS_FUNCTION name="define" resultname="BEZEICHNER">
  <CMS_VALUE_PARAM name="source" value="AUSDRUCK" />
</CMS_FUNCTION>

Definition eines Vorlagenfragmentes (vergleichbar mit einer Absatzvorlage):

<CMS_FUNCTION name="define" resultname="BEZEICHNER">
  <CMS_CDATA_PARAM name="source">
    <![CDATA[
      RUMPF DES VORLAGENFRAGMENTES
    ]]>
  </CMS_CDATA_PARAM>
</CMS_FUNCTION>

Verwendung der Funktion define

Die Funktion define dient dazu, im Header-Bereich einer Seiten- oder Absatzvorlage, eine Variable zu definieren und der Variable einen Wert zu zuweisen.

Beispiel:

<CMS_FUNCTION name="define" resultname="NAME">
  <CMS_CDATA_PARAM name="source">
    <![CDATA[
      ...
    ]]>
  </CMS_CDATA_PARAM>
</CMS_FUNCTION>

Über die define-Funktion können konditionale Überprüfungen angegeben werden. Abhängig davon, ob eine angegebene Bedingung erfüllt oder nicht erfüllt ist, liefert die Funktion unterschiedliche Rückgabewerte.

Beispiele zur Funktion define

Nachfolgend werden einige Beispiele zur Verwendung der Anweisung innerhalb von Vorlagen gezeigt. Die Beispiele sollen die konkrete Auswirkung der Anweisung verdeutlichen und eine Hilfe für den Vorlagenentwickler bei der Erstellung eigener Vorlagen sein.

Für die Verwendung innerhalb eines Projekts, müssen die hier gezeigten Beispiele angepasst werden! Beispielsweise müssen Variablennamen auf die spezifischen Variablennamen des Projekts geändert werden, in dem die Anweisung verwendet werden soll.

1. Beispiel: Definition einer String-Konstanten

<CMS_FUNCTION name="define" resultname="name">
  <CMS_PARAM name="source" value="Eine Konstante" />
</CMS_FUNCTION>

Im Beispiel wird der Rückgabewert der define-Funktion auf den String Eine Konstante festgelegt.

2. Beispiel: Definition mit Ausdrücken

<CMS_FUNCTION name="define" resultname="name">
  <CMS_VALUE_PARAM name="source" value="4 * 2 - 5" />
</CMS_FUNCTION>

Der Rückgabewert der define-Funktion wird mit dem Ausdruck 4 * 2 - 5 festgelegt.

Bei dem Aufruf der Funktion mit $CMS_VALUE(...)$ wird das Ergebnis ermittelt. Das Beispiel gibt beim Aufruf mit $CMS_VALUE(name)$ den Wert 3 zurück.

3. Beispiel: Bedingte Auswertung

<CMS_FUNCTION name="define" resultname="name">
  <CMS_CDATA_PARAM name="source">
      <![CDATA[
            $CMS_IF(!myVar.isEmpty)$
                erste_Möglichkeit
            $CMS_ELSE$
                zweite_Möglichkeit
            $CMS_END_IF$
      ]]>
   </CMS_CDATA_PARAM>
</CMS_FUNCTION>

Im oben angegebenen Codebeispiel wird der Inhalt einer Variablen myVar geprüft. Ist der Wert von myVar null, gibt der Rückgabewert der define-Funktion erste_Möglichkeit zurück oder, wenn diese Bedingung nicht erfüllt ist, zweite_Möglichkeit.

4. Beispiel: Fallunterscheidung

<CMS_FUNCTION name="define" resultname="name">
  <CMS_CDATA_PARAM name="source">
      <![CDATA[
            $CMS_SWITCH(myVar.toString)$
               Standard_Möglichkeit
               $CMS_CASE("ABC")$
                  erste_Möglichkeit
               $CMS_CASE("DEF")$
                  zweite_Möglichkeit
               $CMS_CASE("XYZ")$
                  n-te_Möglichkeit
              $CMS_END_SWITCH$
        ]]>
  </CMS_CDATA_PARAM>
</CMS_FUNCTION>

Im oben angegebenen Codebeispiel wird der Inhalt einer Variablen myVar geprüft. Ist der Wert von myVar ABC, gibt der Rückgabewert der define-Funktion erste_Möglichkeit zurück, ist der Wert DEF, zweite_Möglichkeit, usw..

Dabei können beliebig viele unterschiedliche Bedingungen überprüft werden.