Ein Ziel definiert eine spezielle Sicht eines Dokuments, bestehend aus den folgenden Elementen: Die Seite des Dokuments das angezeigt werden soll. Der Ort des Dokumenten Fensters auf dieser Seite. Der Zoom Faktor der verwendet werden soll wenn die Seite angezeigt wird. Ziele können mit Outline Elementen ((Document Outline (bookmarks)), Hinweisen (Annotations), oder Aktionen (Actions) verknüpft werden. In jedem Fall spezifiziert das Ziel die Sicht des Dokuments welche dargestellt werden soll wenn das Outline Element oder der Hinweis geöffnet, oder die Aktion durchgeführt werden soll. Zusätzlich kann eine optionale Dokument Öffnungs-Aktion spezifiziert werden. Die folgenden Typen werden von der Zend_Pdf Komponente unterstützt. Zeigt die spezifizierte Seite, mit den Koordinaten (Links, Oben) positioniert an der oberen-linken Ecke des Fensters und dem Inhalt der Seite vergrößert auf den Zoom Faktor. Zielobjekte können durch Verwendung der Zend_Pdf_Destination_Zoom::create($page, $left = null, $top = null, $zoom = null) Methode erstellt werden. Wobei: $page eine Zielseite ist (ein Zend_Pdf_Page Objekt oder eine Seitennummer). $left ist die linke Ecke der angezeigten Seite (float). $top ist eine obere Ecke der angezeigten Seite (float). $zoom ist ein Zoom Faktor (float). NULL, wenn es für die $left, $top or $zoom Parameter spezifiziert wird, heißt "aktueller Wert der Viewer Anwendung". Die Zend_Pdf_Destination_Zoom Klasse bietet die folgenden Methoden an: FloatgetLeftEdge(); setLeftEdge(float $left); FloatgetTopEdge(); setTopEdge(float $top); FloatgetZoomFactor(); setZoomFactor(float $zoom); Zeigt die spezifizierte Seite an, wobei der Inhalt soweit vergrössert wird, dass er auf die komplette Seite passt sowohl Horizontal als auch Vertikal im Fenster. Wenn die benötigten horizontalen und vertikalen Vergrösserungsfaktoren unterschiedlich sind, wird der kleinere der zwei verwendet, und die Seite im Fenster mit der anderen Dimension zentriert. Das Zielobjekt kann erstellt werden indem die Zend_Pdf_Destination_Fit::create($page) Methode verwendet wird. Wobei $page eine Zielseite ist (ein Zend_Pdf_Page Objekt oder eine Seitennummer). Zeigt die spezifizierte Seite, mit den vertikalen Koordinaten an der oberen Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert damit die komplette Breite der Seite in das Fenster passt. Das Zielobjekt kann erstellt werden indem die Zend_Pdf_Destination_FitHorizontally::create($page, $top) Methode verwendet wird. Wobei: $page ist eine Zielseite (ein Zend_Pdf_Page Objekt oder eine Seitenzahl). $top ist die obere Ecke der angezeigten Seite (float). Die Klasse Zend_Pdf_Destination_FitHorizontally bietet auch die folgenden Methoden: FloatgetTopEdge(); setTopEdge(float $top); Zeigt die spezifizierte Seite, mit den horizontalen Koordinaten an der oberen Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert damit die komplette Höhe der Seite in das Fenster passt. Das Zielobjekt kann erstellt werden indem die Zend_Pdf_Destination_FitVertically::create($page, $left) Methode verwendet wird. Wobei: $page ist eine Zielseite (ein Zend_Pdf_Page Objekt oder eine Seitenzahl). $left die linke Ecke der angezeigten Seite ist. (float). Die Klasse Zend_Pdf_Destination_FitVertically bietet auch die folgenden Methoden: FloatgetLeftEdge(); setLeftEdge(float $left); Zeigt die spezifizierte Seite an, wobei der Inhalt gerade genug vergrössert ist damit er komplett in das Rechteck passt das durch die Koordinaten links, unten, rechts und oben spezifiziert wird sowohl horizontal als auch vertikal. Wenn die notwendigen horizontalen und vertikalen Vergrösserungsfaktoren unterschiedlich sind, wird der kleinere der zwei verwendet, wobei das Rechteck im Fenster durch Verwendung der andern Dimension zentriert wird. Das Zielobjekt kann erstellt werden indem die Zend_Pdf_Destination_FitRectangle::create($page, $left, $bottom, $right, $top) Methode verwendet wird. Wobei: $page ist eine Zielseite (ein Zend_Pdf_Page Objekt oder eine Seitenzahl). $left die linke Ecke der angezeigten Seite ist. (float). $bottom die untere Ecke der angezeigten Seite ist (float). $right die rechte Ecke der angezeigten Seite ist (float). $top die obere Ecke der angezeigten Seite ist (float). Die Klasse Zend_Pdf_Destination_FitRectangle bietet auch die folgenden Methoden an: FloatgetLeftEdge(); setLeftEdge(float $left); FloatgetBottomEdge(); setBottomEdge(float $bottom); FloatgetRightEdge(); setRightEdge(float $right); FloatgetTopEdge(); setTopEdge(float $top); Zeigt die spezifizierte Seite an, wobei der Inhalt gerade genug vergrössert ist damit die Zeichenbox komplett in das Fenster passt, sowohl horizontal als auch vertikal. Wenn die notwendigen horizontalen und vertikalen Vergrösserungsfaktoren unterschiedlich sind, wird der kleinere der zwei verwendet, wobei die Zeichenbox im Fenster durch Verwendung der andern Dimension zentriert wird. Das Zielobjekt kann erstellt werden indem die Zend_Pdf_Destination_FitBoundingBox::create($page, $left, $bottom, $right, $top) Methode verwendet wird. Wobei $page eine Zielseite ist (ein Zend_Pdf_Page Objekt oder eine Seitenzahl). Zeigt die spezifizierte Seite, mit den vertikalen Koordinaten an der oberen Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert damit die komplette Breite der Zeichenbox in das Fenster passt. Das Zielobjekt kann erstellt werden indem die Zend_Pdf_Destination_FitBoundingBoxHorizontally::create($page, $top) Methode verwendet wird. Wobei $page eine Zielseite ist (ein Zend_Pdf_Page Objekt oder eine Seitenzahl). $top ist die obere Ecke der angezeigten Seite (float). Die Klasse Zend_Pdf_Destination_FitBoundingBoxHorizontally bietet auch die folgenden Methoden: FloatgetTopEdge(); setTopEdge(float $top); Zeigt die spezifizierte Seite, mit den horizontalen Koordinaten an der oberen Ecke des Fensters positioniert, an und den Inhalt der Seite gerade genug vergrössert damit die komplette Höhe der Zeichenbox in das Fenster passt. Das Zielobjekt kann erstellt werden indem die Zend_Pdf_Destination_FitBoundingBoxVertically::create($page, $left) Methode verwendet wird. Wobei $page eine Zielseite ist (ein Zend_Pdf_Page Objekt oder eine Seitenzahl). $left ist die linke Ecke der angezeigten Seite (float). Die Klasse Zend_Pdf_Destination_FitBoundingBoxVertically bietet auch die folgenden Methoden: FloatgetLeftEdge(); setLeftEdge(float $left); Alle oben aufgeführten Ziele sind "Explizite Ziele". Zusätzlich dazu können PDF Dokumente ein Verzeichnis solcher Ziele enthalten welche verwendet werden können um nach ausserhalb des PDF's zu referenzieren (z.B. 'http://www.mycompany.com/document.pdf#chapter3'). Zend_Pdf_Destination_Named Objekte erlauben es auf Ziele der benannten Zielverzeichnisse des Dokuments zu referenzieren. Benannte Zielobjekte können erstellt werden indem man die Zend_Pdf_Destination_Named::create(string $name) Methode verwendet. Die Klasse Zend_Pdf_Destination_Named bietet eine einzige zusätzliche Methode: StringgetName(); Die Klasse Zend_Pdf bietet ein Set von Methoden zur Verarbeitung von Zielen. Jedes Zielobjekt (inklusive benannter Ziele) kann aufgelöst werden indem die Methode resolveDestination($destination) verwendet wird. Sie gibt ein passendes Zend_Pdf_Page Objekt zurück wenn das Zielobjekt gefunden wurde, andernfalls NULL. Die Methode Zend_Pdf::resolveDestination() nimmt auch einen optionalen booleschen Parameter $refreshPageCollectionHashes, der standardmäßig TRUE ist. Er zwingt das Zend_Pdf Objekt die Hashes der internen Kollektion der Seiten neu zu laden da die Liste der Seiten des Dokuments vom Benutzer aktualisiert sein könnte indem die Eigenschaft Zend_Pdf::$pages verwendet wird (Arbeiten mit Seiten). Das kann aus Gründen der Performance ausgeschaltet werden, wenn bekannt ist das die Liste der Seiten des Dokuments seit der letzten Anfragemethode nicht geändert wurde. Die komplette Liste der benannten Ziele kann empfangen werden indem die Methode Zend_Pdf::getNamedDestinations() verwendet wird. Sie gibt ein Array von Zend_Pdf_Target Objekten zurück, welche entweder explizite Ziele oder eine GoTo Aktion sind (Aktionen). Die Methode Zend_Pdf::getNamedDestination(string $name) gibt spezifizierte benannte Ziele zurück (ein explizites Ziel oder eine GoTo Aktion). Das Verzeichnis der benannten Ziele des PDF Dokuments kann mit der Methode Zend_Pdf::setNamedDestination(string $name, $destination) aktualisiert werden, wobei $destination entweder ein explizites Ziel ist (jedes Ziel ausser Zend_Pdf_Destination_Named) oder eine GoTo Aktion. Wenn NULL statt $destination spezifiziert ist, werden die spezifizierten benannten Ziele entfernt. Benannte Ziele die nicht aufgelöst werden können, werden automatisch vom Dokument entfernt wenn das Dokument gespeichert wird. newPage(Zend_Pdf_Page::SIZE_A4); $page2 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4); $page3 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4); // Erstellte Seiten, aber nicht in der Seitenliste enthalten $pdf->pages[] = $page1; $pdf->pages[] = $page2; $destination1 = Zend_Pdf_Destination_Fit::create($page2); $destination2 = Zend_Pdf_Destination_Fit::create($page3); // Gibt das $page2 Objekt zurück $page = $pdf->resolveDestination($destination1); // Gibt null zurück, die Seite 3 ist bis jetzt nicht im Dokument enthalten $page = $pdf->resolveDestination($destination2); $pdf->setNamedDestination('Page2', $destination1); $pdf->setNamedDestination('Page3', $destination2); // Gibt $destination2 zurück $destination = $pdf->getNamedDestination('Page3'); // Gibt $destination1 zurück $pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page2')); // Gibt null zurück, die Seite 3 ist bis jetzt nicht im Dokument enthalten $pdf->resolveDestination(Zend_Pdf_Destination_Named::create('Page3')); ]]> Statt einfach zu einem Ziel im Dokument zu springen, kann ein Hinweis oder Outline Element eine Aktion für die Viewer Anwendung spezifizieren die auszuführen ist, wie das starten einer Anwendung, das Abspielen eines Sounds, oder der Änderung der Sichtweise des Hinweis Status. Die folgenden Typen von Aktionen werden beim Laden vom PDF Dokument erkannt: Zend_Pdf_Action_GoTo - geht zu einem Ziel im aktuellen Dokument. Zend_Pdf_Action_GoToR - geht zu einem Ziel in einem anderen Dokument. Zend_Pdf_Action_GoToE - geht zu einem Ziel in einem eingebetteten Dokument. Zend_Pdf_Action_Launch - startet eine Anwendung, öffnet oder druckt ein Dokument. Zend_Pdf_Action_Thread - beginnt einen Artikel Thread zu lesen. Zend_Pdf_Action_URI - löst ein URI auf. Zend_Pdf_Action_Sound - spielt einen Sound. Zend_Pdf_Action_Movie - spielt einen Film. Zend_Pdf_Action_Hide - versteckt oder zeigt einen oder mehrere Hinweise auf dem Bildschirm. Zend_Pdf_Action_Named - führt eine vordefinierte Aktion an der Viewer Anwendung aus: NextPage - Geht zur nächsten Seite des Dokuments. PrevPage - Geht zur vorhergehenden Seite des Dokuments. FirstPage - Geht zur ersten Seite des Dokuments. LastPage - Geht zur letzten Seite des Dokuments. Zend_Pdf_Action_SubmitForm - sendet Daten zu einem eindeutigen Ressourcenziel. Zend_Pdf_Action_ResetForm - setzt Felder mit Ihren Standardwerten. Zend_Pdf_Action_ImportData - importiert Feldwerte von einer Datei. Zend_Pdf_Action_JavaScript - führt ein JavaScript Skript aus. Zend_Pdf_Action_SetOCGState - setzt den Status von einem oder mehreren optionalen Inhaltsgruppen. Zend_Pdf_Action_Rendition - kontrolliert das Abspielen von Multimedia Inhalten (Beginnen, Stoppen, Pausieren oder Fortsetzen des Abspielens). Zend_Pdf_Action_Trans - Aktualisiert das Display eines Dokuments indem ein Übersetzungsverzeichnis verwendet wird. Zend_Pdf_Action_GoTo3DView - setzt die aktuelle Ansicht eines 3D Hinweises. Nur Zend_Pdf_Action_GoTo und Zend_Pdf_Action_URI Aktionen können aktuell von Benutzern erstellt werden. Goto Aktionen können erstellt werden indem die Methode Zend_Pdf_Action_GoTo::create($destination) verwendet wird wobei $destination ein Zend_Pdf_Destination Objekt oder ein String ist der verwendet werden kann um ein benanntes Ziel zu identifizieren. Die Methode Zend_Pdf_Action_URI::create($uri[, $isMap]) muss verwendet werden um eine URI Aktion zu erstellen (siehe die API Dokumentation für Details). Der optionale $isMap Parameter wird standardmäßig auf FALSE gesetzt. Es unterstützt auch die folgenden Methoden: Aktions Objekte können verkettet werden indem die öffentliche Eigenschaft Zend_Pdf_Action::$next verwendet wird. Sie ist ein Array von Zend_Pdf_Action Objekten, welche auch Unter-Aktionen haben können. Die Zend_Pdf_Action Klasse unterstützt das RecursiveIterator Interface damit Kinder-Aktionen iterativ durchlaufen werden können: newPage(Zend_Pdf_Page::SIZE_A4); $page2 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4); // Seite erstellt, aber nicht in der Seitenliste hinzugefügt $page3 = $pdf->newPage(Zend_Pdf_Page::SIZE_A4); $pdf->pages[] = $page1; $pdf->pages[] = $page2; $action1 = Zend_Pdf_Action_GoTo::create( Zend_Pdf_Destination_Fit::create($page2)); $action2 = Zend_Pdf_Action_GoTo::create( Zend_Pdf_Destination_Fit::create($page3)); $action3 = Zend_Pdf_Action_GoTo::create( Zend_Pdf_Destination_Named::create('Chapter1')); $action4 = Zend_Pdf_Action_GoTo::create( Zend_Pdf_Destination_Named::create('Chapter5')); $action2->next[] = $action3; $action2->next[] = $action4; $action1->next[] = $action2; $actionsCount = 1; // Achtung! Iteration enthält nicht die oberste Aktion und // Arbeitet sich nur durch die Kinder $iterator = new RecursiveIteratorIterator( $action1, RecursiveIteratorIterator::SELF_FIRST); foreach ($iterator as $chainedAction) { $actionsCount++; } // Ausgabe 'Aktionen im Baum: 4' printf("Aktionen im Baum: %d\n", $actionsCount++); ]]> Eine spezielle Öffnen Aktion kann durch ein Ziel spezifiziert werden das angezeigt werden soll, oder eine Aktion die ausgeführt werden soll wenn das Dokument geöffnet wird. Die Zend_Pdf_Target Zend_Pdf::getOpenAction() Methode gibt die aktuelle Dokument Öffnen Aktion zurück (oder NULL wenn die Öffnen Aktion nicht gesetzt ist). Die setOpenAction(Zend_Pdf_Target $openAction = null) Methode setzt eine Dokument Öffnen Aktion oder löscht diese wenn $openAction NULL ist. Ein PDF Dokument kann optional ein Dokument Outline am Schirm anzeigen, welcher es dem Benutzer erlaubt interaktiv von einem Teil des Dokuments zu einem anderen zu navigieren. Der Outline besteht aus einer baum-strukturierten Hierarchie von Outline Elementen (manchmal Bookmarks genannt), welche als visuelle Tabelle des Inhalts fungieren um dem Benutzer die Struktur des Dokuments anzuzeigen. Der Benutzer kann individuelle Elemente interaktiv öffnen und schließen indem er Sie mit der Maus anklickt. Wenn ein Element geöffnet ist, werden seine unmittelbaren Kinder in der Hierarchie auf dem Schirm sichtbar; jedes Kind kann seinerseits geöffnet und geschlossen werden, das weitere Teile der Hierarchie selektiv anzeigt oder versteckt. Wenn ein Element geschlossen wird, werden alle seine abhängigen Elemente in der Hierarchie versteckt. Das Klicken auf einen Text von irgendeinem sichtbaren Element aktiviert dieses Element, was dazu führt das die anzeigende Anwendung zum Ziel springt oder eine mit dem Element assoziierte Aktion ausführt. Die Klasse Zend_Pdf bietet eine öffentliche Eigenschaft $outlines welche ein Array von Zend_Pdf_Outline Objekten ist. outlines[0]->childOutlines[1]); // Setzt Outline damit es Dick angezeigt wird $pdf->outlines[0]->childOutlines[3]->setIsBold(true); // Fügt den Outline Eintrag hinzu $pdf->outlines[0]->childOutlines[5]->childOutlines[] = Zend_Pdf_Outline::create('Chapter 2', 'chapter_2'); $pdf->save($path, true); ]]> Outline Attribute können mit Hilfe der folgenden Methoden empfangen oder gesetzt werden: string getTitle() - holt den Titel des Outline Elements. setTitle(string $title) - setzt den Titel des Outline Elements. boolean isOpen() - TRUE wenn Outline standardmäßig geöffnet ist. setIsOpen(boolean $isOpen) - setzt den isOpen Status. boolean isItalic() - TRUE wenn das Outline Element schräg dargestellt wird. setIsItalic(boolean $isItalic) - setzt den isItalic Status. boolean isBold() - TRUE wenn das Outline Element dick dargestellt wird. setIsBold(boolean $isBold) - setzt den isBold Status. Zend_Pdf_Color_Rgb getColor() - holt die Outline Text Farbe (NULL bedeutet schwarz). setColor(Zend_Pdf_Color_Rgb $color) - setzt die Outline Text Farbe (NULL bedeutet schwarz). Zend_Pdf_Target getTarget() - holt das Outline Ziel (eine Aktion oder ein benanntes Zielobjekt). setTarget(Zend_Pdf_Target|string $target) - setzt ein Outline Ziel (Aktion oder Ziel). Ein String kann verwendet werden um ein benanntes Ziel zu identifizieren. NULL bedeutet 'kein Ziel'. array getOptions() - holt die Outline Attribute als Array. setOptions(array $options) - setzt Outline Optionen. Die folgenden Optionen werden erkannt: 'title', 'open', 'color', 'italic', 'bold', und 'target'. Ein neues Outline kann auf folgenden zwei Wegen erstellt werden: Zend_Pdf_Outline::create(string $title[, Zend_Pdf_Target|string $target]) Zend_Pdf_Outline::create(array $options) Jedes Outline Objekt kann Kinder-Outline Elemente haben die in der öffentlichen Eigenschaft Zend_Pdf_Outline::$childOutlines aufgelistet werden. Das ist ein Array von Zend_Pdf_Outline Objekten. Deshalb sind Outlines als Baum organisiert. Die Klasse Zend_Pdf_Outline implementiert das RecursiveArray Interface damit man durch Kinder-Outlines rekursiv iterieren kann indem RecursiveIteratorIterator verwendet wird: outlines as $documentRootOutlineEntry) { $iterator = new RecursiveIteratorIterator( $documentRootOutlineEntry, RecursiveIteratorIterator::SELF_FIRST ); foreach ($iterator as $childOutlineItem) { $OutlineItemTarget = $childOutlineItem->getTarget(); if ($OutlineItemTarget instanceof Zend_Pdf_Destination) { if ($pdf->resolveDestination($OutlineItemTarget) === null) { // Markiert ein Outline Element dessen Ziel // nicht auflösbar ist mit Roter Farbe $childOutlineItem->setColor(new Zend_Pdf_Color_Rgb(1, 0, 0)); } } else if ($OutlineItemTarget instanceof Zend_Pdf_Action_GoTo) { $OutlineItemTarget->setDestination(); if ($pdf->resolveDestination($OutlineItemTarget) === null) { // Markiert ein Outline Element dessen Ziel // nicht auflösbar ist mit Roter Farbe $childOutlineItem->setColor(new Zend_Pdf_Color_Rgb(1, 0, 0)); } } } } $pdf->save($path, true); ]]> Alle Outline Elemente mit unlösbaren Zielen (oder Zielen auf GoTo Aktionen) werden aktualisiert während das dokument gespeichert wird, indem dessen Ziele auf NULL gesetzt werden. Damit wird das Dokument nicht durch Entfernen von Seiten korrupiert auf die durch Outlines referenziert wird. Ein Anhang assoziiert ein Objekt wie eine Notiz, einen Sound, oder einen Film mit einem Ort auf einer Seite in einem PDF Dokument, oder bietet einen Weg um mit dem Benutzer zu interagieren, durch Verwendung von Maus und Tastatur. Alle Anhänge werden durch die abstrakte Klasse Zend_Pdf_Annotation repräsentiert. Anhänge können einer Seite angehängt werden indem die Methode Zend_Pdf_Page::attachAnnotation(Zend_Pdf_Annotation $annotation) verwendet wird. Aktuell können drei Typen von Anhängen von Benutzern erstellt werden: Zend_Pdf_Annotation_Link::create($x1, $y1, $x2, $y2, $target) wobei $target ein Aktionsobjekt oder ein Ziel oder ein String ist (welche für ein benanntes Zielobjekt verwendet werden kann). Zend_Pdf_Annotation_Text::create($x1, $y1, $x2, $y2, $text) Zend_Pdf_Annotation_FileAttachment::create($x1, $y1, $x2, $y2, $fileSpecification) Ein Link-Anhang repräsentiert entweder einen Hypertext Link oder ein Ziel anderswo im Dokument oder eine Aktion die ausgeführt werden soll. Ein Text Anhang repräsentiert eine "schnelle Notiz" die an einem Punkt im PDF Dokument angehängt ist. Ein File Anhang enthält eine Referenz zu einer Datei. Die folgenden Methoden können von allen Typen von Anhängen verwendet werden: setLeft(float $left) float getLeft() setRight(float $right) float getRight() setTop(float $top) float getTop() setBottom(float $bottom) float getBottom() setText(string $text) string getText() Die Text Anhang Eigenschaft ist ein Text der für den Anhang dargestellt wird oder, wenn dieser Typ von Anhang keinen Text darstellt, eine alternative Beschreibung des Inhalts des Anhangs in einer menschlich lesbaren Form. Link Anhangs Objekte bieten auch zwei zusätzliche Methoden: setDestination(Zend_Pdf_Target|string $target) Zend_Pdf_Target getDestination()