Systemstatus
English (US)

TAL API

Aktueller Beitrag:
Weitere Beiträge aus dieser Kategorie:

TAL: E-Mail und LeadPage Designer

  • Aktualisiert
Folgen

Mailing

Methoden

  • `getDropAreas`: iterable (int, DropAreaAccessor) - Liefert alle im Mailing vorhandenen DropAreas, indiziert mit der Nummer der jeweiligen DropArea
  • `getModules`: DropAreaByNumberAccessor - Liefert ein Objekt zum Direktzugriff auf eine bestimmte DropArea via Nummer
  • `getConfigurationModules`: ConfigurationModuleByIdAccessor - Liefert ein Objekt zum Direktzugriff auf ein bestimmtes Configuration Module via Id

DropAreaAccessor

Methoden

  • `getNewsletter`: Mailing - Liefert das Mailing
  • `hasModules`: bool - Liefert zurück, ob in der DropArea Module vorhanden sind
  • `getModuleCount`: int - Liefert die Zahl der Module in der DropArea zurück
  • `getNumber`: int - Liefert die Nummer der DropArea
  • `isSubDropArea`: bool - Liefert zurück, ob diese DropArea eine SubDropArea ist
  • `getParentModule`: Module - Liefert das Modul, in dem sich diese SubDropArea befindet oder 'null', wenn dies keine SubDropArea ist

Iterieren über alle Module der DropArea

Möchte man über die Module der DropArea iterieren, so kann dies einfach direkt über den Accessor erfolgen. Dabei wird jeweils ein `ModuleAccessor` zurückgeliefert. In diesem Beispiel werden die IDs aller Module aller DropAreas ausgegeben.

<div tal:repeat="dropArea THIS/getDropAreas">
  <div tal:repeat="module dropArea">
    <div tal:content="module/getId">module-id</div>
  </div>
</div>

Zugriff auf Module der DropArea via Modul-Id

Möchte man direkt via ID auf eines der Module der DropArea zugreifen, so kann dies direkt über den Pfad erfolgen. Es wird `null|ModuleAccessor` zurückgegeben. In diesem Beispiel wird die ID des Moduls mit der id `module_id` ausgegeben. Es wird davon ausgegangen, dass man `dropArea` bereits auf einen anderen Weg bezogen hat.

<div tal:content="dropArea/module_id/getId">module-id</div>

DropAreaByNumberAccessor

DropAreaByNumberAccessor dient dem Direktzugriff auf eine bestimmte DropArea via Nummer. Es wird `null|DropAreaAccessor` zurückgegeben.

Methoden

  • `getNewsletter`: Mailing - Liefert das Mailing

Zugriff auf DropArea via Nummer

In diesem Beispiel wird die Nummer der DropArea `0` ausgegeben.

<div tal:content="THIS/getModules/0/getNumber">droparea-nummer</div>

ModuleAccessor

ModuleAccessor bietet Zugriff auf Werte und Informationen eines Moduls und seines Modul-Typs.

Methoden

  • `getNewsletter`: Mailing - Liefert das Mailing
  • `getId`: string - Liefert die Id des Moduls (Zusammengesetzt aus Ids des Modul-Typs und des Moduls)
  • `getRealId`: string - Liefert die echte Id des Moduls
  • `hasSubDropAreas`: bool - Wahr, wenn das im Modul-Typ Sub-DropAreas definiert wurden
  • `getWidgets`: ModuleWidgetAccessor - Liefert ein Objekt zum Direktzugriff auf Widgets des Moduls
  • `render`: string - Rendert das Modul und liefert den Quellcode zurück

Iterieren über alle Sub-DropAreas des Moduls

Sofern das Modul Sub-DropAreas unterstützt, können diese iterativ abgerufen werden. Dabei wird jeweils ein `SubDropAreaAccessor` zurückgeliefert. In diesem Beispiel werden die Nummern aller Sub-DropAreas des Moduls mit der Id `module_id` ausgegeben.

