   #PHP Manual Function Reference unlink fdf_add_doc_javascript

   PHP Manual
   Prev  Next
   ______________________________________________________________________

XXXI. Forms Data Format functions

Introduction

   Forms Data Format (FDF) is a format for handling forms within PDF
   documents. You should read the documentation at
   http://partners.adobe.com/asn/acrobat/forms.jsp for more information
   on what FDF is and how it is used in general.

   The general idea of FDF is similar to HTML forms. The difference is
   basically the format how data is transmitted to the server when the
   submit button is pressed (this is actually the Form Data Format) and
   the format of the form itself (which is the Portable Document Format,
   PDF). Processing the FDF data is one of the features provided by the
   fdf functions. But there is more. One may as well take an existing PDF
   form and populated the input fields with data without modifying the
   form itself. In such a case one would create a FDF document
   (fdf_create()) set the values of each input field (fdf_set_value())
   and associate it with a PDF form (fdf_set_file()). Finally it has to
   be sent to the browser with MimeType application/vnd.fdf. The Acrobat
   reader plugin of your browser recognizes the MimeType, reads the
   associated PDF form and fills in the data from the FDF document.

   If you look at an FDF-document with a text editor you will find a
   catalogue object with the name FDF. Such an object may contain a
   number of entries like Fields, F, Status etc.. The most commonly used
   entries are Fields which points to a list of input fields, and F which
   contains the filename of the PDF-document this data belongs to. Those
   entries are referred to in the FDF documentation as /F-Key or
   /Status-Key. Modifying this entries is done by functions like
   fdf_set_file() and fdf_set_status(). Fields are modified with
   fdf_set_value(), fdf_set_opt() etc..

Requirements

   You need the FDF toolkit SDK available from
   http://partners.adobe.com/asn/acrobat/forms.jsp. As of PHP 4.3 you
   need at least SDK version 5.0. The FDF toolkit library is available in
   binary form only, platforms supported by Adobe are Win32, Linux,
   Solaris and AIX.

Installation

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

     Note: 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)

Runtime Configuration

   This extension has no configuration directives defined in php.ini.

Resource Types

fdf

   Most fdf functions require a fdf resource as their first parameter. A
   fdf resource is a handle to an opened fdf file. fdf resources may be
   obtained using fdf_create(), fdf_open() and fdf_open_string().

Predefined Constants

   The constants below are defined by this extension, and will only be
   available when the extension has either been compiled into PHP or
   dynamically loaded at runtime.

   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)

Examples

   The following examples shows just the evaluation of form data.

   Example 1. Evaluating a FDF document
   <?php
   // Open fdf from input string provided by the extension
   // The pdf form contained several input text fields with the names
   // volume, date, comment, publisher, preparer, and two checkboxes
   // show_publisher and show_preparer.
   $fdf = fdf_open_string($HTTP_FDF_DATA);
   $volume = fdf_get_value($fdf, "volume");
   echo "The volume field has the value '<b>$volume</b>'<br />";
   $date = fdf_get_value($fdf, "date");
   echo "The date field has the value '<b>$date</b>'<br />";
   $comment = fdf_get_value($fdf, "comment");
   echo "The comment field has the value '<b>$comment</b>'<br />";
   if (fdf_get_value($fdf, "show_publisher") == "On") {
     $publisher = fdf_get_value($fdf, "publisher");
     echo "The publisher field has the value '<b>$publisher</b>'<br />";
   } else
     echo "Publisher shall not be shown.<br />";
   if (fdf_get_value($fdf, "show_preparer") == "On") {
     $preparer = fdf_get_value($fdf, "preparer");
     echo "The preparer field has the value '<b>$preparer</b>'<br />";
   } else
     echo "Preparer shall not be shown.<br />";
   fdf_close($fdf);
   ?>

   Table of Contents
   fdf_add_doc_javascript -- Adds javascript code to the FDF document
   fdf_add_template -- Adds a template into the FDF document
   fdf_close -- Close an FDF document
   fdf_create -- Create a new FDF document
   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 -- Get the value of the /F key
   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 -- Get the value of the /STATUS key
   fdf_get_value -- Get the value of a field
   fdf_get_version -- Gets version number for FDF API or file
   fdf_header -- Sets FDF-specific output headers
   fdf_next_field_name -- Get the next field name
   fdf_open_string -- Read a FDF document from a string
   fdf_open -- Open a FDF document
   fdf_remove_item -- Sets target frame for form
   fdf_save_string -- Returns the FDF document as a string
   fdf_save -- Save a FDF document
   fdf_set_ap -- Set the appearance of a field
   fdf_set_encoding -- Sets FDF character encoding
   fdf_set_file -- Set PDF document to display FDF data in
   fdf_set_flags -- Sets a flag of a field
   fdf_set_javascript_action -- Sets an javascript action of a field
   fdf_set_opt -- Sets an option of a field
   fdf_set_status -- Set the value of the /STATUS key
   fdf_set_submit_form_action -- Sets a submit form action of a field
   fdf_set_target_frame -- Set target frame for form display
   fdf_set_value -- Set the value of a field
   fdf_set_version -- Sets version number for a FDF file
   ______________________________________________________________________

   Prev   Home                   Next
   unlink  Up  fdf_add_doc_javascript
