fdf Forms Data Format 関数＠PHPマニュアル.apis

導入

Forms Data Format (FDF)は、PDF ドキュメント内部のフォームを処理するためのフォーマットです。FDF の詳細および一般的な用途については、 » http://partners.adobe.com/asn/acrobat/forms.jsp にあるドキュメントを参照ください。

FDF の基本的な考えは HTML フォームに似ています。基本的な違いは、投稿ボタンが押された際にフォームに埋められたデータをサーバに送信する方法のフォーマット(これが Form Data Format そのものです)およびフォームのフォーマット自体(これは Portable Document Format、PDF です)です。 FDF データの処理は、fdf 関数が提供する機能の一つです。しかし他にも機能はあります。既存の PDF フォームを用いてフォーム自体を修正せずに入力フィールドのデータを入力させることもあるかと思われます。このような場合、FDF ドキュメントを作成し (fdf_create())、各入力フィールドの値を設定し (fdf_set_value())、PDF フォームとそれを関連付けます (fdf_set_file())。最後にブラウザに MIME 型 application/vnd.fdf で送信する必要があります。ブラウザの Acrobat Reader プラグインがこの MIME 型を認識し、関連する PDF フォームを読み込み、FDF ドキュメントからのデータを書き込みます。

テキストエディタで FDF ドキュメントの中を見てみると、 FDF という名前のカタログオブジェクトが見つかるはずです。このようなオブジェクトには Fields、 F、Status といった複数のエントリが含まれます。最も多く使用されるエントりは Fields および F で、Fields は一連の入力フィールドを指し、F はこのデータが属する PDF ドキュメントのファイル名を保持します。これらのエントリは、FDF ドキュメントの中で /F-Key または /Status-Key として参照されています。fdf_set_file() および fdf_set_status() のような関数により、これらのエントリを修正することが可能です。Fields は、 fdf_set_value()、fdf_set_opt() 等で修整可能です。

要件

» http://partners.adobe.com/asn/acrobat/forms.jsp から取得可能な FDF toolkit SDKが必要です。 PHP 4.3.0 以降では、少なくとも SDK version 5.0 が必要です。 FDF toolkit library はバイナリ版のみ利用可能で、 Adobe によりサポートされているプラットフォームは Win32、Linux、Solaris、AIX です。

インストール手順

--with-fdftk[=DIR] を指定して PHP をコンパイルする必要があります。

注意: fdftk サポートを指定して PHP を設定した際に問題を発生した場合、ヘッダファイル fdftk.h およびライブラリ libfdftk.so が正しい場所にあることを確認してください。configure スクリプトは、FDF SDK 配布ファイルおよび通常の DIR/include、 DIR/lib といった配置のディレクトリ構造をともにサポートします。このため、配布ファイルを展開したディレクトリにそのままおいておくか、あるいは /usr/local/include および /usr/local/lib のように使用するプラットフォームに応じた適当なディレクトリに移動して --with-fdftk=/usr/local を指定して設定することが可能です。

注意: Win32 ユーザへの注意 この拡張モジュールを動作させるには、 Windows システムの PATH が通った場所に DLL ファイルが存在する必要があります。 FAQ の "Windows で PHP のディレクトリを PATH に追加するにはどうすればいいのですか?" で、その方法を説明しています。 DLL ファイルを PHP のフォルダから Windows のシステムディレクトリにコピーしても動作します (システムディレクトリは、デフォルトで PATH に含まれるからです) が、これは推奨しません。 この拡張モジュールを使用するには、以下のファイルが PATH の通った場所にある必要があります。 fdftk.dll

実行時設定

設定ディレクティブは定義されていません。

リソース型

fdf

多くの fdf 関数は、最初のパラメータとして fdf リソースを必要とします。 fdf リソースは、オープンした fdf ファイルのハンドルです。fdf リソースは、 fdf_create()、fdf_open()、 fdf_open_string() を用いて取得することが可能です。

定義済み定数

以下の定数が定義されています。この関数の拡張モジュールが PHP 組み込みでコンパイルされているか、実行時に動的にロードされている場合のみ使用可能です。

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)

例

以下の例でフォームデータの評価に関して説明します。

Example#1 FDF ドキュメントの評価


<?php
// 拡張モジュールが提供する入力文字列から fdf をオープンします。
// pdf フォームには volume, date, comment, publisher, preparer
// という名前のテキスト入力フィールドと 2 つのチェックボックス
// show_publisher および show_preparer があるものとします。
$fdf = fdf_open_string($HTTP_FDF_DATA);
$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);
?>

Forms Data Format 関数

導入

要件

インストール手順

実行時設定

リソース型

fdf

定義済み定数

例

PHPマニュアル検索

ナビゲーション

関数リスト

同一レベル項目