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.
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 SQL-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.
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.
