Einführung Smarty

Basis der Umwandlung ist immer das sog. Smarty Template. Darin wird das Format und die Struktur des ausgehenden Dokumentes definiert. Dazu kannst du einfach das Zielformat in Form einer Beispieldatei in den Template-Editor kopieren. Anschließend werden die Beispieldaten durch Variablen ersetzt und können dann vom System gefüllt werden.

Am Beispiel eines Auftrages als XML-Datei wird hier verdeutlicht, wie diese Umwandlung stattfinden kann.

Das folgende Format soll ausgegeben werden:

<?xml version="1.0" encoding="utf-8"?>
<auftrag>
  <belegnr>200259</belegnr>
  <kundennummer>100112</kundennummer>
  <name>Max Musterman</name>
  <strasse>Beispielstrasse 13</strasse>
  <plz>86150</plz>
  <ort>Augsburg</ort>
  <positionen>
<position>
<nummer>Art_001</nummer>
   <bezeichnung>Beispielartikel 1</bezeichnung>
   <menge>3</menge>
   <preis>7.96</preis>
</position>
<position>
<nummer>Art_002</nummer>
   <bezeichnung>Beispielartikel 2</bezeichnung>
   <menge>10</menge>
   <preis>399.99</preis>
</position>
  </positionen>
</auftrag>

Diese Beispieldatei wird in den Template-Editor kopiert. Anschließend werden die Beispielwerte mit den zugehörigen Variablen ersetzt.

<?xml version="1.0" encoding="utf-8"?>
<auftrag>
  <belegnr>{$beleg->belegnr}</belegnr>
  <kundennummer>{$beleg->kundennummer}</kundennummer>
  <name>{$beleg->name}</name>
  <strasse>{$beleg->strasse}</strasse>
  <plz>{$beleg->plz}</plz>
  <ort>{$beleg->ort}</ort>
  <positionen>
  {foreach from=$beleg->positionen key=keyrow item=position}{* Positionen *}
  <position>
<nummer>{$position->nummer}</nummer>
   <bezeichnung>{$position->bezeichnung}</bezeichnung>
   <beschreibung>{$position->beschreibung}</beschreibung>
   <menge>{$position->menge}</menge>
   <preis>{$position->preis}</preis>
   <einheit>{$position->einheit}</einheit>
</position>
  {/foreach}
  </positionen>
</auftrag>

Dabei wird je nach Bereich ein Basisobjekt verwendet, um auf die Werte zuzugreifen. Je nach Einsatzgebiet ist das ein anderes Objekt:

Die meisten der hier beschriebenen Beispiele stammen aus dem Standard-Umfang der verwendeten Template-Engine Smarty. Weitere Funktionen findest du daher in der offiziellen Smarty-Dokumentation.

Grundsätzlich werden Funktionen oder Modifier nach dem Pipe-Zeichen ( | ) in der Variable geschrieben, ggf. mit nachfolgenden Parametern, abgetrennt durch einen Doppelpunkt.

Template: { Wert oder $Variable | Modifier oder Funktion : Weitere Parameter }

<xml>

{* 0. Statisch *}
<auftragsdaten></auftragsdaten>
<transactions/>
<anrede>herr</anrede>

{* 1. Wertzuweisung *}
<waehrung>{$cart->auftragsdaten->currency}</waehrung>

{* 2. Rechnen *}
<gesamtsumme>{($cart->auftragsdaten->total_price - 5)}</gesamtsumme>

{* 3. Variablenzuweisung *}
{assign var=data value=$cart->auftragsdaten}
<email>{$data->email}</email>

{* 4. Funktionen *}
<bestelldatum>{$cart->auftragsdaten->processed_at|truncate:10:''}</bestelldatum>

{* 5. Verzweigungen *}
{if $cart->auftragsdaten->total_tip_received > 0}
 <freitext>Danke für die Spende von {$cart->auftragsdaten->total_tip_received} {$cart->auftragsdaten->currency}!!!</freitext>
{else}
 <freitext>Geiz ist geil!</freitext>
{/if}

{* 6. Schleifen *}
{foreach key=key item=item from=$cart->auftragsdaten->note_attributes}
  {if $item->name == "google-clientID"}
