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

pdf_get_parameter
Prev	XLVI. PDF Functions	Next

pdf_get_parameter

Name

pdf_get_parameter — Gets arbitrary parameters value

Synopsis

string pdf_get_parameter(pdf, key[, modifier]); resource pdf: PDF object identifier string key: Parameter name mixed modifier (optional): modifier explanation goes here

Returns

Parameter value

Description

Gets the current setting of a parameter in the PDF document. This could be a default value or a value set using pdf_set_parameter() . Only a subset of the values able to be set with pdf_set_parameter() can be retrieved using this function. These are underline, overline and strikeout. Other parameters that can be accessed are:

fontname	Current name of the font set with pdf_setfont()
fontencoding	Current encoding of the font set with pdf_setfont()
pdi	Retuns 'true' is the PDI library is present

Version

Since version 4.0.1

Example

Example 938. Get value of underline parameter

<?php

// create new document
$pdf = pdf_new();
pdf_open_file($pdf);
pdf_begin_page($pdf, 500, 700);

// get value of underline
$underline = pdf_get_parameter($pdf, "underline");

$font = pdf_findfont($pdf, "Courier", "host", 0);
pdf_setfont($pdf, $font, 10);
pdf_show_xy($pdf, "Underline setting: $underline", 20, 650);

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

// output 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
pdf_get_buffer	Up	pdf_get_pdi_parameter

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.