File: fdf.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (427 lines) | stat: -rwxr-xr-x 15,482 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
<?xml version="1.0" encoding="iso-8859-1"?>
 <reference id="ref.fdf">
  <title>Funciones Forms Data Format (Formato de Datos de Formularios)</title>
  <titleabbrev>FDF</titleabbrev>

  <partintro>

   <simpara>
    El Formato de Datos de Formulario (FDF) est&aacute; dise&ntilde;ado para el manejo
    de formularios en archivos PDF. Se aconseja leer la informaci&oacute;n disponible en <ulink url="http://partners.adobe.com/asn/developer/acrosdk/forms.html">http://partners.adobe.com/asn/developer/acrosdk/forms.html</ulink>
    para m&aacute;s informaci&oacute;n sobre lo que es FDF y c&oacute;mo se usa en general.</simpara>

   <note><simpara>
    Actualmente Adobe s&oacute;lo proporciona una versi&oacute;n compatible con libc5 para Linux.
    Las pruebas con glibc2 provocaron un fallo de segmentado. Si alguien es capaz
    de hacerla funcionar, por favor com&eacute;ntelo en esta p&aacute;gina.
   </simpara></note>

   <note><simpara>
    Si tiene problemas configurando php con soporte de fdftk, compruebe
    si el archivo de cabecera FdfTk.h y la librer&iacute;a libFdfTk.so est&aacute;n en
    su lugar correcto. Deber&iacute;an encontrarse respectivamente en fdftk-dir/include
    y en fdftk-dir/lib. Este problema no se dar&aacute; si se limita a desempaqueta
    la distribuc&oacute;n del FtdTk.
   </simpara></note>

   <simpara>
    La idea general del FDF es similar a los formularios HTML. La diferencia
    b&aacute;sicamente est&aacute; en el formato en que se transmiten los datos al servidor
    cuando se pulsa el bot&oacute;n de env&iacute;o (este es realmente 
    el Formato de Datos de Formulario) y el formato del formulario en s&iacute; mismo
    (que es el Formato de Documento Portable, PDF). Procesar lo datos del FDF
    es una de las caracter&iacute;sticas que proporcionan las funciones fdf. Pero a&uacute;n
    hay m&aacute;s. Uno tambi&eacute;n puede tomar un formulario PDF y rellenar los campos de
    entrada con datos sin modificar el formulario en s&iacute; mismo. En dicho caso, lo
    que se hace es crear un documento FDF (<function>fdf_create</function>), fijar
    los valores de cada campo de entrada (<function>fdf_set_value</function>) y 
    asociarlo con un formulario PDF (<function>fdf_set_file</function>). 
    Finalmente, debe ser enviado al navegador con el MimeType application/vnd.fdf.
    El plug-in de Acrobar reader de su navegador reconoce el MimeType, lee el formulario
    PDF asociado y rellena los datos a partir del documento FDF.
    </simpara>

   <simpara>
    Los siguientes ejemplos muestran c&oacute;mo se eval&uacute;an los datos de los formularios.</simpara>
   <simpara></simpara>
    <example>
     <title>Evaluando un documento FDF</title>
     <programlisting>
&lt;?php
// Guarda los datos FDF en un archivo temporal
$fdffp = fopen("test.fdf", "w");
fwrite($fdffp, $HTTP_FDF_DATA, strlen($HTTP_FDF_DATA));
fclose($fdffp);

// Abre archivo temporal y eval&uacute;a los datos
// El formulario pdf conten&iacute;a varios campos de texto con los nombres
// volumen, fecha, comentario, editorial, preparador, y dos casillas de verificaci&oacute;n
// muestra_editorial y muestra_preparador.
$fdf = fdf_open("test.fdf");
$volume = fdf_get_value($fdf, "volumen");
echo "El campo volumen tiene el valor '&lt;B>$volume&lt;/B>'&lt;BR>";

$date = fdf_get_value($fdf, "fecha");
echo "El campo fecha tiene el valor '&lt;B>$date&lt;/B>'&lt;BR>";

$comment = fdf_get_value($fdf, "comentario");
echo "El campo comentario tiene el valor '&lt;B>$comment&lt;/B>'&lt;BR>";

if(fdf_get_value($fdf, "muestra_editorial") == "On") {
  $publisher = fdf_get_value($fdf, "editorial");
  echo "El campo editorial tiene el valor '&lt;B>$publisher&lt;/B>'&lt;BR>";
} else
  echo "No se debe mostrar la editorial.&lt;BR>";

if(fdf_get_value($fdf, "muestra_preparador") == "On") {
  $preparer = fdf_get_value($fdf, "preparador");
  echo "El campo preparador tiene el valor '&lt;B>$preparer&lt;/B>'&lt;BR>";
} else
  echo "No se debe mostrar el preparador.&lt;BR>";
fdf_close($fdf);
?>
     </programlisting>
    </example>

  </partintro>

  <refentry id="function.fdf-open">
   <refnamediv>
    <refname>fdf_open</refname>
    <refpurpose>Abrir un documento FDF</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>fdf_open</methodname>
     <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     La funci&oacute;n <function>fdf_open</function> abre un archivo
     con datos de formulario. Este archivo debe contener los datos
     tal y como se devuelven en un formulario PDF. Actualmente dicho
     archivo debe crearse "manualmente" usando la funci&oacute;n <function>fopen</function> 
     y escribiendo en &eacute;ste el contenido de HTTP_FDF_DATA usando <function>fwrite</function>.
     No existe un mecanismo similar al de los formularios HTML donde se
     crea una variable para cada campo de entrada.</para>

    <para>
    <example>
     <title>Accediendo a los datos del formulario</title>
     <programlisting>