<internebemerkung>Google ClientID: {$item->value}</internebemerkung>
  {/if}
{/foreach}
</xml>

{assign var=order value=$cart->auftragsdaten}

{1.12345|string_format:"%1\$.3f"|replace:".":","}

{($cart->versandkostenbrutto-0.95)}

{$cart->order->name|truncate:3}

{$cart->order->name|truncate:3,””}

{$cart->order->name|string_format:"%s{3}"}

{$cart->order->name|strip}

{$cart->order->name|strip: }

{$original|replace:“foo":“bar”|getxml assign=“newxml”}

{$position->nummer|pregreplace:‘/[^0-9]/‘:’’}

{“Der Auftrag enthält keine Positionen”|error}

{$orderData|@debug_print_var}

Mit Hilfe von Bedingungen kann bereits im Template mit Logik gearbeitet werden, um kundenspezifische Entscheidungen bereits beim Ex- oder Import von Daten in verschiedene Ergebnisse zu überführen.

Im folgenden Beispiel wird beim Import eines Auftrages über eine Shop-Schnittstelle der englische Wert “mr” in die Anrede “herr” überführt, die in xentral für den Adresstyp und die Anrede “Herr” steht.

Beispiel Shopimporter:

<xml>
  <name>Max Mustermann</name>
  {if $cart->order->salutation == “mr”}
    <anrede>herr</anrede>
  {else}
    <anrede>frau</anrede>
  {/if}
</xml>

Alternative Schreibweise (Shopimporter)

<xml>
  <name>Max Mustermann</name>
  <anrede>
  {if $cart->order->Salutation == “mr”}
    herr{else}frau{/if}
  </anrede>
</xml>

Weitere alternative Schreibweise zum Überschreiben eines Knotens (Shopimporter)

<xml>
  <name>Max Mustermann</name>
  <anrede>frau</anrede>
  {if $cart->order->salutation == “mr”}
    <anrede>herr</anrede>
  {/if}
</xml>

In diesem Beispiel überschreibt der zweite gleichlautende Knoten (anrede) bei Zutreffen der Bedingung den vollständigen ersten Knoten inkl. Wert und ersetzt so den Inhalt.

Weitere Definitionen findest du in der Dokumentation Smarty if/else.

Schleifen ermöglichen die Abarbeitung von Wertelisten (Arrays), z.B. Auftragspositionen, Steuersätze, o.ä. Ergebnis sind meist Key-Value-Pairs, die dann im zweiten Schritt ausgewertet werden können. Dazu werden diese Listen in einer Schleife durchlaufen und bearbeitet.

Im folgenden Beispiel wird für eine gegebene Struktur der Rechnungsadresse ein beliebiges Element herausgegriffen, um z.B. eine gesonderte Einstellung für das Land zu setzen.

Beispiel Shopimporter

Warenkorb:

...
billing => [
  0 => [name => country, value => DE],
  1 => [name => street, value => Musterweg],
  2 => [name => house_no, value => 2],
  3 => [name => phone, value => 123456789],
  4 => [name => first_name, value => Max],
...

Template:

<xml>
  {foreach key=billingKey item=billingData from=$cart->billing}
    {if $billingData->name == ”country”}
      <land>{$billingData->value}</land>
    {/if}
  {/foreach}
</xml>

Weitere Definitionen findest du in der Dokumentation von Smarty zu Schleifen am Beispiel foreach

Hier findest du einige Tipps und Tricks, die dir eventuell weiterhelfen können.

<![CDATA[{$orderData->total_price}]]>

{"SELECT * ... "|assignsql assign="stock"}
{
  "stock": [
    {foreach from=$stock key=keyrow item=st}
      {
        "materialId": "{$st->nummer}",
        "quantity": "{$st->menge}",
        "warehouse": "{$st->kurzbezeichnung}"
      },

      {if $st@last}
      {
        "materialId": "{$st->nummer}",
        "quantity": "{$st->menge}",
        "warehouse": "{$st->kurzbezeichnung}"
      }
      {/if}
    {/foreach}
]}