FPDF für PHP (A) (B) (C) (D) (E) (F) (G) (H) (I)

Transkript

1 FPDF für PHP FPDF ist eine Möglichkeit, PDF Dokumente mit PHP kostenlos zu erstellen. FPDF ist eine PHP-Klasse, die in einer PHP-Datei eingebunden wird und nicht am Server installiert werden muss. Links: (englisch) und (deutsch) 1) Installation von FPDF Zuerst muss zb. von der Seite unter Downloads das FPDF-Paket herunterladen werden. Es gibt Dokumentationen für verschiedene Sprachen und darunter befinden sich die Pakete (verschiedene Versionen). Nach dem Entpacken werden die Dateien unter Erhalt der Ordnerstruktur in ein Verzeichnis (zb. fpdf) am Webspace übertragen. Will man Platz sparen, können die Verzeichnisse "doc" und "tutorial" entfernt werden. Diese Daten werden für die Ausführung nicht benötigt und können auch im Internet bzw. auf der lokalen Wordstation liegen. Damit ist die "Installation" bereits abgeschlossen. Es sind keine besonderen Rechte am Server nötig, da keine Installation erforderlich. Das Paket kann also auch verwendet werden, wenn man den Server nicht selber betreibt bzw. warten kann. Im Betrieb sind für den "Surfer" (others) auch nur Leserechte in diesem Verzeichnis notwendig. 2) Einbau von FPDF in ein PHP-Dokument - Minimalbeispiel Die PHP-Datei darf keinerlei direkten HTML-Output erzeugen! Das bedeutet, es gibt keinerlei HTML- Tags im ganzen Dokument! (nicht einmal html, head, body usw.!) Der Aufruf der PHP-Datei sendet die PDF-Daten direkt an den Browser, es wird also keine Datei erzeugt und gespeichert. Deshalb darf nichts mit einem anderen Mime-Typ zuvor gesendet worden sein! Speichern kann der User die Daten dann zb mit dem Acrobat-Reader-Plugin des Browsers. Die Daten in dem Dokument können natürlich aus Datenbankabfragen oder berechneten Werten bestehen, ebenso wie die Positionierung der Elemente. <?php define('fpdf_fontpath','pfad/font/'); require('pfad/fpdf.php'); $pdf=new FPDF(); $pdf->addpage(); $pdf->setfont('arial','b',16); $pdf->cell(40,10,'hello World!'); $pdf->output();?> (A) (B) (C) (D) (E) (F) (G) (H) (I) Beginn der PHP-Datei Der Pfad zu den Schriftartdateien wird definiert Einbinden der neuen Klasse (Pfadangabe zur Datei fpdf.php notwendig) Erzeugen des PDF-Dokuments Anlegen der ersten Seite Setzen der Schriftart Einfügen einer Ausgabezelle mit Text als Beispiel einer Ausgabe in das Dokument Abschließen und Absenden des PDFs Ende der PHP-Datei 3) Die Befehle im Einzelnen Die Befehle sind hier in einzelnen Gruppen angeordnet, je nach Verwendungszweck und je nach gewünschtem Schwierigkeitsgrad. Im Folgenden werden die Funktionen der Befehle, ihre Parameter und ihre Verwendung (mit Positionen im Dokument (vgl. 2)) erläutert. Jede FPDF-Datei sollte generell wie obiges Beispiel aussehen. Es kann deshalb als Grundgerüst verwendet werden. Die Zeile (F) wird dann durch die eigenen Ausgaben ersetzt. Weiters können diverse zusätzliche Befehle an geeigneter Stelle eingefügt werden. Ausführlichere Beispiele folgen unter Punkt 4). Mag. Volker Reitgruber, 9/04 4/05 Seite 1

