<?xml version="1.0" encoding="iso-8859-1"?>
<!-- EN-Revision: 1.29 Maintainer: stefan_saasen Status: ready -->
 <reference id="ref.fdf">
  <title>Forms Data Format Funktionen</title>
  <titleabbrev>FDF</titleabbrev>

  <partintro>
   <simpara>
    Forms Data Format (FDF) ist ein Format zur Verarbeitung von
    Formularen innerhalb von PDF Dokumenten.  Weiterfhrende
    Informationen zu FDF und dessen Verwendung sind unter <ulink
    url="&spec.pdf.fdf;">&spec.pdf.fdf;</ulink> zu finden.
   </simpara>
   <note>
    <simpara>
     Bei Problemen mit der Konfiguration der FdfTk-Untersttzung
     sollte man berprfen, ob die Datei FdfTk.h sowie die Bibliothek
     libFdfTk.so im richtigen Verzeichnis zu finden sind. Die
     korrekten Verzeichnisse sind fdftk-dir/include und
     fdftk-dir/lib. Das ausschlieliche Entpacken der Distribution
     fhrt nicht zu dem gewnschten Ergebnis.
    </simpara>
   </note>
   <simpara>
    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 enthlt(PDF).  Die Verarbeitung der FDF Daten
    ist eine der Mglichkeiten, die die FDF Funktionen bereitstellen.
    Darberhinaus kann man beispielsweise innerhalb eines vorhandenen
    PDF Formulars die Input Felder dynamisch mit Daten fllen, ohne
    das Formular selbst zu verndern.  Hierzu erzeugt man das FDF
    Dokument (<function>fdf_create</function>), setzt die Werte der
    jeweiligen Input Felder (<function>fdf_set_value</function>) und
    verbindet es mit dem jeweiligen PDF Formular
    (<function>fdf_set_file</function>).  Nachdem man das FDF
    Dokument, mit dem passenden MimeType
    <literal>application/vnd.fdf</literal> versehen, ausgegeben hat,
    erkennt das Acrobat Reader PlugIn des Browsers den MimeType und
    fllt das Zielformular mit den Daten des FDF Dokuments.
   </simpara>
   <simpara>
    Betrachtet man ein FDF Dokument mit einem Text Editor, findet sich
    dort ein Katalog Objekt <literal>FDF</literal>. Dieses Objekt kann
    mehrere Eintrge der Art <literal>Fields</literal>,
    <literal>F</literal>, <literal>Status</literal> etc..
    enthalten. Die gebruchlichsten Eintrge sind
    <literal>Fields</literal>, welches zu einer Anzahl von Input
    Feldern verweist, sowie <literal>F</literal> das den Dateinamen
    des zugehrigen PDF Dokuments enthlt. Diese Eintrge finden sich
    in der FDF Dokumentation unter /F-Key oder /Status-Key.
    Modifikationen dieser Eintrge werden mit Hilfe der Funktionen
    <function>fdf_set_file</function> und
    <function>fdf_set_status</function> vorgenommen.  Felder werden
    u.a. mit <function>fdf_set_value</function>,
    <function>fdf_set_opt</function> modifiziert.
   </simpara>
   <simpara>
    Das Beispiel zeigt die Auswertung der Formular Daten.
   </simpara>
   <simpara>
   </simpara>
   <example>
    <title>Auswertung eines FDF Dokuments</title>
    <programlisting role="php">
<![CDATA[ 
<?php
// Speichern der FDF Daten in eine temporre Datei
$fdffp = fopen("test.fdf", "w");
fwrite($fdffp, $HTTP_FDF_DATA, strlen($HTTP_FDF_DATA));
fclose($fdffp);

// ffnen der temporren Datei und Auswertung der Daten
// Das PDF Formular enthlt verschiedene Eingabefelder mit den zugehrigen 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);
?>
]]>
    </programlisting>
   </example>
  </partintro>

  <refentry id="function.fdf-open">
   <refnamediv>
    <refname>fdf_open</refname>
    <refpurpose>ffnet ein FDF Dokument</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>fdf_open</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_open</function> ffnet eine Datei mit
     Formulardaten. Diese Datei mu die von einem PDF Formular
     zurckgegebenen Formulardaten enthalten.  Momentan muss diese
     Datei 'manuell' erzeugt werden.  Mit Hilfe von
     <function>fopen</function> schreibt man den Inhalt von
     HTTP_FDF_DATA mit <function>fwrite</function> in die Datei.  Eine
     automatische Vorbelegung von Variablen mit den Daten der
     Eingabefelder, wie sie bei HTML Formularen mglich ist, existiert
     in diesem Fall nicht.
    </para>
    <para>
     <example>
      <title>Zugang zu den Fornmulardaten</title>
      <programlisting>
