PHP  
downloads | documentation | faq | getting help | mailing lists | | php.net sites | links | my php.net 
search for in the  
<unlinkfdf_add_doc_javascript>
view the version of this page
Last updated: Sat, 19 Apr 2003

XXXI. Forms Data Format Funktionen

Einf�hrung

Forms Data Format (FDF) ist ein Format zur Verarbeitung von Formularen innerhalb von PDF Dokumenten. Weiterf�hrende Informationen zu FDF und dessen Verwendung sind unter zu finden.

Der Ansatz den FDF verfolgt, ist vergleichbar mit dem �blicher HTML Formulare. Die wesentlichen Unterschiede liegen in der �bertragung der Daten nach Absenden des Formulars (dies ist das eigentliche Form Data Format), sowie in dem Format des Dokuments welches das Formular enth�lt(PDF). Die Verarbeitung der FDF Daten ist eine der M�glichkeiten, die die FDF Funktionen bereitstellen. Dar�ber hinaus kann man beispielsweise innerhalb eines vorhandenen PDF Formulars die Input Felder dynamisch mit Daten f�llen, ohne das Formular selbst zu ver�ndern. Hierzu erzeugt man das FDF Dokument (fdf_create()), setzt die Werte der jeweiligen Input Felder (fdf_set_value()) und verbindet es mit dem jeweiligen PDF Formular (fdf_set_file()). Nachdem man das FDF Dokument, mit dem passenden MimeType application/vnd.fdf versehen, ausgegeben hat, erkennt das Acrobat Reader PlugIn des Browsers den MimeType und f�llt das Zielformular mit den Daten des FDF Dokuments.

Betrachtet man ein FDF Dokument mit einem Text Editor, findet sich dort ein Katalog-Objekt FDF. Dieses Objekt kann mehrere Eintr�ge der Art Fields, F, Status etc.. enthalten. Die gebr�uchlichsten Eintr�ge sind Fields, welches zu einer Anzahl von Input Feldern verweist, sowie F das den Dateinamen des zugeh�rigen PDF Dokuments enth�lt. Diese Eintr�ge finden sich in der FDF Dokumentation unter /F-Key oder /Status-Key. Modifikationen dieser Eintr�ge werden mit Hilfe der Funktionen fdf_set_file() und fdf_set_status() vorgenommen. Felder werden u.a. mit fdf_set_value(), fdf_set_opt() modifiziert.

Anforderungen

Ben�tigt wird das FDF-Toolkit-SDK, welches unter heruntergeladen werden kann. Ab PHP-Version 4.3 ist mindestens die Version 5.0 des FDF-SDKs erforderlich. Die FDF-Toolkit Bibliothek steht ausschlie�lich vorkompiliert zur Verf�gung. Von Adobe unterst�tze Plattformen sind Win32, Linux, Solaris und AIX.

Installation

You must compile PHP with --with-fdftk[=DIR].

Anmerkung: If you run into problems configuring PHP with fdftk support, check whether the header file fdftk.h and the library libfdftk.so are at the right place. The configure script supports both the directory structure of the FDF SDK distribution and the usual DIR/include / DIR/lib layout, so you can point it either directly to the unpacked distribution directory or put the header file and the appropriate library for your platform into e.g. /usr/local/include and /usr/local/lib and configure with --with-fdftk=/usr/local.

Note to Win32 Users: In order to enable this module on a Windows environment, you must copy fdftk.dll from the DLL folder of the PHP/Win32 binary package to the SYSTEM32 folder of your windows machine. (Ex: C:\WINNT\SYSTEM32 or C:\WINDOWS\SYSTEM32)

Laufzeit Konfiguration

Diese Erweiterung definiert keine Konfigurationseinstellungen in der php.ini.

Resource Typen

fdf

Die meisten FDF-Funktionen ben�tigen an erster Stelle einen fdf Ressource-Parameter. Der Parameter fdf ist ein Zeiger auf eine ge�ffnete FDF-Datei. fdf Ressource-Parameter werden von den Funktionen fdf_create(), fdf_open() und fdf_open_string() zur�ckgegeben.

Vordefinierte Konstanten

Folgende Konstanten werden von dieser Erweiterung definiert und stehen nur zur Verf�gung, wenn die Erweiterung entweder statisch in PHP kompiliert oder dynamisch zur Laufzeit geladen wurde.

FDFValue (integer)

FDFStatus (integer)

FDFFile (integer)

FDFID (integer)

FDFFf (integer)

FDFSetFf (integer)

FDFClearFf (integer)

FDFFlags (integer)

FDFSetF (integer)

FDFClrF (integer)