2 Notwendige Grundeinstellungen AddPage(format) FPDF(format,einheit,grösse) Output(name,modus) SetFont(art,stil,grösse) Eine neue bzw. eine weitere Seite im Dokument wird angelegt und der Cursor links oben positioniert. Das optionale Attribut format kenn 2 Werte: P für Hochformat und L für Querformat. Es wird zumeist weggelassen, wobei die Voreinstellung P aktiviert wird. Konstruktor des Objekts. Es können 3 optionale Attribute übergeben werden: format (siehe oben), einheit (Maßeinheit Punkt (pt), Millimeter (mm), Zentimeter (cm) oder Inch (in)) und grösse (Papiergröße A3, A4, A5, Letter, Legal) Man kann auch die Höhe und Breite in obigen Einheiten angeben. Voreingestellt ist P,mm,A4 Schließt das Dokument ab und gibt es aus. Die optionalen Attribute legen fest: name (Dateiname des Dokuments) und modus (Art der Ausgabe: I = an den Browser senden, D = Speichern unter am Browser, F = am Server speichern, S = als Zeichenfolge ausgeben). Voreingestellt ist doc.pdf, I Stellt die Schriftart ein. art ist der Name der in Webspace-Ordner fonts definierten Schriftart. stil kann '' für normal, 'B' für fett, 'I' für kursiv und 'BI' für fett und kursiv sein. grösse ist die Schriftgröße in pt (1pt=0,35mm) Weitere einfache Grundeinstellungen (können komplett entfallen) SetAuthor(autor) SetAutoPageBreak(umbruch,abstand) SetCreator(verfasser) SetFontSize(grösse) SetKeyWords(wort1,wort2) SetLeftMargin(abstand) SetMargins(links,oben,rechts) SetRigthMargins(abstand) Mag. Volker Reitgruber, 9/04 4/05 Seite 2 Legt den Namen des Autors des Dokuments fest umbruch (true,false) gibt an, ob ein automatischer Seitenwechsel erfolgen soll. Wenn ja, dann gibt abstand an, wie weit vor dem Rand umgeblättert werden soll. Voreingestellt ist true, 20mm. Legt den Namen des Verfassers fest Legt die Schriftgröße in pt fest Legt die Schlüsselwörter zum Dokument fest (durch kommas getrennt) Einstellung des linken Seitenrands für das gesamte Dokument. Angabe vor dem Erzeugen der ersten Seite (AddPage). abstand in der gewählten Einheit. Voreinstellung 1cm. Setzt die Abstände zu den Rändern. Einzelheiten siehe SetLeftMargin Vgl. SetLeftMargin

3 SetSubject(thema) SetTextColor(graurot,grün,blau) SetTitle(titel) SetTopMargin(abstand) Gibt das Thema des Dokuments an Legt die Schriftfarbe fest. Wird nur graurot angegeben, so gibt es Graustufen von Werden drei Werte angegeben, so sind das die Anteile der RGB-Farben, jeweils Legt den Titel fest. Vgl. SetLeftMargin Seitenwechsel (fortgeschritten, können komplett entfallen, siehe Kapitel 4.) AliasNbPage(name) Close() Footer() Header() PageNo() Der name für die Gesamtseitenzahl wird festgelegt. Voreinstellung {nb}. Mit close() oder output() wird der Name durch die Gesamtseitenzahl ersetzt. Verwendung \{nb} in einer Ausgabefuntkion. Schließt das Dokument. Close() ist in Output() bereits enthalten. Die Funktion wird immer gestartet, bevor ein Seitenwechsel eingefügt wird. (zb. um Fußzeile einzufügen) Man muss die Funktion erst selber programmieren (eigene Klasse) Vgl Footer(), jedoch nach Beginn einer Seite Gibt die aktuelle Seitennummer an Textausgabe Cell(b,h,txt,ra,ln,aus,fül,lnk) Ln() MultiCell(b,h,txt,ra,ln,aus,fül) Text(x,y,txt) Erstellt eine Zelle zur Datenausgabe, mit der aktuellen Cursorposition als linker, oberer Ecke. b gibt die Breite nach rechts und h die Höhe der Zelle an (eingestellte Einheit). txt ist der Text zur Ausgabe, ra legt den Rahmen fest (0=ohne, 1=mit oder bel. Kombination aus LRTB für links-rechts-oben-unter), ln legt den Zeilenumbruch fest (0=Cursor rechts der Zelle, 1=Anfang der Zeile unter dem Ende der Zelle, 2=Anfang der Zeile unter dem oberen Zellrand), aus gibt die Ausrichtung an (L=links, C=zentriert und R=rechts), fül legt fest ob der Hintergrund transparent (0) oder gefüllt (1) ist, lnk gibt einen Link an Zeilenumbruch Wie cell, jedoch Zeilenumbrüche finden nach Notwendigkeit statt oder werden mit \n erzwungen. Es gibt keine Links. Ausgabe des Textes txt an den Koordinaten x und y. Die linksbündige Positionierung von einzeiligem Text geht so einfacher als mit Cell, aber andere Formatierungen sind komplizierter Mag. Volker Reitgruber, 9/04 4/05 Seite 3

