Tutorial: Dynamische PDF Erzeugung. mit der PHP EZPDF Class

Transkript

1 Tutorial: Dynamische PDF Erzeugung mit der PHP EZPDF Class Dieser Text unterliegt der GNU General Public License. Er darf als ganzes oder in Auszügen kopiert werden, vorausgesetzt, dass sich dieser Copyright Vermerk auf jeder Kopie befindet.

2 Dynamische PDF Erzeugung Seite 2 1 Dynamische PDF Erzeugung mit der PHP EZPDF Class PDF (portable document file) hat sich in den letzten Jahren als das Dateiformat für Dokumente im Internet durchgesetzt. Um solche Dokumente zu erzeugen gibt es zahlreiche Programme, z. B. Acrobat Distiller oder Ghostscript. Viel interessanter ist es solche Dokumente nicht statisch zu erzeugen, sondern sie bei Bedarf dynamisch erzeugen zu lassen. Mit der EZPDF Class Extension von R&OS Ltd für PHP kann das relativ leicht erledigt werden, da diese modulunabhängig arbeitet. Sie kann unter heruntergeladen werden. 1.1 Installation Zu installieren gibt es eigentlich nicht viel. Das Archiv muss einfach in ein beliebiges Verzeichnis entkomprimiert werden. Benötigt werden die Dateien class.ezpdf.php und class.pdf.php, außerdem die Schriftarten aus dem Verzeichnis fonts. Die Datei class.ezpdf.php muss über eine include Anweisung eingebunden werden, um auf die dort definierten Funktionen zugreifen zu können. Ansonsten wird eine umfangreiche Dokumentation (in englischer Sprache) mitgeliefert, in der die implementierten Funktionen an einfachen Beispielen erläutert werden. 1.2 Ein einfaches Beispiel Für die Erzeugung einer PDF Datei wird ein Grundgerüst benötigt, dass sich eigentlich immer wiederholt. Zuerst muss, wie bereits erwähnt, die PDF Class eingebunden werden. Einbindung der PDF Class include ("class.ezpdf.php"); Danach muss eine neue PDF Datei erzeugt werden.

3 Dynamische PDF Erzeugung Seite 3 Neue PDF Datei $pdf_datei=&new Cezpdf(); Besonders wichtig ist die Auswahl einer Schriftart, die danach erfolgt. Auswahl der Schriftart $pdf_datei->selectfont( fonts/helvetica.afm ); Dann wird der Text angegeben, der in der PDF Datei ausgegeben werden soll. Textangabe $pdf_datei->eztext("hallo Welt", 50); Zum Schluss muss der Text noch auf dem Bildschirm ausgegeben werden. Textausgabe $pdf_datei->ezstream(); Werfen wir jetzt einen ausführlichen Blick auf die im Beispiel verwendeten Funktionen. Mit der Funktion Cezpdf wird eine neue Seite generiert. Werden keine Optionen angegeben, wird standardmäßig DIN A4, Hochformat verwendet. Seit der Version 009e wird eine ganze Reihe von Formaten unterstützt. Hier empfiehlt sich ein Blick in die Dokumentation. Um eine Seite im DIN A5 Hochformat auszugeben muss die Anweisung folgendermaßen lauten: A5, Hochformat $pdf_datei=&new Cezpdf( a5, portrait ); Für die Ausgabe in DIN A4 Querformat muss sie so aussehen: A4, Querformat $pdf_datei=&new Cezpdf( a4, landscape ); Bei der Auswahl der Schriftart muss darauf geachtet werden, dass der angegebene Pfad stimmt. Neben Helvetica stehen auch Times, Courier und noch einige andere Schriftarten zur Verfügung.

