Struktur und Arbeitsweise

PDF-Template-Teile

3 separate Teile

Jedes PDF-Template besteht aus 3 separaten Template-Teilen fĂŒr die Standard-Bereiche einer Dokument-Seite,

  • dem Header-Template,
  • dem Dokument-Template und
  • dem Footer-Template.

In jedem Beispiele gibt es insgesamt

  • 3 separate Template-Vorlagen fĂŒr jeweils einen der 3 Teile sowie
  • 2 zusĂ€tzliche Template-Vorlage-Gruppen, die jeweils alle 3 Teile enthalten.

Die Template-Vorlage-Gruppe

Hinweis: Eine Template-Vorlage-Gruppe enthĂ€lt alle 3 Template-Teile. Es werden bei Auswahl einer Template-Vorlage-Gruppe auch alle 3 Template-Teile eingefĂŒgt.

Auf dem Reiter “Dokument” können Sie wahlweise

  • eine Teil-Vorlage auswĂ€hlen (linke Listbox)
  • oder eine ganze Template-Vorlage-Gruppe (rechte Listbox).

Header und Footer Template-Vorlagen werden auf den entsprechenden Reitern eingefĂŒgt. Wenn Sie eine Template-Vorlage-Gruppe einfĂŒgen, so fĂŒgt diese sowohl einen Header und einen Footer und das Dokument selbst ein. Jeder Teil kann anschließend individuell weiterbearbeitet werden.

PDF Dokument

Die Platzhalter

Die Platzhalter sind das HerzstĂŒck eines jeden PDF-Templates. Wenn Sie auf unsere PDF-Demos schauen, werden Ihnen als Erstes diese merkwĂŒridgen Platzhalter im PDF Template Dokument ins Auge springen.

GrundsĂ€tzlich ist ein Platzhalter vom Format ${platzhalter_name}. Der Platzhaltername muss immer an das Formularfeld oder die Laufzeit-Information angepasst werden, die eingefĂŒgt werden soll.

Platzhalter fĂŒr die Joomla Framework Objekte User und Input

  • Zugriff auf das User Objekt: ${user:UserProperty}, also etwa
    • ${user:name} oder
    • ${user:id}.
  • Zugriff auf das Input Objekt: ${input:InputProperty}.

Platzhalter fĂŒr den aktuellen Datensatz

Der Zugriff auf den aktuellen Datensatz wird hauptsÀchlich in SQL-Statements verwendet, wie es weiter unten beschrieben wird.

  • Zugriff auf den Datensatz: ${item:itemProperty}, also etwa ${item:created}.

Platzhalter fĂŒr PDF Dokument Eigenschaften

  • [PNR] = Aktuelle Seitenzahl
  • [NPS] = Gesamtseitenzahl,
  • [POP] = Der Ausdruck ‘Aktuelle Seitenzahl / Gesamtseitenzahl’.
    Wird nur in Header und Footer unterstĂŒtzt.

Platzhalter fĂŒr das aktuelle Datum

  • ${currentdate}

Datensatzauswahl beim Drucken des PDFs in der Administration

PrimĂ€re Auswahl auf dem Reiter “Vorschau”

Wenn Sie PDF-Dokumente in der Administration erzeugen, entscheiden Sie Mithilfe der dortigen Datensatzauswahl, welche ĂŒbermittelten DatensĂ€tze verwendet werden. Es werden allein die Daten des Formulars verwendet, zu dem das PDF-Template gehört, um die Platzhalter im PDF-Template zu ersetzen.

Dies ist Ihre primĂ€re Datensatzauswahl. Diese primĂ€re Datensatzauswahl wird direkt im “Vorschau” Reiter vorgenommen.

Dort stehen Ihnen Optionen zur VerfĂŒgung wie

  • der “Status”,
  • die Auswahl einer Datensatz-ID,
  • Anzahl der DatensĂ€tze
  • und weitere.

Setzen Sie den Parameter Datensatz-ID auf 0, wenn Sie keinen speziellen Datensatz anhand seiner ID auswÀhlen wollen.

Jede Änderung, die Sie an der Datensatzauswahl vornehmen, wird unmittelbar ohne manuelles “Speichern” bei der nĂ€chsten Vorschau sofort angewandt. Die Speicherung der Datensatzauswahl erfolgt automatisch im Hintergrund. Mit asynchronen AJAX-Aufrufen werden die Änderungen zum Server gesendet und dort gespeichert.

SekundĂ€re Auswahl durch SQL Teil-Statements auf dem Reiter “Datenauswahl”

Es ist möglich, beliebige individuelle SQL Teil-Statements fĂŒr die Datensatzauswahl anzulegen. Dies geschieht auf den Reiter “Datenauswahl”. Die auf dem Reiter “Datenauswahl” hinterlegten SQL Teil-Statements können dann spĂ€ter in einer Listbox auf dem Reiter “Vorschau” fĂŒr die Erzeugung des PDF-Dokuments ausgewĂ€hlt werden

Das ist die sekundÀre Datensatzauswahl.

Sie hinterlegen auf dem Reiter “Datenauswahl” individuelle SQL WHERE Teil-Statements. Diese Teil-Statements beziehen sich allein auf den Teil eines kompletten SQL-Statements, der sich auf die Anfrage-Bedingungen hinter dem sogenannten ‘WHERE’ SchlĂŒsselwort bezieht.

Sie schreiben dieses Teil-Statement ohne das SchlĂŒsselwort “WHERE”, also nur die eigentlichen Abfrage-Bedingungen. Es sind ja eben diese Abfrage-Bedingungen, welchen letztendlich festlegen, welche DatensĂ€tze ausgewĂ€hlt werden.

Durch das Schreiben der SQL Teil-Statements haben Sie maximale Möglichkeiten fĂŒr Ihre Datensatzauswahl. Das gesamte PDF-Feature wird dadurch wesentlich flexibler

Es ist möglich in diesen Teil-Statements Platzhalter zu verwenden. Mehr dazu in: Fortgeschrittene Feature.

Sie können bis zu 10 verschiedene SQL Teil-Statements hinterlegen. Nachdem Sie Ihre Änderungen gespeichert haben, können Sie dann auf dem Reiter “Vorschau” mit der Listbox der Option “Datenauswahl SQL” eines dieser SQL Statements fĂŒr die Datensatzauswahl heranziehen.

Datenauswahl

Hierarchie der verschiedenen Optionen zur Datenauswahl

Wenn Sie PDF-Dokumente in der Administration erstellen, werden die Optionen der Datensatzauswahl in folgender Hierarchie berĂŒcksichtigt:

  • Haben Sie eine konkrete Datensatz-ID gewĂ€hlt, wird genau dieser eine Datensatz genommen.
  • Haben Sie als Datensatz-ID eine 0 eingetragen
    • werden alle DatensĂ€tze als Basisauswahl genommen oder
    • wenn Sie ein “Datenauswahl SQL” gewĂ€hlt haben, die DatensĂ€tze, die diese SQL Teil-Statement liefert.

Auf diese Vorauswahl werden dann anschließend alle anderen Optionen angewandt:

  • Status,
  • Limit,
  • Sortierung
  • und andere.
PDF Vorschau