What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

pdf_add_bookmark
Prev	XLVI. PDF Functions	Next

pdf_add_bookmark

Name

pdf_add_bookmark — Adds bookmark for current page

Synopsis

int pdf_add_bookmark(pdf, name[, parent][, open]); resource pdf: PDF object identifier string name: Bookmark name int parent (optional): Parent bookmark int open (optional): Open bookmarks flag

Returns

Bookmark identifier.

Description

Adds a bookmark the the current page. This is displayed in the "bookmarks" pane in most PDF readers and allows a user to quickly jump to the bookmarked page of the document.

Returns a bookmark identifier which can be used to denote the parent in another pdf_add_bookmark() function call. While the parent parameter is optional, specifying no bookmark or a bookmark of 0 means the bookmark will be created as a top-level bookmark. Specifying a value of 1 for the open parameter means that children bookmarks will be displayed in expanded form. A value of 0 means the bookmarks children will be hidden.

In the example below, the bookmarks pane is shown as open when the document is opened using pdf_set_parameter() .

Version

Since version 4.0.5

Example

Example 905. Create parent and child bokmark

<?php
//create new document
$pdf = pdf_new();
pdf_open_file($pdf);

pdf_begin_page($pdf, 500, 700);

// show bookmarks pane on document open
pdf_set_parameter($pdf, "openmode", "bookmarks");

// add parent bookmark
$bookmark = pdf_add_bookmark($pdf, "Parent Bookmark");

$font = pdf_findfont($pdf, "Courier", "host", 0);
pdf_setfont($pdf, $font, 20);
pdf_show_xy($pdf, "Hello World", 50, 650);

// add child bookmark
$bookmark = pdf_add_bookmark($pdf, "Child Bookmark", $bookmark);

pdf_end_page($pdf);
pdf_close($pdf);

// display document
$data = pdf_get_buffer($pdf);
header("Content-type: application/pdf");
header("Content-disposition: inline; filename=test.pdf");
header("Content-length: " . strlen($data));
echo $data;
?>

Prev	Home	Next
XLVI. PDF Functions	Up	pdf_add_launchlink

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.