<div tal:repeat="subDropArea THIS/getModules/0/module_id">
  <div tal:content="subDropArea/getNumber">sub-droparea nummer</div>
</div>

Zugriff auf eine Sub-DropArea via Nummer

Ermöglicht den Direktzugriff auf eine Sub-DropArea via Nummer. Es wird `null|SubDropAreaAccessor` zurückgegeben.

Methoden

  • `getNewsletter`: Mailing: Liefert das Mailing

Direktzugriff via Nummer

In diesem Beispiel wird die Nummer der Sub-DropArea `0` ausgegeben. Es wird davon ausgegangen, dass man `module` bereits auf einen anderen Weg bezogen hat.

<div tal:content="module/0/getNumber">sub-droparea nummer</div>

SubDropAreaAccessor

SubDropAreaAccessor ermöglicht den Zugriff auf Module von Sub-DropAreas.

Methoden

  • `getNewsletter`: Mailing - Liefert das Mailing
  • `hasModules`: bool - Liefert zurück, ob in der Sub-DropArea Module vorhanden sind
  • `getModuleCount`: int - Liefert die Zahl der Module in der Sub-DropArea zurück
  • `getNumber`: int - Liefert die Nummer der Sub-DropArea zurück

Iterieren über alle Module der Sub-DropArea

Möchte man über die Module der Sub-DropArea iterieren, so kann dies einfach direkt über den Accessor erfolgen. Dabei wird jeweils ein `ModuleAccessor` zurückgeliefert. In diesem Beispiel werden die IDs aller Module aller Sub-DropAreas ausgegeben. Es wird davon ausgegangen, dass man `subDropArea` bereits auf einen anderen Weg bezogen hat.

<div tal:repeat="module subDropArea">
  <div tal:content="module/getId">module-id</div>
</div>

Zugriff auf Module der Sub-DropArea via Modul-Id

Möchte man direkt via ID auf eines der Module der Sub-DropArea zugreifen, so kann dies direkt über den Pfad erfolgen. Es wird `null|ModuleAccessor` zurückgegeben. Rückgabewert: null|ModuleAccessor In diesem Beispiel wird die ID des Moduls mit der id `module_id` ausgegeben. Es wird davon ausgegangen, dass man `subDropArea` bereits auf einen anderen Weg bezogen hat.

<div tal:content="subDropArea/module_id/getId">module-id</div>

ModuleWidgetAccessor

ModuleWidgetAccessor bietet Zugriff auf einzelne Widgets eines Moduls

Zugriff auf Widgets via Widget-Name

Möchte man direkt via Namen eines Widgets auf das Widget zugreifen, so kann das direkt über den Pfad erfolgen. Der zurückgegebene Accessor richtet sich nach dem Widget-Typ (s. unten). In diesem Beispiel wird die Text-Repräsentation des Widgets mit den Namen `widget_name` ausgegeben. Es wird davon ausgegangen, dass man `module` bereits auf einen anderen Weg bezogen hat.

<div tal:content="module/getWidgets/widget_name">module-id</div>

Widget-Accessoren

Farbe

Zugriff auf einzelne Farbwerte, erlaubt sind `red`, `green`, `blue` und `alpha`.

<div tal:content="widget/green">Wert für den Farbkanal</div>

Ausgabe des Farbwerts als CSS-RGBa Wert

<div tal:content="widget">RGBa-Wert für den Farbkanal</div>

Dict

Zugriff auf einzelne Werte des Dictionary (hier im Beispiel wurde `key_name` im Modul definiert). Wird `null|string` zurückgegeben.

<div tal:content="widget/key_name">Wert für den Farbkanal</div>

Selektionen

Zugriff auf Optionen und selektierte Werte von Selektions-Widgets.

Prüfen, ob eine bestimmte Option selektiert wurde

Möchte man feststellen, ob im Modul eine Option selektiert wurde, ist dies über `isSelected` möglich. In diesem Beispiel wird geprüft, ob der Key `selection_key` selektiert wurde.

<div tal:condition="widget/isSelected/selection_key">selected</div>

