|
Size: | 61366 |
Storage flags: | no_autoload,compress/gzip (15%) |
A destination defines a particular view of a document, consisting of the following items:
Destinations may be associated with outline items (Document Outline (bookmarks)), annotations (Annotations), or actions (Actions). In each case, the destination specifies the view of the document to be presented when the outline item or annotation is opened or the action is performed. In addition, the optional document open action can be specified.
The following types are supported by ZendPdf component.
Display the specified page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom.
Destination object may be created using ZendPdf\Destination\Zoom::create($page, $left = null, $top = null, $zoom = null) method.
Where:
NULL, specified for $left, $top or $zoom parameter means “current viewer application value”.
ZendPdf\Destination\Zoom class also provides the following methods:
Display the specified page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. Display the specified page, with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
Destination object may be created using ZendPdf\Destination\Fit::create($page) method.
Where $page is a destination page (a ZendPdf\Page object or a page number).
Display the specified page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window.
Destination object may be created using ZendPdf\Destination\FitHorizontally::create($page, $top) method.
Where:
ZendPdf\Destination\FitHorizontally class also provides the following methods:
Display the specified page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window.
Destination object may be created using ZendPdf\Destination\FitVertically::create($page, $left) method.
Where:
ZendPdf\Destination\FitVertically class also provides the following methods:
Display the specified page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.
Destination object may be created using ZendPdf\Destination\FitRectangle::create($page, $left, $bottom, $right, $top) method.
Where:
ZendPdf\Destination\FitRectangle class also provides the following methods:
Display the specified page, with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.
Destination object may be created using ZendPdf\Destination\FitBoundingBox::create($page, $left, $bottom, $right, $top) method.
Where $page is a destination page (a ZendPdf\Page object or a page number).
Display the specified page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window.
Destination object may be created using ZendPdf\Destination\FitBoundingBoxHorizontally::create($page, $top) method.
Where
ZendPdf\Destination\FitBoundingBoxHorizontally class also provides the following methods:
Display the specified page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window.
Destination object may be created using ZendPdf\Destination\FitBoundingBoxVertically::create($page, $left) method.
Where
ZendPdf\Destination\FitBoundingBoxVertically class also provides the following methods:
All destinations listed above are “Explicit Destinations”.
In addition to this, PDF document may contain a dictionary of such destinations which may be used to reference from outside the PDF (e.g. ‘http://www.mycompany.com/document.pdf#chapter3‘).
ZendPdf\Destination\Named objects allow to refer destinations from the document named destinations dictionary.
Named destination object may be created using ZendPdf\Destination\Named::create(string $name) method.
ZendPdf\Destination\Named class provides the only one additional method:
String getName();
ZendPdf\PdfDocument class provides a set of destinations processing methods.
Each destination object (including named destinations) can be resolved using the resolveDestination($destination) method. It returns corresponding ZendPdf\Page object, if destination target is found, or NULL otherwise.
ZendPdf\PdfDocument::resolveDestination() method also takes an optional boolean parameter $refreshPageCollectionHashes, which is TRUE by default. It forces ZendPdf\PdfDocument object to refresh internal page collection hashes since document pages list may be updated by user using ZendPdf\PdfDocument::$pages property (Working with Pages). It may be turned off for performance reasons, if it’s known that document pages list wasn’t changed since last method request.
Complete list of named destinations can be retrieved using ZendPdf\PdfDocument::getNamedDestinations() method. It returns an array of ZendPdf\Target objects, which are actually either an explicit destination or a GoTo action (Actions).
ZendPdf\PdfDocument::getNamedDestination(string $name) method returns specified named destination (an explicit destination or a GoTo action).
PDF document named destinations dictionary may be updated with ZendPdf\PdfDocument::setNamedDestination(string $name, $destination) method, where $destination is either an explicit destination (any destination except ZendPdf\Destination\Named) or a GoTo action.
If NULL is specified in place of $destination, then specified named destination is removed.
Note
Unresolvable named destinations are automatically removed from a document while document saving.
Destinations usage example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | $pdf = new ZendPdf\PdfDocument();
$page1 = $pdf->newPage(ZendPdf\Page::SIZE_A4);
$page2 = $pdf->newPage(ZendPdf\Page::SIZE_A4);
$page3 = $pdf->newPage(ZendPdf\Page::SIZE_A4);
// Page created, but not included into pages list
$pdf->pages[] = $page1;
$pdf->pages[] = $page2;
$destination1 = ZendPdf\Destination\Fit::create($page2);
$destination2 = ZendPdf\Destination\Fit::create($page3);
// Returns $page2 object
$page = $pdf->resolveDestination($destination1);
// Returns null, page 3 is not included into document yet
$page = $pdf->resolveDestination($destination2);
$pdf->setNamedDestination('Page2', $destination1);
$pdf->setNamedDestination('Page3', $destination2);
// Returns $destination2
$destination = $pdf->getNamedDestination('Page3');
// Returns $destination1
$pdf->resolveDestination(ZendPdf\Destination\Named::create('Page2'));
// Returns null, page 3 is not included into document yet
$pdf->resolveDestination(ZendPdf\Destination\Named::create('Page3'));
|
Instead of simply jumping to a destination in the document, an annotation or outline item can specify an action for the viewer application to perform, such as launching an application, playing a sound, or changing an annotation’s appearance state.
The following action types are recognized while loading PDF document:
Only ZendPdf\Action\GoTo and ZendPdf\Action\URI actions can be created by user now.
GoTo action object can be created using ZendPdf\Action\GoTo::create($destination) method, where $destination is a ZendPdf\Destination object or a string which can be used to identify named destination.
ZendPdf\Action\URI::create($uri[, $isMap]) method has to be used to create a URI action (see API documentation for the details). Optional $isMap parameter is set to FALSE by default.
It also supports the following methods:
Actions objects can be chained using ZendPdf\Action::$next public property.
It’s an array of ZendPdf\Action objects, which also may have their sub-actions.
ZendPdf\Action class supports RecursiveIterator interface, so child actions may be iterated recursively:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 | $pdf = new ZendPdf\PdfDocument();
$page1 = $pdf->newPage(ZendPdf\Page::SIZE_A4);
$page2 = $pdf->newPage(ZendPdf\Page::SIZE_A4);
// Page created, but not included into pages list
$page3 = $pdf->newPage(ZendPdf\Page::SIZE_A4);
$pdf->pages[] = $page1;
$pdf->pages[] = $page2;
$action1 = ZendPdf\Action\GoTo::create(
ZendPdf\Destination\Fit::create($page2));
$action2 = ZendPdf\Action\GoTo::create(
ZendPdf\Destination\Fit::create($page3));
$action3 = ZendPdf\Action\GoTo::create(
ZendPdf\Destination\Named::create('Chapter1'));
$action4 = ZendPdf\Action\GoTo::create(
ZendPdf\Destination\Named::create('Chapter5'));
$action2->next[] = $action3;
$action2->next[] = $action4;
$action1->next[] = $action2;
$actionsCount = 1; // Note! Iteration doesn't include top level action and
// walks through children only
$iterator = new RecursiveIteratorIterator(
$action1,
RecursiveIteratorIterator::SELF_FIRST);
foreach ($iterator as $chainedAction) {
$actionsCount++;
}
// Prints 'Actions in a tree: 4'
printf("Actions in a tree: %d\n", $actionsCount++);
|
Special open action may be specify a destination to be displayed or an action to be performed when the document is opened.
ZendPdf\Target ZendPdf\PdfDocument::getOpenAction() method returns current document open action (or NULL if open action is not set).
setOpenAction(ZendPdf\Target $openAction = null) method sets document open action or clean it if $openAction is NULL.
A PDF document may optionally display a document outline on the screen, allowing the user to navigate interactively from one part of the document to another. The outline consists of a tree-structured hierarchy of outline items (sometimes called bookmarks), which serve as a visual table of contents to display the document’s structure to the user. The user can interactively open and close individual items by clicking them with the mouse. When an item is open, its immediate children in the hierarchy become visible on the screen; each child may in turn be open or closed, selectively revealing or hiding further parts of the hierarchy. When an item is closed, all of its descendants in the hierarchy are hidden. Clicking the text of any visible item activates the item, causing the viewer application to jump to a destination or trigger an action associated with the item.
ZendPdf\PdfDocument class provides public property $outlines which is an array of ZendPdf\Outline objects.
1 2 3 4 5 6 7 8 9 10 11 12 13 $pdf = ZendPdf\PdfDocument::load($path); // Remove outline item unset($pdf->outlines[0]->childOutlines[1]); // Set Outline to be displayed in bold $pdf->outlines[0]->childOutlines[3]->setIsBold(true); // Add outline entry $pdf->outlines[0]->childOutlines[5]->childOutlines[] = ZendPdf\Outline::create('Chapter 2', 'chapter_2'); $pdf->save($path, true);
Outline attributes may be retrieved or set using the following methods:
New outline may be created in two ways:
Each outline object may have child outline items listed in ZendPdf\Outline::$childOutlines public property. It’s an array of ZendPdf\Outline objects, so outlines are organized in a tree.
ZendPdf\Outline class implements RecursiveArray interface, so child outlines may be recursively iterated using RecursiveIteratorIterator:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 | $pdf = ZendPdf\PdfDocument::load($path);
foreach ($pdf->outlines as $documentRootOutlineEntry) {
$iterator = new RecursiveIteratorIterator(
$documentRootOutlineEntry,
RecursiveIteratorIterator::SELF_FIRST
);
foreach ($iterator as $childOutlineItem) {
$OutlineItemTarget = $childOutlineItem->getTarget();
if ($OutlineItemTarget instanceof ZendPdf\Destination) {
if ($pdf->resolveDestination($OutlineItemTarget) === null) {
// Mark Outline item with unresolvable destination
// using RED color
$childOutlineItem->setColor(new ZendPdf\Color\Rgb(1, 0, 0));
}
} else if ($OutlineItemTarget instanceof ZendPdf\Action\GoTo) {
$OutlineItemTarget->setDestination();
if ($pdf->resolveDestination($OutlineItemTarget) === null) {
// Mark Outline item with unresolvable destination
// using RED color
$childOutlineItem->setColor(new ZendPdf\Color\Rgb(1, 0, 0));
}
}
}
}
$pdf->save($path, true);
|
Note
All outline items with unresolved destinations (or destinations of GoTo actions) are updated while document saving by setting their targets to NULL. So document will not be corrupted by removing pages referenced by outlines.
An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.
All annotations are represented by ZendPdf\Annotation abstract class.
Annotation may be attached to a page using ZendPdf\Page::attachAnnotation(ZendPdf\Annotation $annotation) method.
Three types of annotations may be created by user now:
A link annotation represents either a hypertext link to a destination elsewhere in the document or an action to be performed.
A text annotation represents a “sticky note” attached to a point in the PDF document.
A file attachment annotation contains a reference to a file.
The following methods are shared between all annotation types:
Text annotation property is a text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation’s contents in human-readable form.
Link annotation objects also provide two additional methods:
The source code of this file is hosted on GitHub. Everyone can update and fix errors in this document with few clicks - no downloads needed.