PDF-Dokumente mit PHP erzeugen

PDF-Dateien zu erstellen, ist schon lange kein Problem mehr. Spätestens seit OpenOffice die Möglichkeit bot, Textdokumente ins PDF-Format zu konvertieren (und möglicherweise aufgrund dessen andere namhafte Anbieter nachzogen), ist es für jedermann leicht möglich, seine Informationen in Form eines PDF-Dokumentes anzubieten. Anders sieht es aus, wenn man mal schnell auf seiner Website aktuelle Inhalte „zur Laufzeit“ dynamisch in einer PDF-Datei anbieten möchte.

Das wäre zum Beispiel nötig, wenn man Benutzereingaben aus Formularen in diese PDF-Datei integrieren muss. Ein mögliches Szenario wäre ein Bestellformular, welches nach erfolgter Bestellung dem Benutzer die Möglichkeit bietet, eine Bestellung als PDF-Datei auszudrucken/herunterzuladen.

Lösungsansatz / Alternativen

Wie immer gibt es mehrere Lösungen. In unserem Fall wird die PDF-Erzeugung durch Verwendung der Klasse FPDF gezeigt. Diese Klasse ist frei erhältlich und darf sowohl für private als auch für kommerzielle Zwecke genutzt werden. Das ist der erste Grund, weshalb wir FPDF hier verwenden, der zweite ist die Stabilität. Die FPDF-Klasse wird seit 2001 entwickelt und kann sich heute auf die Fahne schreiben, eine relativ einfach zu verwendende, erprobte und stabile PHP-Klasse zu sein. Eine Doku zu FPDF gibt es hier.

Als Alternative zu FPDF muss an erster Stelle PDFlib genannt werden. Diese Klasse ist jedoch nicht auf jedem Webserver verfügbar und Einrichtung und Umfang sind nicht trivial.  Wer sich die Sache trotzdem ansehen möchte, kann diese schön geschriebene Anleitung lesen. Eine andere interessante Alternative könnte TCPDF sein. Der Vollständigkeit halber seien „PDFlib Lite“, „CPDF“ und „Zend_Pdf“ für das Zend-Framework erwähnt.

Grundlagen / eigene Klasse

Für unsere Übung sollte auf Ihrem Webserver PHP5 laufen. Falls Sie keine Möglichkeit haben PHP5 zu nutzen, sind ein paar kleine Änderungen am Quellcode notwendig, dass die Skripte auch auf PHP4 lauffähig sind. Dazu am Ende mehr.

Am Besten legen Sie sich für die folgenden Versuche ein neues Verzeichnis an (so können Sie dieses eventuell schnell und problemlos wieder löschen, wenn Ihnen die Sache am Ende nicht gefällt). In dieses Verzeichnis entpacken Sie die FPDF-Klasse, die Sie hier herunterladen. Erstellen Sie ein weiteres Verzeichnis neben dem soeben entpackten fpdf-Verzeichnis und nennen es twpdf. Dies ist nur ein Vorschlag, Sie haben freie Auswahl. Manchmal jedoch ist es vorteilhaft, bei den selbst erstellten Verzeichnis-, Datei-, Funktions- und Variablennamen eine Art Vorzeichen anzuhängen, um im Code immer schnell erkennen zu können, was eigene Tests und was vorgegebene, erprobte Dinge sind. Alles was wir in unseren Übungen „probieren“ erhält die „Vorsilbe“ tw, so beugen wir dem versehentlichen Löschen der FPDF-Klasse vor.

Am Ende sollten Sie jedenfalls eine Verzeichnisstruktur ähnlich der im folgenden Bild vorliegen haben:

Testklasse01

Beginnen wir mit einer kleinen Testklasse um die grundlegenden Dinge kennenzulernen und gleichzeitig eine Art Vorlage für alle späteren Arbeiten zu haben.

// unsere Testklasse erbt von der FPDF-Klasse
class Testklasse01 extends FPDF {

	// hier werden die Variablen für diese Klasse deklariert (also: "bekanntgemacht")
	private $twVariable01 = "";
	private $twVariable02 = ""; 

	// der Konstruktor dieser Klasse
	function __construct() {
		// Konstruktor der vererbenden Klasse aufrufen (also den von FPDF)
		parent::__construct("P", "mm", "A4"); // L=Querformat(Landscape), P=Hochformat(Portrait)

		// hier werden die Variablen dieser Klasse initialisiert (also: "gefüllt")
		$this->twVariable01 = "Hallo, ich bin der Probetext aus Testklasse01";
		$this->twVariable02 = date("d.m.Y");

		// Einstellungen für das zu erstellende PDF-Dokument
		$this->SetDisplayMode(100);      // wie groß wird Seite angezeigt(in %)

		// Seite erzeugen (sozusagen: starten)
		$this->AddPage();
	}	

	// eine Funktion zur Anzeige des Inhalts
	function Header() {
		$this->SetFont("Arial","B","16");                    // Schrift
		$this->SetTextColor(255, 000, 000);                  // Schriftfarbe
		$this->SetXY(20, 50);                                // Position
		$this->Cell(90, 10, $this->twVariable01, 1, 1, "L"); // Box(Textbox)
	}	