FDFAP (integer)

FDFAS (integer)

FDFAction (integer)

FDFAA (integer)

FDFAPRef (integer)

FDFIF (integer)

FDFEnter (integer)

FDFExit (integer)

FDFDown (integer)

FDFUp (integer)

FDFFormat (integer)

FDFValidate (integer)

FDFKeystroke (integer)

FDFCalculate (integer)

FDFNormalAP (integer)

FDFRolloverAP (integer)

FDFDownAP (integer)

Beispiele

Das Beispiel zeigt die Auswertung der Formular Daten.

Beispiel 1. Auswertung eines FDF_Dokuments

<?php
// Speichern der FDF Daten in eine tempor�re Datei
$fdffp = fopen("test.fdf", "w");
fwrite($fdffp, $HTTP_FDF_DATA, strlen($HTTP_FDF_DATA));
fclose($fdffp);

// �ffnen der tempor�ren Datei und Auswertung der Daten
// Das PDF Formular enth�lt verschiedene Eingabefelder mit den zugeh�rigen Namen
// band, datum, kommentar, verleger, bearbeiter, sowie zwei Checkboxen
// zeige_verleger und zeige_bearbeiter.

$fdf = fdf_open("test.fdf");
$band = fdf_get_value($fdf, "band");
echo "Das Feld Band hat den Wert '<B>$band</B>'<BR>";

$datum = fdf_get_value($fdf, "datum");
echo "Das Feld Datum hat den Wert '<B>$datum</B>'<BR>";

$kommentar = fdf_get_value($fdf, "kommentar");
echo "Das Feld Kommentar hat den Wert '<B>$kommentar</B>'<BR>";

if (fdf_get_value($fdf, "zeige_verleger") == "On") {
    $verleger = fdf_get_value($fdf, "verleger");
    echo "Das Feld Verleger hat den Wert '<B>$verleger</B>'<BR>";
} else {
  echo "Verleger soll nicht angezeigt werden.<BR>";
}

if (fdf_get_value($fdf, "zeige_bearbeiter") == "On") {
  $bearbeiter = fdf_get_value($fdf, "bearbeiter");
  echo "Das Feld Bearbeiter hat den Wert '&<B>$bearbeiter</B>'<BR>";
} else {
  echo "Bearbeiter soll nicht angezeigt werden.<BR>";
}
fdf_close($fdf);
?>

Inhaltsverzeichnis
fdf_add_doc_javascript -- Adds javascript code to the FDF document
fdf_add_template -- F�gt dem FDF Dokument ein Template hinzu
fdf_close -- Schlie�t ein FDF Dokument
fdf_create -- Erzeugt ein neues FDF Dokument
fdf_enum_values -- Call a user defined function for each document value
fdf_errno -- Return error code for last fdf operation
fdf_error -- Return error description for fdf error code
fdf_get_ap -- Get the appearance of a field
fdf_get_attachment -- Extracts uploaded file embedded in the FDF
fdf_get_encoding -- Get the value of the /Encoding key
fdf_get_file -- Gibt den Wert des /F Schl�ssels zur�ck
fdf_get_flags -- Gets the flags of a field
fdf_get_opt -- Gets a value from the opt array of a field
fdf_get_status --  Gibt den Wert des /STATUS Schl�ssels zur�ck
fdf_get_value -- Gibt den Wert eines Feldes zur�ck
fdf_get_version -- Gets version number for FDF api or file
fdf_header -- Sets FDF-specific output headers
fdf_next_field_name -- Gibt den Namen des n�chsten Feldes zur�ck
fdf_open_string -- Read a FDF document from a string
fdf_open -- �ffnet ein FDF Dokument
fdf_remove_item -- Sets target frame for form
fdf_save_string -- Returns the FDF document as a string
fdf_save -- Speichern eines FDF Dokuments
fdf_set_ap -- Legt das Aussehen eines Feldes fest
fdf_set_encoding --  Legt die Kodierung des FDF Zeichensatzes fest
fdf_set_file -- Definiert ein PDF-Dokument, das FDF-Daten anzeigen soll
fdf_set_flags -- Setzt Flags eines Feldes
fdf_set_javascript_action --  Weist einem Feld eine Javascript Aktion zu
fdf_set_opt -- Setzt die Option eines Feldes
fdf_set_status -- Setzt den Wert des /STATUS Schl�ssels
fdf_set_submit_form_action --  Setzt die 'Submit Form Action' f�r ein Feld
fdf_set_target_frame -- Set target frame for form display
fdf_set_value -- Setzt den Wert eines Feldes
fdf_set_version -- Sets version number for a FDF file