&lt;?php
// Guarda los datos FDF en un archivo temporal
$fdffp = fopen("test.fdf", "w");
fwrite($fdffp, $HTTP_FDF_DATA, strlen($HTTP_FDF_DATA));
fclose($fdffp);

// Abre archivo temporal y eval&uacute;a los datos
$fdf = fdf_open("test.fdf");
...
fdf_close($fdf);
?>
     </programlisting>
    </example></para>

    <para>
     Vea tambi&eacute;n <function>fdf_close</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-close">
   <refnamediv>
    <refname>fdf_close</refname>
    <refpurpose>Cerrar un documento FDF</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>void</type><methodname>fdf_close</methodname>
     <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     La funci&oacute;n <function>fdf_close</function> cierra un documento FDF.</para>

    <para>
     Vea tambi&eacute;n <function>fdf_open</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-create">
   <refnamediv>
    <refname>fdf_create</refname>
    <refpurpose>Crear un documento FDF</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>fdf_create</methodname>
     <methodparam><type>void</type><parameter/></methodparam>
     </methodsynopsis>
    <para>
     La funci&oacute;n <function>fdf_create</function> crea un documento FDF
     nuevo. Esta funci&oacute;n se necesita si se desea rellenar los campos
     de entrada en un documento PDF.</para>
    <para>
    <example>
     <title>Rellenando un documento PDF</title>
     <programlisting>
&lt;?php
$outfdf = fdf_create();
fdf_set_value($outfdf, "volumen", $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>
     Vea tambi&eacute;n <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>Guardar un documeto FDF</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>int</type><methodname>fdf_save</methodname>
     <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
    <para>
     La funci&oacute;n <function>fdf_save</function> guarda un documento
     FDF.
     El kit de FDF proporciona una forma de volcar el documento a
     stdout si el par&aacute;metro <parameter>filename</parameter>
     es '.'. Esto no funciona si el PHP se utiliza como un m&oacute;dulo
     del apache.
     En tal caso se deber&aacute; escribir a un fichero y utilizar p. ej.
     <function>fpassthru</function> para visualizarlo.</para>

    <para>
     Vea tambi&eacute;n <function>fdf_close</function> y el ejemplo para
              <function>fdf_create</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-value">
   <refnamediv>
    <refname>fdf_get_value</refname>
    <refpurpose>Obtener el valor de un campo</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</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>
     La funci&oacute;n <function>fdf_get_value</function> devuelve el 
     valor de un campo.</para>

    <para>
     Vea tambi&eacute;n <function>fdf_set_value</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-value">
   <refnamediv>
    <refname>fdf_set_value</refname>
    <refpurpose>Fijar el valor de un campo</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>void</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>
     La funci&oacute;n <function>fdf_set_value</function> fija el valor de
     un campo. El par&aacute;metro final determina si el valor del campo se
     deber&aacute; convertir a un Nombre PDF (<parameter>isName</parameter> = 1)
     o convertir en una Cadena PDF (<parameter>isName</parameter> = 0).</para>

    <para>
     Vea tambi&eacute;n <function>fdf_get_value</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-next-field-name">
   <refnamediv>
    <refname>fdf_next_field_name</refname>
    <refpurpose>Obtener el nombre del siguiente campo</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</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>
     La funci&oacute;n <function>fdf_next_field_name</function> devuelve el nombre
     del campo tras el campo
     <parameter>fieldname</parameter> o el nombre del primer campo si
     el segundo par&aacute;metro es &null;.</para>

    <para>
     Vea tambi&eacute;n <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>Ajusta la apariencia de un campo</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>void</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>
     La funci&oacute;n <function>fdf_set_ap</function> ajusta la apariencia
     de un campo (p. ej. el valor de la clave /AP).
     Los valores posibles de <parameter>face</parameter>
     son 1=FDFNormalAP, 2=FDFRolloverAP, 3=FDFDownAP.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-status">
   <refnamediv>
    <refname>fdf_set_status</refname>
    <refpurpose>Fija el valor de la clave /STATUS</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>void</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>
     La funci&oacute;n <function>fdf_set_status</function> fija el valor
     de la clave /STATUS.</para>

    <para>
     Vea tambi&eacute;n <function>fdf_get_status</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-status">
   <refnamediv>
    <refname>fdf_get_status</refname>
    <refpurpose>Obtener el valor de la clave /STATUS</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>string</type><methodname>fdf_get_status</methodname>
     <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     La funci&oacute;n <function>fdf_get_status</function> devuelve el valor
     de la clave /STATUS.</para>

    <para>
     Vea tambi&eacute;n <function>fdf_set_status</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-set-file">
   <refnamediv>
    <refname>fdf_set_file</refname>
    <refpurpose>Fijar el valor de la clave /F</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>void</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>
     La funci&oacute;n <function>fdf_set_file</function> fija el valor
     de la clave /F. La clave /F es simplemente una referencia a
     un formulario PDF que se va a rellenar con datos.
     En un entorno web es un URL (p.ej. http:/testfdf/resultlabel.pdf).</para>

    <para>
     Vea tambi&eacute;n <function>fdf_get_file</function> y el ejemplo para
              <function>fdf_create</function>.</para>

   </refsect1>
  </refentry>

  <refentry id="function.fdf-get-file">
   <refnamediv>
    <refname>fdf_get_file</refname>
    <refpurpose>Obtener el valor de la clave /F</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Descripci&oacute;n</title>
     <methodsynopsis>
     <type>string</type><methodname>fdf_get_file</methodname>
     <methodparam><type>int</type><parameter>fdf_document</parameter></methodparam>
     </methodsynopsis>
    <para>
     La funci&oacute;n <function>fdf_set_file</function> devuelve el valor
     de la clave /F.</para>

    <para>
     Vea tambi&eacute;n <function>fdf_set_file</function>.</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:
-->