4 Write(h,txt,lnk) Gibt den Text txt ab der Cursorposition aus, Zeilenumbruch am Zeilenende oder mit \n. h gibt die Zeilenhöhe an. lnk gibt einen URL an. Der Cursor steht abschließend hinter den Text. Positionierung GetX() GetY() SetX(x) SetXY(x,y) SetY(y) Liefert die horizontale Cursorposition Liefert die vertikale Cursorposition Setzt die horizontale Cursorposition Setzt die Cursorpositionen Setzt die vertikale Cursorposition Bilder und Grafiken Image(pfad,x,y,b,h,typ,lnk) Line(x1,y1,x2,y2) Rect(x1,y1,x2,y2,art) SetDrawColor(graurot,grün,blau) SetFillColor(graurot,grün,blau) SetLineWidth(breite) Für ein Bild (JPG, PNG oder GIF) ein. Die Datei muss unter dem pfad gefunden werden. x/y ist die linke obere Ecke, b die Breite und h die Höhe. Wird nur b oder h angegben, so wird das Bild unverzerrt angezeigt. Ohne Angabe wird es mit 72dpi angezeigt. typ legt falls notwendig den Typ genau fest (Werte: JPG, PNG, GIF). lnk enthält einen URL Zeichnet eine Linie von x1/y1 nach x2/y2 Zeichnet ein Rechteck mit Seiten parallel zu den Blatträndern. Art gibt den Stil an: ohne Eingabe oder D=nur Rahmen, F=nur ausgefüllt, DF gefüllt und mit Rahmen Legt die Zeichenfarbe fest (vgl. SetTextColor) Legt die Füllfarbe fest (vgl. SetTextColor) Legt die breite der Linien fest Fortgeschrittenes (Schriftarten, Links, Anzeige im Browser) AcceptPageBreak() AddFont(family,style,file) $var=addlink() Error(message) Mag. Volker Reitgruber, 9/04 4/05 Seite 4 Die Funktion wird immer gestartet, bevor ein Seitenwechsel eingefügt wird. Man muss die Funktion erst selber programmieren (eigene Klasse). Man kann den Seitenwechsel mit return true erlauben oder mit return false verbieten und andere Aktionen starten (zb. neue Spalte beginnen). Importiert aus der Datei file (xxxx.php) eine Schriftart die später unter dem Namen family und mit dem Stil style angesprochen wird. Die Datei muss aber zur Verfügung stehen oder erst erzeugt werden! Erstellt einen internen Link, bezeichnet durch die Variable var Gibt im Fehlerfall statt des Dokuments eine Meldung message aus.