	function Footer() {
		// Farben und Schrift allgemein
		$this->SetFont("Courier","I","9");
		$this->SetTextColor(180);
		$this->SetXY(25, 288);
		$this->Cell(170, 5, "dieses Dokument wurde am ". $this->twVariable02. " erstellt", 1, 1, "R");
	}
}
// ACHTUNG: darf kein Zeichen hinter phpend sein (auch kein Leerzeichen) !!!

Testklasse01.php

Diese kleine Testklasse könnte einfacher aufgebaut sein, doch für umfangreichere PDF-Dokumente später ist es ratsam, sich schon jetzt diesen Aufbau mit Variablendeklarationen, Konstruktor, Header uns Footer anzugewöhnen. Der abgebildete Quellcode sollte anhand der eingefügten Kommentare selbsterklärend sein. Trotzdem an dieser Stelle Erläuterungen zu den FPDF-Funktionen:

• Zeile 12: Ruft den Konstruktor der (vererbenden) FPDF-Klasse auf und setzt dabei das Papierformat, Maßeinheit und Papiergröße.
• Zeile 19: SetDisplayMode() legt fest, wie das Dokument angezeigt werden soll, also mit welchem Zoomfaktor.
• Zeile 22: AddPage() Erzeugt eine neue Seite im Dokument (beziehungsweise überhaupt eine Seite).
• Zeilen 26 bis 32: Header() Erzeugt den Header der Seite. Kann jedoch auch für den gesamten Seiteninhalt verwendet werden.
  • SetFont() Bestimmt Schriftart, Style (B=fett, I=kursiv, U=unterstrichen) und die Schriftgröße. Die geringe Auswahl an Schriftarten ist derzeit das größte Manko von FPDF, aber mal Hand aufs Herz, wieviele verschiedene Schriftarten verwendet man schon in einem Dokument?
  • SetTextColor() Bestimmt die Textfarbe. Angabe bsp. (220, 000, 110) oder nur (220) (steht für (220, 220, 220)).
  • SetXY() Position von linken oberen Seitenrand (x=horizontal, y=vertikal). Bestimmt den Punkt, an dem es weitergeht.
  • Cell() Zeichnet eine neue Zelle (oder halt Box) im Dokument. Diese kann optional Text, einen Rahmen und einen Hintergrund erhalten. Die linke obere Ecke beginnt an dem zuvor mit SetXY() zugewiesenem Punkt. Die Zellenbreite und -höhe wird in den beiden ersten Parametern festgelegt.
• Zeilen 35 bis 41: Footer() Die Fußzeile sozusagen.

php-Skript, welches das PDF-Dokument ausgibt, indem es die Testklasse01 benutzt

Es folgt der Code für die php-Datei. Erläuterungen folgen im Anschluss.

// ACHTUNG: darf kein einziges Leerzeichen vor phpstart sein, wegen header!

// FPDF-Klasse und das Verzeichnis der FPDF-Schriftarten einbinden
define("FPDF_FONTPATH","fpdf16/font/");
include_once('fpdf16/fpdf.php');

// unsere selbsterstellte Testklasse01 einbinden
include_once("twpdf/Testklasse01.php");

// pdf erzeugen (aus unserer selbsterstellten Testklasse01)
$pdf = new Testklasse01();  

// pdf ausgeben (im Browser oder in Datei schreiben)
$pdf->Output();   // Ausgabe (wenn in Datei schreiben, dateiname in Klammer)

// ACHTUNG: in der aufgerufenen Klasse darf kein Leerzeichen hinter phpende sein!

testseite01.txt

• Zeile 4 und 5: Hier werden die FPDF-Klasse und die Schriftarten eingebunden.
• Zeile 8: Hier binden wir unsere selbst erstellte Klasse ein.
• Zeile 11: Ein Objekt erzeugen von der Testklasse01.
• Zeile 14: Output() Output gibt das PDF-Dokument aus, beziehungsweise, wenn man als Argument einen Dateiname angibt, dann wird eine PDF-Datei auf dem Server angelegt.

Wenn Sie kein PHP5 auf Ihrem Webserver nutzen können

Wenn Ihnen kein PHP5 zur Verfügung steht, benutzen Sie für dieses Beispiel folgende Dateien.

• testseite01_fuer_altes_php kopieren
• Testklasse01_fuer_altes_php kopieren

Der Unterschied dieser beiden Dateien zu den vorgestellten Dateien ist gering. Hier wurden nur die „private/public-Angaben“ umgeändert in „var“ und der Konstruktoraufruf der vererbenden Klasse hat eine andere Syntax. Diese kleinen Unterschiede in den Dateien haben jedoch keinen Einfluss auf unsere Beispiele. Also, falls Sie beim Testen unserer Beispiele eine ähnliche Fehlermeldung wie die folgende erhalten, dann läuft auf Ihrem Webserver kein PHP5.

Ein erstes Beispiel

An dieser Stelle könnte jetzt ein Anwendungsbeispiel erscheinen. Man könnte eine einfache Rechnung zu generieren – so es wie dieses Beispiel zeigt. Aber vielleicht haben Sie ganz andere Ideen…