Manuel PHP
Précédent |  | Suivant

# XXXIII. Forms Data Format

# Introduction

Forms Data Format (FDF) est un format de formulaire pour les documents PDF. Vous pouvez lire la documentation (en anglais) à http://partners.adobe.com/asn/acrobat/forms.jsp pour plus de détails sur les tenants et les aboutissants.

L'esprit de FDF est similaire à celui des formulaires HTML. Les différences résident dans les moyens de transmission des données au serveur, lorsque le bouton "submit" (soumettre) est pressé (ce qui est du ressort de Form Data Format) et le format de formulaire lui-même (qui est plutôt du ressort de Portable Document Format, PDF). Gérer des données FDF est un des objectifs des fonctions FDF. Mais il y en a d'autres. Vous pouvez aussi prendre un formulaire PDF, et pré-remplir les champs, sans modifier le formulaire lui-même. Dans ce cas, on va créer un document FDF (fdf_create()), remplir les champs (fdf_set_value()) et l'associer à un fichier PDF (fdf_set_file()). Finalement, le tout sera envoyé au client, avec le type MIME application/vnd.fdf. Le module "Acrobat reader" de votre navigateur va reconnaître ce type MIME, et lire le fichier PDF, puis le remplir avec FDF.

Si vous éditez un fichier FDF avec un éditeur de texte, vous trouverez un catalogue d'objet avec le nom de FDF. Cet objet peut contenir des entrées telles que Fields, F, Status etc. Les entrées les plus couramment utilisées sont Fields, qui indique une liste de champs de contrôle, et F qui contient le nom du fichier PDF a qui appartiennent ces données. Ces entrées sont désignées dans la documentation PDF sous le nom de /F-Key ou /Status-Key. La modification de ces entrées est possible avec les fonctions fdf_set_file() et fdf_set_status(). Les champs sont modifiables avec les fonctions fdf_set_value(), fdf_set_opt() etc.

# Pré-requis

Vous aurez besoin du FDF toolkit SDK, disponible sur le site http://partners.adobe.com/asn/acrobat/forms.jsp. Depuis PHP 4.3, vous aurez besoin du SDK version 5.0. La bibliothèque FDF toolkit est disponible sous forme de bibliothèque compilée, éditée par Adobe, sur les systèmes d'exploitation Win32, Linux, Solaris et AIX.

# Installation

Vous devez compiler PHP avec --with-fdftk[=DIR].

> Note : Si vous rencontrez des problèmes lors de la configuration de FDF avec le support fdftk, vérifiez que le fichier d'en-tête `fdftk.h` et la bibliothèque `libfdftk.so` sont à leur place. Le fichier de configuration supporte la hierarchie de dossier de la distribution FDF SDK et l'organisation classique `DIR/include` et `DIR/lib` : vous pouvez donc utiliser l'un ou l'autre directement avec la distribution décompressée, ou bien en incluant le fichier d'en-têtes et la bibliothèque appropriée dans votre système, c'est-à-dire dans `/usr/local/include` et `/usr/local/lib`. Il ne reste plus qu'à configurer avec --with-fdftk=/usr/local.

> Note aux utilisateurs Win32 : Afin d'activer ce module dans l'environnement Windows, vous devez copier les bibliothèques fdftk.dll depuis le dossier DLL de PHP/Win32 dans le dossier système SYSTEM32 de votre machine (par exemple : `C:\WINNT\SYSTEM32` ou `C:\WINDOWS\SYSTEM32`).

# Configuration à l'exécution

Cette extension ne définit aucune directive de configuration.

# Types de ressources

## fdf

La plupart des fonctions FDF nécessite une ressource de type fdf comme premier argument. Une ressource fdf est une structure qui représente un fichier FDF ouvert. Vous pouvez créer des ressources fdf avec les fonctions fdf_create(), fdf_open() et fdf_open_string().

# Constantes prédefinies

Ces constantes sont définies par cette extension, et ne sont disponibles que si cette extension a été compilée avec PHP, ou bien chargée au moment de l'exécution.

`FDFValue` (entier)

`FDFStatus` (entier)

`FDFFile` (entier)

`FDFID` (entier)

`FDFFf` (entier)

`FDFSetFf` (entier)

`FDFClearFf` (entier)

`FDFFlags` (entier)

`FDFSetF` (entier)

`FDFClrF` (entier)

`FDFAP` (entier)

`FDFAS` (entier)

`FDFAction` (entier)

`FDFAA` (entier)

`FDFAPRef` (entier)

`FDFIF` (entier)

`FDFEnter` (entier)

`FDFExit` (entier)

`FDFDown` (entier)

`FDFUp` (entier)

`FDFFormat` (entier)

`FDFValidate` (entier)

`FDFKeystroke` (entier)

`FDFCalculate` (entier)

`FDFNormalAP` (entier)

`FDFRolloverAP` (entier)

`FDFDownAP` (entier)

# Exemples

Les exemples suivants montrent comment évaluer les données du formulaire.

Exemple 1. Evaluer un document FDF

`<?php
// Ouvrir un fichier FDF depuis une chaîne fournie par l'extension PDF
// Le formulaire PDF contient plusieurs champs texte avec les noms de
// volume, date, comment, publisher, preparer, et two boîtes à cocher
// show_publisher et show_preparer.
$fdf = fdf_open_string($HTTP_FDF_DATA);
$volume = fdf_get_value($fdf, "volume");
echo 'Le champ Volume contient la valeur : "<strong>' . $volume . '</strong>"<br />';
$date = fdf_get_value($fdf, "date");
echo 'La valeur du champ date était "<strong>' . $date . '</strong>"<br />';
$comment = fdf_get_value($fdf, "comment");
echo 'La valeur du champ comment était "<strong>' . $comment . '</strong>"<br />";
if (fdf_get_value($fdf, "show_publisher") == "On") {
$publisher = fdf_get_value($fdf, "publisher");
echo 'La valeur du champ Publisher était : "<strong>' . $publisher . '</strong>"<br />";
} else
echo 'La valeur du champ Publisher ne doit pas être affichée.<br />';
if (fdf_get_value($fdf, "show_preparer") == "On") {
$preparer = fdf_get_value($fdf, "preparer");
echo 'La valeur du champ Preparer était "<strong>' . $preparer . '</strong>"<br />';
} else
echo 'La valeur du champ Preparer ne doit pas être affiché.<br />';
fdf_close($fdf);
?>`

Précédent | Sommaire | Suivant
unlink | Niveau supérieur | fdf_add_doc_javascript