5 GetStringWidth(string) Link(x,y,b,h,lnk) SetCompression(wert) SetDisplayMode(zoom,layout) SetLink(var,y,page) Liefert die Länge des strings in der definierten Maßeinheit unter Verwendung der aktiven Schriftart. Erstellt einen anklickbaren Bereich an der Position x/y mit der Breite b und Höhe h. lnk ist der URL. Aktiviert die Kompression des Dokument wert=true, oder deaktiviert sie wert=false. True ist nach Möglichkeit voreingestellt Legt den Vergrößerungsfaktor zoom und das Erscheinungsbild layout im Browser des Betrachters fest. Zoom: fullpage = gesamte Seite, fullwidth = mmaximale Breite, real = 100%, default = laut Einstellungen des Browsers, xx = xx-prozentiges Zoom. Layout: single = nur eine Seite, continuous = fortlaufende Seiten und double = 2 Seiten nebeneinander Definiert das Ziel eines zuvor mit AddLink() eingefügten internen Links. var ist ein Variablenname zur Ordnung der Links, y gibt die y-koordinate auf der Seite page an 4) Spezielle Beispiele Hier ein paar kommentierte Beispiele zum Umgang mit Klassen in PHP. Bsp 1: Textausgabemöglichkeiten 2. define('fpdf_fontpath', 'pfad/font/'); 3. require('pfad/fpdf.php'); 4. $pdf=new FPDF(); 5. $pdf->addpage(); 6. $pdf->setfont('arial','b',16); 7. $pdf->settextcolor(255,0,0); 8. $pdf->write(3.6,'hello!'); 9. $pdf->ln(); 10. $pdf->text(10,50,'ciao!'); 11. $pdf->setxy(10,100); 12. $pdf->cell(150,40,'test', 'TR',1,'C'); 13. $pdf->write(3.6,'hallo '. $name. '\n'. $ort); 14. $pdf->output(); 15.?> Zeile 1-5 sind Standard. 7 setzt die Farbe auf Rot. In 8 wird an der aktuellen Position ein Text in einer 3,6mm hohen Zeile ausgegeben. 9 wechselt in die nächste Zeile und 10 gibt einen Text 10mm rechts und 50mm unter dem Begrenzungsrand aus. In 11 wird der Cursor neu positioniert um dort dann in 12 eine Zelle anzulegen, die 150mm breit und 40mm hoch ist. Sie hat oben und rechts einen Rand. Geschrieben wird zentriert und der Cursor wird auf den Beginn der Zeile nach der Zelle gestellt. In 13 wird in eine 3.6mm hohe Zeile erzeugt. Darin steht ein fixer Text, der Inhalt einer Variablen, ein Zeilenumbruch und wieder der Inhalt einer Variablen sind wieder Standard. Mag. Volker Reitgruber, 9/04 4/05 Seite 5