User Contributed Notes
Forms Data Format Funktionen
add a note
joe at koontz dot net
28-Apr-2000 11:42

The simplest thing to do is get the FDF data from $HTTP_RAW_POST_DATA. (unless you have the server library installed none of the fdf data gets parsed!) This is typical of  what you get:
%FDF-1.2
1 0 obj
<<
/FDF << /Fields [ << /V (0)/T (amount0)>> << /V (0)/T (amount1)>> << /V (0)/T (amount2)>>
<< /V (0)/T (amount3)>> << /V (0)/T (amount4)>> << /V (0)/T (amount5)>>
<< /V (0)/T (amount6)>> << /V (0)/T (amount7)>> << /V (0)/T (amount8)>>
<< /V (0)/T (amount9)>> << /V /0102 /T (chase_bk)>> << /V (0)/T (count)>>
<< /V (0)/T (invtotal)>> << /V (12/21/2000)/T (sent_ap)>> << /V /Off /T (spec_hand)>>
<< /V (041232)/T (transit_no)>> << /V (THIS FORM IS NOT COMPLETE!!!)/T (X)>>
]
/F ()>>
>>
endobj
trailer
<<
/Root 1 0 R

>>
%%EOF
kill everything before the [ and then parse it down into key value pairs.  
I wrote this to create an FDF, make sure you do a
header("Content-type: application/vnd.fdf");
before you echo the returned value to the user.
function FDFput(,$FDFpage)
{
$A = "%FDF-1.2\n1 0 obj\n<< \n/FDF << /Fields [ \n";
$C = " ] \n" ;
if ($FDFpage>"" ) {$C .=" /F ($FDFpage)>>\n";}
$C .= ">>\n>> \nendobj\ntrailer\n\n<</Root 1 0 R>>\n%%EOF\n";
$B = "";
reset($FDFData);
while (list($key, $val) = each($FDFData))
 {
 if (strlen(trim($val)) > 0 && is_string($key))
  {
$B .= "<</T ($key) /V (". $val . ")>>\n";
//echo "<</T ($key) /V (". $val . ")>>\n";
}
 }
return $A.$B.$C;
}

It ain't perfect - but it works. (I use HTML for posting to the server, FDF to the browser)
joe

gregDELETETHIS at laundrymat dot tv
21-Dec-2001 10:06

Here is an easy script to output fdf data to the browser without using the fdf toolkit or creating an actual fdf file on the server.
By the way acrobat is very picky about line breaks so you must leave the "\n" in the script. The script reads the variables posted to it from a form use POST and creates a fdf file from them. The field names posted to this script must match the field names in the pdf. Acrobat will ignore any that don't match.

<?php

//path to pdf file
$url="

$values=$HTTP_POST_VARS;

$fdfdata = "%FDF-1.2\n%����\n";
$fdfdata .= "1 0 obj \n<< /FDF ";
$fdfdata .= "<< /Fields [\n";

//loop that adds the field names and values
foreach($values as $key=>$val)
{
$fdfdata.="<< /V ($val)/T ($key) >> ";
}


$fdfdata .= "]\n";
$fdfdata .= "/F ($url) >>";
$fdfdata .= ">>\nendobj\ntrailer\n<<\n/Root 1 0 R\n>>\n";
$fdfdata .= "%%EOF";

/*** Now we display the FDF data which causes Acrobat to start ***/

header ("Content-Type: application/vnd.fdf");
print $fdfdata;

?>

You can use javascript in the pdf to read the values from a GET method posted directly to the pdf. you can see both methods here:

noah at NOSPAMbrandfidelity dot com
09-Mar-2002 03:26

function parse($file) {
               if (!preg_match_all("/<<\s*\/V([^>]*)>>/x",
$file,$out,PREG_SET_ORDER))
                      return;
               for ($i=0;$i<count($out);$i++) {
                       $pattern = "<<.*/V\s*(.*)\s*/T\s*(.*)\s*>>";
                     $thing = $out[$i][1];
                       if (eregi($pattern,$out[$i][0],$regs)) {
                              $key = $regs[2];
                               $val = $regs[1];
                              $key = preg_replace("/^\s*\(/","",$key);
                             $key = preg_replace("/\)$/","",$key);
                              $key = preg_replace("/\\\/","",$key);
                              $val = preg_replace("/^\s*\(/","",$val);
                             $val = preg_replace("/\)$/","",$val);
                              $matches[$key] = $val;
                       }
              }
               return $matches;
       }

adam at andemyte dot com
02-Aug-2002 06:30

Here is yet another example of generating pre-filled PDFs without using the FDF functions. This function takes two args: a URL to the PDF (like " and an array with all the field's values.

/*
   WARNING!! THIS FUNCTION SENDS HTTP HEADERS! It MUST be called before  
   any content is spooled to the browser, or the function will fail!

  void output_fdf (string $pdf_file, array $pdf_data)

      $pdf_file:  a string containing a URL path to a PDF file on the
                  server. This PDF MUST exist and contain fields with
                  the names referenced by $pdf_data for this function
                  to work.
       $pdf_data:  an array of any fields in $pdf_file that you want to
                   populate, of the form key=>val; where the field
                   name is the key, and the field's value is in val.

*/

function output_fdf ($pdf_file, $pdf_data) {

$fdf = "%FDF-1.2\n%����\n";
$fdf .= "1 0 obj \n<< /FDF ";
$fdf .= "<< /Fields [\n";

foreach ($pdf_data as $key => $val)
$fdf .= "<< /V ($val)/T ($key) >> \n";

$fdf .= "]\n/F ($pdf_file) >>";
$fdf .= ">>\nendobj\ntrailer\n<<\n";
$fdf .= "/Root 1 0 R \n\n>>\n";
$fdf .= "%%EOF";

/* Now we display the FDF data which causes Acrobat to start  */

header ("Content-Type: application/vnd.fdf");
print $fdf;

}

mitka at actdev.com
21-Oct-2002 11:24

IMPORTANT:

If you handled the FDF POSTs via $HTTP_RAW_POST_DATA as in user contributed scripts above, it's good to know that once you decide to rebuild PHP with FDFToolkit support, $HTTP_RAW_POST_DATA will be undefined.

Good news - $HTTP_FDF_DATA _will_ be defined instead. (Look at the example above).To get the user contributed scripts working in both plain PHP and PHP+FDFToolkit use

$HTTP_RAW_POST_DATA . $HTTP_FDF_DATA

where $HTTP_RAW_POST_DATA mentioned.

Dimitri Tarassenko

Toppi at i-Mehl dot De
26-Nov-2002 07:18

I tried a lot with FDF -> PDF and merging these documents...
in my opinon xfdf is more handy than fdf... for those who'd like to try: feel free to use this little function to generate an xfdf document from an array.

ToPPi

function array2xfdf($xfdf_data, $pdf_file) {
// Creates an XFDF File from a 2 dimensional
// Array Format: "array ("key1" => "content1", "key2" => "content2");
$xfdf = "<?xml version='1.0' encoding='UTF-8'?>\n";
$xfdf .= "<xfdf xmlns=' xml:space='preserve'>\n";
$xfdf .= "<fields>\n";
// Loop -> Array to XFDF Data
foreach ($xfdf_data as $key => $val) {
$xfdf .= "<field name='".$key."'>\n";
$xfdf .= "<value>".$val."</value>\n";
$xfdf .= "</field>\n";
};
// XFDF "Footer"
$xfdf .= "</fields>";
$xfdf .= "<f href='".$pdf_file."'/>";
$xfdf .= "</xfdf>";
return $xfdf;
}

jeff at cowart dot net
20-Jan-2003 03:06

I have tried to use the scripts above by adam and Toppi and I have been unable to get them to work unless I save the generated fdf file and then open it manually in acrobat.
Teemu
05-Mar-2003 01:17

Maybe you have to use Header-function that your browser will regonize xfdf-file. Like this:

Header( "Content-type: application/vnd.adobe.xfdf");

mirage at rateaprof dot com
08-May-2003 12:33

If you get the new  fdftkv5.tar.gz  from adobe's site (per the link above), you'll get some totally new spacing and capitalization of files.  To make the current 4.3.1 configure, you need to do a few things.

untar fdftkv5.tar.gz into /usr/local
cd /usr/local
#for ease of use
ln -s FDFToolkit\ for\ UNIX fdf

cd fdf
ln -s Headers\ And\ Libraries HeadersAndLibraries

#may need to modify the following for your OS
ln -s LINUX linux
cd linux/C
ln -s LIBFDFTK.SO libfdftk.so

cd ..
cd ..
ln -s Headers headers
cd headers
ln -s FDFTK.H fdftk.h

And that should get you going... and to whoever is maintaining the configure script, please be aware there are changes in the FDF Toolkit.

add a note

<unlinkfdf_add_doc_javascript>
 Last updated: Sat, 19 Apr 2003
show source | credits | mirror sites 
Copyright © 2001-2003 The PHP Group
All rights reserved.
This mirror generously provided by: /
Last updated: Wed May 14 01:12:44 2003 CEST