<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.14 $ -->
 <reference id="ref.fdf">
  <title>Forms Data Format 関数</title>
  <titleabbrev>FDF</titleabbrev>

  <partintro>
   
   <simpara>
    Forms Data Format (FDF)は、PDFドキュメント内部のフォームを処理する
    ためのフォーマットです。FDFの詳細および一般的な用途については、
    <ulink url="&spec.pdf.fdf;">&spec.pdf.fdf;</ulink>にあるドキュメン
    トを参照下さい。
   </simpara>
   <note>
    <simpara>
     fdftk サポートを有効にして php の configure を行う際に問題を発生
     した場合、ヘッダーファイル FdfTk.h およびライブラリ libFdfTk.so
     が正しい場所にあるかどうかを確認して下さい。これらは、それぞれ
     fdftk-dir/include および fdftk-dir/lib にある必要があります。
     FdfTk の配布ファイルを単に解凍しただけだとしたら、このように
     はなりません。
    </simpara>
   </note>
   <simpara>
    FDFの基本的な考えは、HTMLフォームに似ています。基本的な違いは、投
    稿ボタンが押された際にフォームに埋められたデータをサーバーに送信す
    る方法のフォーマット(これがForm Data Format そのものです)およびフォー
    ムのフォーマット自体(これは Portable Document Format、PDFです)です。
    FDFデータの処理は、fdf関数に提供された機能の一つです。しかし機能は
    他にもあります。既存のPDFフォームを用いてフォーム自体を修正せずに
    入力フィールドのデータを入力させることもあるかと思われます。
    このような場合、FDFドキュメント を作成
    (<function>fdf_create</function>)、各入力フィールドの値を設定
    (<function>fdf_set_value</function>)、PDFフォームとそれを関連付け
    (<function>fdf_set_file</function>)ます。最後にブラウザに MIME型
    application/vnd.fdf で送信する必要があります。ブラウザの Acrobat
    Reader プラグイン がこの MIME 型を認識し、関連する PDF フォームを
    読み込み、FDF ドキュメントからのデータを書き込みます。
   </simpara>
   <simpara>
    テキストエディタでFDFドキュメントの中を見てみると、
    <literal>FDF</literal>という名前のカタログオブジェクトが見つかるは
    ずです。このようなオブジェクトには、<literal>Fields</literal>,
    <literal>F</literal>, <literal>Status</literal> といった複数のエン
    トリが含まれます。
    最も多く使用されるエントりは、一連の入力フィールドを指す
    <literal>Fields</literal>とこのデータが属するPDFドキュメントのファ
    イル名を保持する<literal>F</literal> です。これらのエントリは、
    FDFドキュメントの中で/F-Keyまたは /Status-Keyのように参照されてい
    ます。    <function>fdf_set_file</function>および
    <function>fdf_set_status</function>のような関数によりこれらのエン
    トリを修正することが可能です。Fields は、
    <function>fdf_set_value</function>,<function>fdf_set_opt</function>
    等で修整可能です。
   </simpara>
   <simpara>
    以下の例でフォームデータの評価に関して説明します。
   </simpara>
   <simpara>
   </simpara>
   <example>
    <title>FDF ドキュメントの評価</title>
    <programlisting>