Iterieren über alle Optionen

Möchte man über die Optionen einer Selektion iterieren, so kann dies einfach direkt über den Accessor erfolgen. Dabei wird `Dict{key: string, label: string, checked: boolean}` zurückgegeben. In diesem Beispiel werden alle definierten Optionen des Widgets `selection` ausgegeben. In den folgenden Beispielen wird davon ausgegangen, dass man `module` bereits auf einen anderen Weg bezogen hat.

<div tal:repeat="option module/getWidgets/selection">
  <span tal:content="option/key">key</span>
  <span tal:content="option/label">label</span>
  <span tal:condition="option/checked">checked</span>
</div>

Links

Methoden

  • `getUri`: string - Liefert die Originl-Url
  • `getLink`: string - Liefert eine trackbare Url

Link-Listen

Möchte man auf einen Link der Liste mittels des definierten Keys zugreifen, so ist dies direkt über den Pfad möglich. Dabei wird `null|Dict{label: string, key: string, uri: string, link: string}` zurückgegeben.

  • `label`: Bezeichnung des Links
  • `key`: Interner Key
  • `link`: Trackbarer Link
  • `uri`: Original Uri

In diesem Beispiel wird der Link mit dem key `link_key` der Link-Liste `links` ausgegeben.

<div tal:define="link module/getWidget/links/link_key">
  <a tal:attributes="href link/link" tal:content="link/label">link</a>
</div>

Iterieren über alle Links

Möchte man über die die Linkliste iterieren, so kann dies einfach direkt über den Accessor erfolgen. Dabei wird `Dict{label: string, key: string, uri: string, link: string}` zurückgegeben.

  • `label`: Bezeichnung des Links
  • `key`: Interner Key
  • `link`: Trackbarer Link
  • `uri`: Original Uri
<div tal:repeat="link module/getWidgets/links">
  <a tal:attributes="href link/link" tal:content="link/uri">link</a>
</div>

Artikel

Methoden

  • `getArticleId`: int - Liefert die Id des Artikels
  • `getArticle`: ContainerAccessor - Liefert einen `ContainerAccessor` (s. TAL-Artikel-Zugriff) bzw. `null`, wenn der Artikel nicht existiert

Artikel-Listen

Iterieren über alle Artikel

Möchte man über die die Artikel-Liste iterieren, so kann dies einfach direkt über den Accessor erfolgen. Dabei wird jeweils ein `ContainerAccessor` zurückgegeben. In diesem Beispiel wird über alle Artikel des Widgets `article_list` iteriert.

<div tal:repeat="article module/getWidgets/article_list">
  <div tal:content="article/getAttributeByName/....">CONTENT</div>
</div>

Container

Methoden

  • `getContainerId`: int - Liefert die Id des Containers
  • `getContainer`: ContainerAccessor - Liefert einen `ContainerAccessor` (s. TAL-Container-Zugriff) bzw. `null` wenn der Container nicht existiert

Container-Listen

Iterieren über alle Container

Möchte man über die die Container-Liste iterieren, so kann dies einfach direkt über den Accessor erfolgen. Dabei wird jeweils ein `ContainerAccessor` zurückgegeben. In diesem Beispiel wird über alle Container des Widgets `container_list` iteriert.

<div tal:repeat="container module/getWidgets/container_list"> 
  <div tal:content="container/getAttributeByName/....">CONTENT</div>
</div>

Bild

Methoden

  • `getImageId`: int - Liefert die Id des Bildes
  • `getImage`: string - Liefert die Url des Bilds bzw. null wenn das Bild nicht existiert

Bild-Listen

Iterieren über alle Bilder

Möchte man über die die Bilder-Liste iterieren, so kann dies einfach direkt über den Accessor erfolgen. Dabei wird jeweils die Bild-Url zurückgegeben. In diesem Beispiel wird über alle Bilder des Widgets `image_list` iteriert.

<div tal:repeat="image module/getWidgets/image_list">
  <img src="src image" />
</div>

Verwandte Beiträge