<![CDATA[       
<?php
// Speichern der FDF Daten in eine temporre Datei
$fdffp = fopen("test.fdf", "w");
fwrite($fdffp, $HTTP_FDF_DATA, strlen($HTTP_FDF_DATA));
fclose($fdffp);

// ffnen der temporren Datei und Auswertung der Daten
$fdf = fdf_open("test.fdf");
...
fdf_close($fdf);
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     Siehe auch <function>fdf_close</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-close">
   <refnamediv>
    <refname>fdf_close</refname>
    <refpurpose>Schliet ein FDF Dokument</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_close</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_close</function> schliet das FDF
     Dokument.
    </para>
    <para>
     Siehe auch <function>fdf_open</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-create">
   <refnamediv>
    <refname>fdf_create</refname>
    <refpurpose>Erzeugt ein neues FDF Dokument</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>fdf_create</methodname>
      <void/>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_create</function> erzeugt ein neues
     FDF Dokument.  Diese Funktion wird bentigt, wenn man
     Eingabefelder in einem PDF Dokument mit Daten belegen
     mchte.
    </para>
    <para>
     <example>
      <title>Fllen von Formularwerten in einem PDF Dokument</title>
      <programlisting>
<![CDATA[          
<?php
$outfdf = fdf_create();
fdf_set_value($outfdf, "band", $band, 0);

fdf_set_file($outfdf, "http:/testfdf/resultlabel.pdf");
fdf_save($outfdf, "outtest.fdf");
fdf_close($outfdf);
Header("Content-type: application/vnd.fdf");
$fp = fopen("outtest.fdf", "r");
fpassthru($fp);
unlink("outtest.fdf");
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     Siehe auch <function>fdf_close</function>,
     <function>fdf_save</function>,
     <function>fdf_open</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-save">
   <refnamediv>
    <refname>fdf_save</refname>
    <refpurpose>Speichern eines FDF Dokuments</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>int</type><methodname>fdf_save</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_save</function> speichert ein FDF
     Dokument.  Das FDF Toolkit stellt eine Mglichkeit zur Verfgung,
     das Dokument an der Standardausgabe auszugeben, wenn der
     Parameter <parameter>filename</parameter> '.' ist. Dies
     funktioniert allerdings nicht, wenn PHP als Apache Module
     verwendet wird.  In diesem Fall sollte man die Ausgabe in eine
     Datei schreiben und die Funktion <function>fpassthru</function>
     verwenden, um den Inhalt anzuzeigen.
    </para>
    <para>
     Siehe auch <function>fdf_close</function> and example for
     <function>fdf_create</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-value">
   <refnamediv>
    <refname>fdf_get_value</refname>
    <refpurpose>Gibt den Wert eines Feldes zurck</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>fdf_get_value</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_get_value</function> gibt den Wert
     eines Feldes zurck.
    </para>
    <para>
     Siehe auch <function>fdf_set_value</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-value">
   <refnamediv>
    <refname>fdf_set_value</refname>
    <refpurpose>Setzt den Wert eines Feldes</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_value</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
      <methodparam><type>string</type><parameter>value</parameter></methodparam>
      <methodparam><type>int</type><parameter>isName</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_set_value</function> setzt den Wert
     eines Feldes. Der letzte Parameter bestimmt, ob der Wert des
     Feldes in einen PDF Namen (<parameter>isName</parameter> = 1)
     konvertiert oder als PDF String (<parameter>isName</parameter> =
     0) behandelt wird.
    </para>
    <para>
     Siehe auch <function>fdf_get_value</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-next-field-name">
   <refnamediv>
    <refname>fdf_next_field_name</refname>
    <refpurpose>Gibt den Namen des nchsten Feldes zurck</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>fdf_next_field_name</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_next_field_name</function> gibt den
     Namen des Feldes nach <parameter>fieldname</parameter> oder den
     Namen des ersten Feldes zurck, wenn der Parameter &null;
     ist.
    </para>
    <para>
     Siehe auch <function>fdf_set_field</function>,
     <function>fdf_get_field</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-ap">
   <refnamediv>
    <refname>fdf_set_ap</refname>
    <refpurpose>Legt das Aussehen eines Feldes fest</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_ap</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>field_name</parameter></methodparam>
      <methodparam><type>int</type><parameter>face</parameter></methodparam>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
      <methodparam><type>int</type><parameter>page_number</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_set_ap</function> legt das Aussehen
     eines Feldes (d.h den Wert des /AP Schlssels) fest.  Mgliche
     Werte von <parameter>face</parameter> sind 1=FDFNormalAP,
     2=FDFRolloverAP, 3=FDFDownAP.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-status">
   <refnamediv>
    <refname>fdf_set_status</refname>
    <refpurpose>Setzt den Wert des /STATUS Schlssels</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_status</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>status</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_set_status</function> setzt den Wert 
     des /STATUS Schlssels.
    </para>
    <para>
     Siehe auch <function>fdf_get_status</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-status">
   <refnamediv>
    <refname>fdf_get_status</refname>
    <refpurpose>
     Gibt den Wert des /STATUS Schlssels zurck
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>fdf_get_status</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_get_status</function> gibt den Wert
     des /STATUS Schlssels zurck.
    </para>
    <para>
     Siehe auch <function>fdf_set_status</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-file">
   <refnamediv>
    <refname>fdf_set_file</refname>
    <refpurpose>Setzt den Wert des /F Schlssels</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_file</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_set_file</function> setzt den Wert des
     /F Schlssels.  Der /F Schlssel ist eine Referenz zu einem PDF
     Formular welches mit Daten gefllt werden soll.  In einer Web
     Umgebung ist diese Referenz ein URL
     (z.B. http:/testfdf/resultlabel.pdf).
    </para>
    <para>
     Siehe auch <function>fdf_get_file</function> und das Beispiel zu
     <function>fdf_create</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-file">
   <refnamediv>
    <refname>fdf_get_file</refname>
    <refpurpose>Gibt den Wert des /F Schlssels zurck</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>string</type><methodname>fdf_get_file</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion  <function>fdf_set_file</function> gibt den Wert 
     des /F Schlssels zurck.
    </para>
    <para>
     Siehe auch <function>fdf_set_file</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-flags">
   <refnamediv>
    <refname>fdf_set_flags</refname>
    <refpurpose>Setzt Flags eines Feldes</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_flags</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
      <methodparam><type>int</type><parameter>whichFlags</parameter></methodparam>
      <methodparam><type>int</type><parameter>newFlags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_set_flags</function> setzt bestimmte
     Flags des Feldes <parameter>fieldname</parameter>.
    </para>
    <para>
     Siehe auch <function>fdf_set_opt</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-opt">
   <refnamediv>
    <refname>fdf_set_opt</refname>
    <refpurpose>Setzt die Option eines Feldes</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_opt</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
      <methodparam><type>int</type><parameter>element</parameter></methodparam>
      <methodparam><type>string</type><parameter>str1</parameter></methodparam>
      <methodparam><type>string</type><parameter>str2</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_set_opt</function> setzt Optionen  
     des Feldes <parameter>fieldname</parameter>.
    </para> 
    <para>
     Siehe auch <function>fdf_set_flags</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-submit-form-action">
   <refnamediv>
    <refname>fdf_set_submit_form_action</refname>
    <refpurpose>
     Setzt die 'Submit Form Action' fr ein Feld
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_submit_form_action</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
      <methodparam><type>int</type><parameter>trigger</parameter></methodparam>
      <methodparam><type>string</type><parameter>script</parameter></methodparam>
      <methodparam><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>
    <para>
     Die Funktion <function>fdf_set_submit_form_action</function>
     setzt die 'Submit Form Action' fr das Feld
     <parameter>fieldname</parameter>.
    </para>
    <para>
     Siehe auch <function>fdf_set_javascript_action</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-javascript-action">
   <refnamediv>
    <refname>fdf_set_javascript_action</refname>
    <refpurpose>
     Weist einem Feld eine Javascript Aktion zu
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_javascript_action</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
      <methodparam><type>int</type><parameter>trigger</parameter></methodparam>
      <methodparam><type>string</type><parameter>script</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_set_javascript_action</function> weist dem Feld
     <parameter>fieldname</parameter> eine Javascript Aktion zu.
    </para>
    <para>
     Siehe auch <function>fdf_set_submit_form_action</function>.
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-encoding">
   <refnamediv>
    <refname>fdf_set_encoding</refname>
    <refpurpose>
     Legt die Kodierung des FDF Zeichensatzes fest
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Beschreibung</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_set_encoding</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam><type>string</type><parameter>encoding</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_set_encoding</function> legt die Kodierung des
     Zeichensatzes innerhalb des FDF Dokuments
     <parameter>fdf_document</parameter> fest.  In Acrobat 5.0 sind
     "<literal>Shift_JIS</literal>", "<literal>UHC</literal>",
     "<literal>GBK</literal>","<literal>BigFive</literal>" gltige
     Werte fr den Parameter <parameter>encoding</parameter>.
    </para>
    <para>
     Die Funktion <function>fdf_set_encoding</function> ist ab
     PHP-4.1.0 oder spter verfgbar.
    </para>
   </refsect1>
  </refentry>

   <refentry id='function.fdf-add-template'> 
     <refnamediv> 
      <refname>fdf_add_template</refname> 
      <refpurpose>Fgt dem FDF Dokument ein Template hinzu</refpurpose> 
     </refnamediv> 
     <refsect1> 
      <title>Beschreibung</title> 
       <methodsynopsis> 
        <type>bool</type><methodname>fdf_add_template</methodname> 
        <methodparam><type>int</type><parameter>fdfdoc</parameter></methodparam> 
        <methodparam><type>int</type><parameter>newpage</parameter></methodparam> 
        <methodparam><type>string</type><parameter>filename</parameter></methodparam> 
        <methodparam><type>string</type><parameter>template</parameter></methodparam> 
        <methodparam><type>int</type><parameter>rename</parameter></methodparam> 
       </methodsynopsis>
      <para> 
       &warn.undocumented.func; 
      </para> 
     </refsect1> 
    </refentry> 
  
  
 </reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
 -->