mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
82c6591284
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@9864 c90b9560-bf6c-de11-be94-00142212c4b1
301 lines
8.8 KiB
Text
301 lines
8.8 KiB
Text
<reference id="ref.fdf">
|
|
<title>Forms Data Format functions</title>
|
|
<titleabbrev>FDF</titleabbrev>
|
|
|
|
<partintro>
|
|
|
|
<simpara>
|
|
This is a first attempt to implement Forms Data Format
|
|
(FDF) support in PHP. You can read the documentation at <ulink
|
|
url="http://beta1.adobe.com/ada/acrosdk/forms.html">http://beta1.adobe.com/ada/acrosdk/forms.html</ulink>
|
|
for more information on what FDF is and how it is used in general.
|
|
|
|
</partintro>
|
|
|
|
<refentry id="function.fdf-open">
|
|
<refnamediv>
|
|
<refname>FDF_open</refname>
|
|
<refpurpose>Opens a new fdf document</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>pdf_open</function></funcdef>
|
|
<paramdef>string <parameter>filename</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_open</function> function opens
|
|
a new fdf document. If the parameter <parameter>filename</parameter>
|
|
is '.' the file is read from stdin.
|
|
|
|
<para>
|
|
See also <function>fdf_close</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-close">
|
|
<refnamediv>
|
|
<refname>FDF_close</refname>
|
|
<refpurpose>Closes the fdf document</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>pdf_close</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_close</function> function closes the fdf document.
|
|
|
|
<para>
|
|
See also <function>FDF_open</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-create">
|
|
<refnamediv>
|
|
<refname>FDF_create</refname>
|
|
<refpurpose></refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>fdf_create</function></funcdef>
|
|
<paramdef>void <parameter></parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_create</function> creates a new
|
|
fdf document.
|
|
<para>
|
|
See also <function>FDF_close</function>,
|
|
<function>FDF_save</function>,
|
|
<function>FDF_open</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-save">
|
|
<refnamediv>
|
|
<refname>FDF_save</refname>
|
|
<refpurpose>Saves a fdf document</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>pdf_save</function></funcdef>
|
|
<paramdef>string <parameter>filename</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_save</function> function saves
|
|
a fdf document. If the parameter <parameter>filename</parameter>
|
|
is '.' the file is written to stdout.
|
|
|
|
<para>
|
|
See also <function>fdf_close</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-get-value">
|
|
<refnamediv>
|
|
<refname>FDF_get_value</refname>
|
|
<refpurpose>Gets the value of a field</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>fdf_get_value</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
<paramdef>string <parameter>fieldname</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_get_value</function> function returns the
|
|
value of a field.
|
|
|
|
<para>
|
|
See also <function>FDF_set_value</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-set-value">
|
|
<refnamediv>
|
|
<refname>FDF_get_value</refname>
|
|
<refpurpose>Sets the value of a field</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>fdf_get_value</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
<paramdef>string <parameter>fieldname</parameter></paramdef>
|
|
<paramdef>string <parameter>value</parameter></paramdef>
|
|
<paramdef>int <parameter>isName</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_set_value</function> function sets the
|
|
value of a field. The last parameter determines if the field value
|
|
is to be converted to a PDF Name (<parameter>isName</parameter> = 1)
|
|
or set to a PDF String (<parameter>isName</parameter> = 0).
|
|
|
|
<para>
|
|
See also <function>FDF_get_value</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-next-field-name">
|
|
<refnamediv>
|
|
<refname>FDF_next_field_name</refname>
|
|
<refpurpose>Next field name</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>fdf_next_field_name</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
<paramdef>string <parameter>fieldname</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_next_field_name</function> function returns the
|
|
name of the field string after the field in parameter
|
|
<parameter>fieldname</parameter> or the field name of the first field
|
|
if the second paramter is NULL.
|
|
|
|
<para>
|
|
See also <function>FDF_set_field</function>,
|
|
<function>FDF_get_field</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-set-ap">
|
|
<refnamediv>
|
|
<refname>FDF_set_ap</refname>
|
|
<refpurpose>Sets the appearence of a field</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>fdf_set_ap</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
<paramdef>string <parameter>fieldname</parameter></paramdef>
|
|
<paramdef>int <parameter>face</parameter></paramdef>
|
|
<paramdef>string <parameter>filename</parameter></paramdef>
|
|
<paramdef>int <parameter>pagenr</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_set_ap</function> function sets the
|
|
appearance of a field (i.e. the value of the /AP key).
|
|
The possible values of the parameter <parameter>face</parameter>
|
|
are 1=FDFNormalAP, 2=FDFRolloverAP, 3=FDFDownAP.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-set-status">
|
|
<refnamediv>
|
|
<refname>FDF_set_status</refname>
|
|
<refpurpose>Sets the value of the /STATUS key</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>fdf_set_status</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
<paramdef>string <parameter>status</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_set_status</function> sets the value
|
|
of the /STATUS key.
|
|
|
|
<para>
|
|
See also <function>FDF_get_status</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-get-status">
|
|
<refnamediv>
|
|
<refname>FDF_get_status</refname>
|
|
<refpurpose>Gets the value of the /STATUS key</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>fdf_get_status</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_get_status</function> returns the value
|
|
of the /STATUS key.
|
|
|
|
<para>
|
|
See also <function>FDF_set_status</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-set-file">
|
|
<refnamediv>
|
|
<refname>FDF_set_file</refname>
|
|
<refpurpose>Sets the value of the /F key</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>fdf_set_file</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
<paramdef>string <parameter>filename</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_set_file</function> sets the value
|
|
of the /F key.
|
|
|
|
<para>
|
|
See also <function>FDF_get_file</function>.
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.fdf-get-file">
|
|
<refnamediv>
|
|
<refname>FDF_get_file</refname>
|
|
<refpurpose>Gets the value of the /F key</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>string <function>fdf_get_file</function></funcdef>
|
|
<paramdef>int <parameter>fdf document</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
The <function>FDF_set_file</function> returns the value
|
|
of the /F key.
|
|
|
|
<para>
|
|
See also <function>FDF_set_file</function>.
|
|
|
|
</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
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
-->
|