4 Dynamische PDF Erzeugung Seite 4 Mit der Funktion eztext wird Text in die Seite eingefügt. Da es sich um einen String handelt, muss dieser in Anführungszeichen stehen. Das zweite Argument bestimmt den Schriftgrad, wird dieser nicht angegeben, wird eine Standardgröße von 12 verwendet. Der Text kann beliebig lang sein, am Zeilenende findet automatisch ein Umbruch statt, genauso, wenn das Seitenende erreicht wurde. Außerdem stehen eine Reihen von Optionen zur Verfügung, mit denen man Einzüge und Ausrichtung des Textes bestimmen kann. Diese müssen vorher in einem Array definiert werden. Textoptionen $text_options=array(left=>50,right=>50,justification=>"center"); $pdf_datei->eztext("hallo Welt", 20, $text_options); Dieses Beispiel richtet fügt einen linken und rechten Abstand von 50 ein und richtet den Text zentriert aus. Um den Text im Blocksatz auszugeben bekommt justification den Wert full. Mit der Funktion ezstream wird die Erzeugung der PDF Datei abgeschlossen und auf dem Bildschirm ausgegeben. Auf diese Art und Weise kann man also relativ leicht einfache PDF Dateien dynamisch erzeugen. Aber mit der EZPDF Class kann man noch mehr machen. 1.3 Seitenrand einstellen Wie man an den vorangegangenen Beispielen sehen kann, werden Standardseitenränder von 30 Pixeln für oben, unten, rechts und links verwendet. Diese können mit der Funktion ezset- Margins auch anders definiert werden. Seitenränder in Pixel 4 $pdf_datei->ezsetmargins(50,50,50,50); 5 $pdf_datei->selectfont( fonts/helvetica.afm ); 6 $pdf_datei->eztext("hallo Welt", 50); 7 $pdf_datei->ezstream(); 8?>

5 Dynamische PDF Erzeugung Seite 5 In Zeile 4 des obigen Beispiels werden Seitenränder von jeweils 50 festgelegt. Die Angabe der Werte erfolgt in der Reihenfolge oben, unten, links, rechts. Nun ist Pixel, zumindest für mich, nicht unbedingt das geeignete Maß, da ich es gewohnt bin Maße in cm anzugeben. Dieses ist mit der Funktion ezsetcmmargins möglich. Um einen Seitenrand für oben, links und rechts von jeweils 2,5 cm und für unten von 2 cm zu definieren muss der Code so aussehen. Seitenränder in cm 5 $pdf_datei->selectfont( fonts/helvetica.afm ); 6 $pdf_datei->eztext("hallo Welt", 50); 7 $pdf_datei->ezstream(); 8?> Besonders wichtig ist, dass bei der Verwendung von Dezimalzeichen der Punkt als Trennzeichen verwendet wird und nicht, wie sonst üblich, das Komma. 1.4 Seitennummerierung Bei mehrseitigen Dokumenten ist es sinnvoll die Seiten zu nummerieren. Dazu wird die Funktion ezstartpagenumbers verwendet. Angegeben werden müssen die x-position, die y- Position und die Größe. Die Seitengröße einer DIN A4 Seite in Pixeln beträgt 595,28 in der Breite und 841,89 in der Höhe. Um die Seitenzahl an einer bestimmten Stelle positionieren zu können, muss man mit den Werten für x und y ein wenig herum spielen. Auf jeden Fall sollte man vorher den Seitenrand für oben bzw. unten festgelegt haben, damit die Seitenzahl nicht über den Text geschrieben wird. Beispiel Seitenzahl oben, zentriert 5 $pdf_datei->ezstartpagenumbers(310,800,20); 6 $pdf_datei->selectfont( fonts/helvetica.afm ); 7 $pdf_datei->eztext("hallo Welt", 20); 8 $pdf_datei->ezstream(); 9?>