<![CDATA[
<?php
// FDF データをテンポラリファイルに保存します。
$fdffp = fopen("test.fdf", "w");
fwrite($fdffp, $HTTP_FDF_DATA, strlen($HTTP_FDF_DATA));
fclose($fdffp);

// テンポラリファイルをオープンし、データを評価します。
// PDF フォームは、volume, date, comment, publisher, preparer という名前の
//テキスト入力フィールドと show_publisher および show_preparer
// というチェックボックスを有します。
$fdf = fdf_open("test.fdf");
$volume = fdf_get_value($fdf, "volume");
echo "volume フィールドは次の値を有します。 '<B>$volume</B>'<BR>";

$date = fdf_get_value($fdf, "date");
echo "date フィールドは次の値を有します。 '<B>$date</B>'<BR>";

$comment = fdf_get_value($fdf, "comment");
echo "comment フィールドは次の値を有します。 '<B>$comment</B>'<BR>";

if(fdf_get_value($fdf, "show_publisher") == "On") {
  $publisher = fdf_get_value($fdf, "publisher");
  echo "publisher フィールドは次の値を有します。 '<B>$publisher</B>'<BR>";
} else
  echo "publisher は、表示されません。<BR>";

if(fdf_get_value($fdf, "show_preparer") == "On") {
  $preparer = fdf_get_value($fdf, "preparer");
  echo "preparer フィールドは次の値を有します。  '<B>$preparer</B>'<BR>";
} else
  echo "preparer は、表示されません。<BR>";
fdf_close($fdf);
?>
]]>
    </programlisting>
   </example>

  </partintro>

  <refentry id="function.fdf-open">
   <refnamediv>
    <refname>fdf_open</refname>
    <refpurpose>FDF ドキュメントをオープンする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>fdf_open</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_open</function> 関数はフォームデータを有するファイ
     ルをオープンします。このファイルは、PDFフォームから返されたのと同
     じデータを有している必要があります。現在、ファイルは
     <function>fopen</function> を用いて「マニュアル」で作成し、
     <function>fwrite</function> で HTTP_FDF_DATA の内容をそのファイル
     に書き込む必要があります。動作はHTMLフォームと似ており、各入力フィー
     ルドに関して存在しない変数は作成されます。
    </para>
    <para>
     <example>
      <title>フォームデータをアクセスする</title>
      <programlisting>
<![CDATA[
<?php
// FDF データをテンポラリファイルに保存します
$fdffp = fopen ("test.fdf", "w");
fwrite ($fdffp, $HTTP_FDF_DATA, strlen($HTTP_FDF_DATA));
fclose ($fdffp);

// テンポラリファイルをオープンし、データを評価します
$fdf = fdf_open ("test.fdf");
...
fdf_close($fdf);
?>
]]>
      </programlisting>
     </example>
    </para>
    <para>
     <function>fdf_close</function> も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-close">
   <refnamediv>
    <refname>fdf_close</refname>
    <refpurpose>FDF ドキュメントを閉じる</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>fdf_close</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_close</function> 関数はFDFドキュメントを
     閉じます。
    </para>
    <para>
     <function>fdf_open</function> も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-create">
   <refnamediv>
    <refname>fdf_create</refname>
    <refpurpose>新規 FDF ドキュメントを作成する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>fdf_create</methodname>
      <methodparam><type>void</type><parameter/></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_create</function> は新規FDFドキュメント
     を作成します。この関数は、データを有する PDFドキュメントの入力フィー
     ルドを公開したい場合に必要です。
    </para>
    <para>
     <example>
      <title>PDF ドキュメントを公開する</title>
      <programlisting>