6 Bsp 2: Bilder und Grafiken 2. require('pfad/fpdf.php'); 3. $pdf=new FPDF(); 4. $pdf->addpage(); 5. $pdf->setlinewidth(1); 6. $pdf->line(10,10,170,10); 7. $pdf->setdrawcolor(127); 8. $pdf->setfillcolor(191); 9. $pdf->rect(10,30,170,60,'df'); 10. $pdf->image('/home/xy/xy.jpg', 10,80,100); 11. $pdf->output(); 12.?> In 5 wird die Linienstärke auf 1mm gesetzt, in 6 wird eine horizontale Linie gezeichnet. 7 und 8 setzten die Zeichenfarben (Linie in mittlerem grau, Füllung hellgrau). In 9 wird ein Rechteck gezeichnet, das über einen Rahmen und eine Füllung verfügt. In 10 wird eine Grafik eingebunden (abs. Pfad am Server). Sie ist 100mm breit und nicht verzerrt (keine Höhenangabe). Bsp 3: Seitenumbruch mit Seitenzahlen, Seitennummer, Kopf und Fußzeilen 2. define('fpdf_fontpath', 'pfad/font/'); 3. require('pfad/fpdf.php'); 4. class PDF extends FPDF 5. {function Header() 6. {$this->setxy(10,4); 7. $this->cell(190,10,'p '. $this->pageno(). '/{nb}',0,0,'r'); 8. }} 9. $pdf=new FPDF(); 10. $pdf->aliasnbpages(); 11. $pdf->addpage(); 12. $pdf->setfont('arial','b',16); 13. $pdf->text(10,50,'ciao!'); 14. $pdf->output(); 15.?> Bsp 4: Seitenumbruch mit vorheriger Rückfrage In 4 wird eine neue Klasse FPDF von der Klasse PDF angeleitet. In dieser wird in 5 die Funktion Header() neu definiert und zwar so, dass sie in 6 eine Position setzt und in 7 in einer Zelle ein p ausgibt. Weiters wird die aktuelle Seitenzahl, ein Slash und die Gesamtseitenzahl rechtsbündig ausgegeben. In 8 wird die Funktion und die private Klasse beendet. 9 eröffnet das Dokument normal und 10 definiert {nb} als Platzhalter der Gesamtseitenzahl. Wird jetzt das Seitenende erreicht, wird die Funktion Header() aufgerufen und ausgeführt, bevor die Seite umgebrochen wird. Die Ausgabe in 7 verknüpft 4 Ausgaben. Der fixen Text "p ", die aktuelle Seitennummer, den fixen Text "/" und den Platzhalter für die Gesamtseitenzahl. Dieser wird beim Schließen des Dokuments mit einer Zahl ersetzt. Die Funktion Footer() funktioniert analog zu Header(). In 3 wird eine neue Klasse FPDF von der 2. require('pfad/fpdf.php'); Klasse PDF angeleitet. In dieser wird in 4 die 3. class PDF extends FPDF Funktion AcceptPageBreak() neu definiert: In 5 4. {function AceptPageBreak() wird die y-koordinate ermittelt. Ist diese kleiner als 80mm (dh. 1.Spalte) so wird der 5. {if (GetY()<80) Cursor in 6 in die 2.Spalte (100mm) auf den 6. {SetXY(10,100); Seitenbeginn gestellt. In 7 wird der 7. return false;} else Seitenumbruch verhindert. War die 2.Spalte Mag. Volker Reitgruber, 9/04 4/05 Seite 6

7 8. {return true;} 9. }} 10. $pdf=new FPDF(); 11. $pdf->addpage(); 12. normales Beschreiben des Dok. 13. $pdf->output(); 14.?> schon in Verwendung, so wird der Seitenumbruch erlaubt. 9 Beendet die Funktion und die private Klasse. Ab 10 ist es ein normales PDF-Dokument. Bsp 5: Links 2. define('fpdf_fontpath', 'pfad/font/'); 3. require('pfad/fpdf.php'); 4. $pdf=new FPDF(); 5. $pdf->addpage(); 6. $pdf->setfont('arial','b',16); 7. $lnk1=$pdf->addlink(); 8. $pdf->link(10,10,170,20,$lnk1); 9. $pdf->setlink($lnk1,1,2); 10. $pdf->addpage(); 11. $pdf->write(4,' ' 12. $pdf->output(); 13.?> In 7 wird ein Link vorbereitet, es wird ihm eine Variable zugeordnet. In 8 wird ein klickbarer Bereich erzeugt (ohne Inhalt). In 9 wird ein interner Link zugewiesen (Seite 2 oben). 10 erzeugt eine neue Seite. In 11 wird in einer 4mm hohen Zeile ein Text ausgegeben und ein www-link angegeben. Bsp 6: Schriftarten 2. define('fpdf_fontpath', 'pfad/font/'); 3. require('pfad/fpdf.php'); 4. $pdf=new FPDF(); 5. $pdf->addfont('comic','i', 'comici.php'); 6. $pdf->addpage(); 7. $pdf->output(); 8.?> In Zeile 2 wird der Pfad zu den Schriftartdateien gesetzt. In 5 wird die am Server vorhandene Schriftartendatei comici.php unter dem Namen Comic und mit den Typ Italic eingebunden. Mit einer Erweiterung (makefont) kann man solche Schriftartendateien erstellen. Mag. Volker Reitgruber, 9/04 4/05 Seite 7

8 5) Erweiterungen Auf der Homepage gibt es zahlreiche Erweiterungen zum Downloaden, beispielsweise: Polygons(x1,y1,x2,y2,x3,y3, ) : Linienzüge zeichnen WMF support: Unterstützt Windows Meta Files als Bilder Table: Mehrseitige Tabelle einfacher erzeugen Rounded rectangle: Rechteck mit abgerundeten Ecken Text rotations: vertikaler Text und verdrehter Text Diagramms: Torten- und Balkendiagramme zeichnen Forced justification: Blocksatz in Cell und Multicell Barcodes: Zeichnet Barcodes ohne ein Grafik zu benötigen Circle und Ellipse: Zeichnet Kreiseund Ellipsen Links zu weiteren Tools: Tool, um PDF-Dokumente zu lesen und Teile auszugeben PDML Portable Document Markup Language PDF-Formulare erzeugen Mag. Volker Reitgruber, 9/04 4/05 Seite 8