6 Dynamische PDF Erzeugung Seite 6 In Zeile 5 des obigen Beispiels werden für x und y die Werte 310 und 800 verwendet, die die Seitenzahl ungefähr in die Mitte der Seite schreibt. Die 20 bestimmt den Schriftgrad. Das Ergebnis sieht dann in etwas so aus: 1 of 3. Für das Erscheinungsbild der Seitenzahl wird ein sogenanntes Pattern verwendet. Wird keines angegeben, so wird ein Standardpattern verwendet. Will man ein anderes Pattern benutzen, musss dieses in der Funktion ezstartpagenumbers angegeben werden. Für die Seitennummerierung stehen {PAGENUM} für die aktuelle Seitenzahl und {TOTALPAGENUM} für die Gesamtseitenanzahl zur Verfügung. Um aus der englischen Nummerierung eine deutsche Nummerierung zu machen muss als Pattern folgender Ausdruck verwendet werden: {PAGE- NUM} von {TOTALPAGENUM}. Patternänderung 5 $pdf_datei->ezstartpagenumbers(310,800,20,, {PAGENUM} von {TOTALPAGENUM} ); 6 $pdf_datei->selectfont( fonts/helvetica.afm ); 7 $pdf_datei->eztext("hallo Welt", 20); 8 $pdf_datei->ezstream(); 9?> Um nur die aktuelle Seitenzahl und links und rechts davon einen Spiegelstrich am Seitenende zu drucken, ändert man Zeile 5 des obigen Beispiels folgendermaßen ab: einfache Seitenzahl $pdf_datei->ezstartpagenumbers(310,30,20,, - {PAGENUM} - ); 1.5 Seitenumbruch Wie bereits oben erwähnt, findet ein automatischer Zeilen- und Seitenumbruch ab. Es besteht aber auch die Möglichkeit mit der Funktion eznewpage einen manuellen Seitenumbruch einzufügen. Die Funktion benötigt keine Argumente. Sie muss lediglich an der Stelle aufgerufen werden, an der ein Seitenumbruch stattfinden soll. Die Ausgabe des Textes über die Funktion eztext muss dann natürlich auch mehrfach, je nach Anzahl der Umbrüche, erfolgen.

7 Dynamische PDF Erzeugung Seite 7 Seitenumbruch 5 $pdf_datei->ezstartpagenumbers(310,800,20,, {PAGENUM} von {TOTALPAGENUM} ); 6 $pdf_datei->selectfont( fonts/helvetica.afm ); 7 $pdf_datei->eztext("hier fängt der Text an, dann kommt der Seitenumbruch", 20); 8 $pdf_datei->eznewpage(); 9 $pdf_datei->eztext("und hier geht der Text auf der nächsten Seite weiter", 20); 10 $pdf_datei->ezstream(); 11?> 1.6 Text formatieren Um Text zu formatiert auszugeben kann auf HTML Tags zurückgegriffen werden. Die PDF Class unterstützt die Formate Fett, Kursiv und unterstrichen. Der zu formatierende Text wird wie in HTML von den entsprechenden Tags umgeben. Zeichenformate 5 $pdf_datei->ezstartpagenumbers(310,30,20,, - {PAGENUM} - ); 6 $pdf_datei->selectfont( fonts/helvetica.afm ); 7 pdf_datei->eztext("um Text zu formatieren kann auf HTML Tags zurückgegriffen werden. Unterstützt werden \nfett \n kursiv \nunterstrichen.", 20); 8 $pdf_datei->ezstream(); 9?> In Zeile 7 des obigen Beispiels wird außer den HTML Tags , und zur Formatierung auch noch die Escape Sequenz \n verwendet, mit der ein manueller Zeilenumbruch erzeugt werden kann. Ich hoffe, ich habe in diesem Tutorial zeigen können, wie man mit wenigen Funktionen der EZPDF Class Extension dynamische PDF Seiten erzeugen kann. Natürlich enthält die EZPDF Class Extension noch viele weitere Funktionen, mit denen man z. B. Tabellen, Grafiken

8 Dynamische PDF Erzeugung Seite 8 oder Hyperlinks in ein Dokument einfügen kann. Diese werde ich in einem weiteren Tutorial bechreiben. Für Kritik, Anregungen und Fragen stehe ich natürlich jederzeit zur Verfügung.