<![CDATA[
<?php
$outfdf = fdf_create();
fdf_set_value($outfdf, "volume", $volume, 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>
     <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>FDF ドキュメントを保存する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>fdf_save</methodname>
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_save</function> 関数はFDFドキュメントを保存します。
     FDFツールキットは、パラメータ<parameter>filename</parameter> が
     '.'の場合、標準出力にドキュメントを出力する機能を提供しています。
     この機能は、PHPをApacheモジュールとして使用している場合は使用でき
     ません。この場合、何らかのファイルに書き込んだ後、例えば
     <function>fpassthru</function> を使用してこれを出力する必要があり
     ます。
    </para>
    <para>
     <function>fdf_close</function>及び
     <function>fdf_create</function>の例も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-value">
   <refnamediv>
    <refname>fdf_get_value</refname>
    <refpurpose>フィールドの値を得る</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_get_value</function> 関数はフィールドの値を得ます。
    </para>
    <para>
     <function>fdf_set_value</function> も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-value">
   <refnamediv>
    <refname>fdf_set_value</refname>
    <refpurpose>フィールドの値を設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_set_value</function> 関数は、フィールドの値を設定し
     ます。最後のパラメータは、フィールドの値をPDF Nameに変換する
     (<parameter>isName</parameter> = 1)か、PDF Stringに設定する
     (<parameter>isName</parameter> = 0)かを定義します。
    </para>
    <para>
     <function>fdf_get_value</function>も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-next-field-name">
   <refnamediv>
    <refname>fdf_next_field_name</refname>
    <refpurpose>次のフィールド名を得る</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>fdf_next_field_name</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
      <methodparam choice="opt"><type>string</type><parameter>fieldname</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_next_field_name</function> 関数は
     <parameter>fieldname</parameter> のフィールドの後のフィールドの名
     前を返します。二番目のフィールドに &null; を指定した場合、最初の
     フィールドの名前を返します。
    </para>
    <para>
     <function>fdf_set_value</function>,
     <function>fdf_get_value</function> も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-ap">
   <refnamediv>
    <refname>fdf_set_ap</refname>
    <refpurpose>フィールドの外観を設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_set_ap</function> 関数はフィールドの外観
     (すなわち、/AP キーの値)を設定します。
     <parameter>face</parameter> には、
     1=FDFNormalAP, 2=FDFRolloverAP, 3=FDFDownAP を
     設定可能です。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-status">
   <refnamediv>
    <refname>fdf_set_status</refname>
    <refpurpose>/STATUS キーの値を設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_set_status</function>は、/STATUS キーの値を設定しま
     す。
    </para>
    <para>
     <function>fdf_get_status</function> も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-status">
   <refnamediv>
    <refname>fdf_get_status</refname>
    <refpurpose>/STATUS キーの値を得る</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>fdf_get_status</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_get_status</function> は、/STATUS キーの値を返しま
     す。
    </para>
    <para>
     <function>fdf_set_status</function> も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-file">
   <refnamediv>
    <refname>fdf_set_file</refname>
    <refpurpose>/F キーの値を設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_set_file</function> は、/F キーの値を設定します。
     /F キーは、データを記入するPDFフォームへのリファレンスです。
     Web 環境では、URL  (例: http:/testfdf/resultlabel.pdf) となります。
    </para>
    <para>
     <function>fdf_get_file</function> および
     <function>fdf_create</function> の例を参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-file">
   <refnamediv>
    <refname>fdf_get_file</refname>
    <refpurpose>/F キーの値を得る</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>fdf_get_file</methodname>
      <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>fdf_set_file</function> は /F キーの値を返します。
    </para>
    <para>
     <function>fdf_set_file</function> も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-flags">
   <refnamediv>
    <refname>fdf_set_flags</refname>
    <refpurpose>フィールドのフラグを設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_set_flags</function>は、指定したフィールド
     <parameter>fieldname</parameter>のフラグを設定します。
    </para>
    <para>
     <function>fdf_set_opt</function>も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-opt">
   <refnamediv>
    <refname>fdf_set_opt</refname>
    <refpurpose>フィールドのオプションを設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_set_opt</function>は指定したフィールド
     <parameter>fieldname</parameter>のオプションを設定します。
    </para>
    <para>
     <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>フィールドのjavascriptアクションを設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     <function>fdf_set_submit_form_action</function> は、
     指定したフィールド<parameter>fieldname</parameter>の投稿フォーム
     のアクションを設定します。
    </para>
    <para>
     <function>fdf_set_javascript_action</function>も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-javascript-action">
   <refnamediv>
    <refname>fdf_set_javascript_action</refname>
    <refpurpose>フィールドの javascript アクションを設定する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>は、指定したフィー
     ルド<parameter>fieldname</parameter>のjavascriptアクションを設定
     します。
    </para>
    <para>
     <function>fdf_set_submit_form_action</function>も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-encoding">
   <refnamediv>
    <refname>fdf_set_encoding</refname>
    <refpurpose>FDF文字エンコーディング</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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> は、FDFドキュメントの文字
     エンコーディングを設定します。<parameter>encoding</parameter> 
     には有効なエンコーディング名を指定する必要があります。Acrobat
     5.0 で使用可能なエンコーディング名は、
     "<literal>Shift-JIS</literal>", "<literal>UHC</literal>",
     "<literal>GBK</literal>","<literal>BigFive</literal>"です。
    </para>
    <para>
     <function>fdf_set_encoding</function> は、PHP-4.1.0以降で使用可能
     です。
    </para>
   </refsect1>
  </refentry>

  <refentry id='function.fdf-add-template'>
   <refnamediv>
    <refname>fdf_add_template</refname>
    <refpurpose>テンプレートをFDFに追加する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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:
-->