cvs: phpdoc /en/reference/fdf/functions fdf-add-doc-javascript.xml fdf-add-template.xml fdf-close.xml fdf-create.xml fdf-enum-values.xml fdf-errno.xml
fdf-error.xml fdf-get-ap.xml fdf-get-attachment.xml fdf-get-encoding.xml fdf-get-file.xml fdf-get-flags.xml fdf-get-opt.xml fdf-get-status.xml
fdf-get-value.xml fdf-get-version.xml fdf-header.xml fdf-next-field-name.xml fdf-open-string.xml fdf-open.xml fdf-remove-item.xml fdf-save-string.xml
fdf-save.xml fdf-set-ap.xml fdf-set-encoding.xml fdf-set-file.xml fdf-set-flags.xml fdf-set-javascript-action.xml fdf-set-on-import-javascript.xml
fdf-set-opt.xml fdf-set-status.xml fdf-set-submit-form-action.xml fdf-set-target-frame.xml fdf-set-value.xml fdf-set-version.xml

From:	Mehdi Achour	Date:	Mon, 19 Feb 2007 00:03:52 +0000
Subject:	cvs: phpdoc /en/reference/fdf/functions fdf-add-doc-javascript.xml fdf-add-template.xml fdf-close.xml fdf-create.xml fdf-enum-values.xml fdf-errno.xml fdf-error.xml fdf-get-ap.xml fdf-get-attachment.xml fdf-get-encoding.xml fdf-get-file.xml fdf-get-flags.xml fdf-get-opt.xml fdf-get-status.xml fdf-get-value.xml fdf-get-version.xml fdf-header.xml fdf-next-field-name.xml fdf-open-string.xml fdf-open.xml fdf-remove-item.xml fdf-save-string.xml fdf-save.xml fdf-set-ap.xml fdf-set-encoding.xml fdf-set-file.xml fdf-set-flags.xml fdf-set-javascript-action.xml fdf-set-on-import-javascript.xml fdf-set-opt.xml fdf-set-status.xml fdf-set-submit-form-action.xml fdf-set-target-frame.xml fdf-set-value.xml fdf-set-version.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969375518@lists.php.net to get a copy of this message

didou Mon Feb 19 00:03:52 2007 UTC Modified files: /phpdoc/en/reference/fdf/functions fdf-add-doc-javascript.xml fdf-add-template.xml fdf-close.xml fdf-create.xml fdf-enum-values.xml fdf-errno.xml fdf-error.xml fdf-get-ap.xml fdf-get-attachment.xml fdf-get-encoding.xml fdf-get-file.xml fdf-get-flags.xml fdf-get-opt.xml fdf-get-status.xml fdf-get-value.xml fdf-get-version.xml fdf-header.xml fdf-next-field-name.xml fdf-open-string.xml fdf-open.xml fdf-remove-item.xml fdf-save-string.xml fdf-save.xml fdf-set-ap.xml fdf-set-encoding.xml fdf-set-file.xml fdf-set-flags.xml fdf-set-javascript-action.xml fdf-set-on-import-javascript.xml fdf-set-opt.xml fdf-set-status.xml fdf-set-submit-form-action.xml fdf-set-target-frame.xml fdf-set-value.xml fdf-set-version.xml Log: ref.fdf: switch to new docstyle

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fdf/functions/fdf-add-doc-javascript.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/fdf/functions/fdf-add-doc-javascript.xml diff -u phpdoc/en/reference/fdf/functions/fdf-add-doc-javascript.xml:1.4 phpdoc/en/reference/fdf/functions/fdf-add-doc-javascript.xml:1.5 --- phpdoc/en/reference/fdf/functions/fdf-add-doc-javascript.xml:1.4 Mon Feb 19 00:03:36 2007 +++ phpdoc/en/reference/fdf/functions/fdf-add-doc-javascript.xml Mon Feb 19 00:03:52 2007 @@ -1,24 +1,68 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <refentry id='function.fdf-add-doc-javascript'> <refnamediv> <refname>fdf_add_doc_javascript</refname> <refpurpose>Adds javascript code to the FDF document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_add_doc_javascript</methodname> - <methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>script_name</parameter></methodparam> <methodparam><type>string</type><parameter>script_code</parameter></methodparam> </methodsynopsis> <para> - Adds a script to the FDF, which Acrobat then adds to the doc-level - scripts of a document, once the FDF is imported into it. It is strongly - suggested to use '\r' for linebreaks within <parameter>script_code</parameter>. + Adds a script to the FDF, which Acrobat then adds to the doc-level scripts + of a document, once the FDF is imported into it. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>script_name</parameter></term> + <listitem> + <para> + The script name. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>script_code</parameter></term> + <listitem> + <para> + The script code. It is strongly suggested to use <literal>\r</literal> + for linebreaks within the script code. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Adding JavaScript code to a FDF</title> @@ -54,6 +98,7 @@ </example> </para> </refsect1> + </refentry>  - + <refentry id='function.fdf-add-template'> <refnamediv> <refname>fdf_add_template</refname> <refpurpose>Adds a template into the FDF document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_add_template</methodname> - <methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>fdf_document</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> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id="function.fdf-close"> <refnamediv> <refname>fdf_close</refname> <refpurpose>Close an FDF document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>fdf_close</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_close</function> function closes the FDF document. + Closes the FDF document. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fdf_open</function>. + <simplelist> + <member><function>fdf_open</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fdf/functions/fdf-create.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/fdf/functions/fdf-create.xml diff -u phpdoc/en/reference/fdf/functions/fdf-create.xml:1.5 phpdoc/en/reference/fdf/functions/fdf-create.xml:1.6 --- phpdoc/en/reference/fdf/functions/fdf-create.xml:1.5 Mon Feb 19 00:03:36 2007 +++ phpdoc/en/reference/fdf/functions/fdf-create.xml Mon Feb 19 00:03:52 2007 @@ -1,26 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> - - + <refentry id="function.fdf-create"> <refnamediv> <refname>fdf_create</refname> <refpurpose>Create a new FDF document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>fdf_create</methodname> <void/> </methodsynopsis> <para> - The <function>fdf_create</function> creates a new - FDF document. This function is needed if one would like to - populate input fields in a PDF document with data. + Creates a new FDF document. </para> <para> - <example> - <title>Populating a PDF document</title> - <programlisting role="php"> + This function is needed if one would like to populate input fields in a + PDF document with data. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a FDF document handle, or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Populating a PDF document</title> + <programlisting role="php"> <![CDATA[ <?php $outfdf = fdf_create(); @@ -35,15 +48,22 @@ unlink("outtest.fdf"); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fdf_close</function>, - <function>fdf_save</function>, - <function>fdf_open</function>. + <simplelist> + <member><function>fdf_close</function></member> + <member><function>fdf_save</function></member> + <member><function>fdf_open</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.fdf-enum-values"> <refnamediv> <refname>fdf_enum_values</refname> <refpurpose>Call a user defined function for each document value </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_enum_values</methodname> - <methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>callback</type><parameter>function</parameter></methodparam> <methodparam choice='opt'><type>mixed</type><parameter>userdata</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.fdf-errno"> <refnamediv> <refname>fdf_errno</refname> <refpurpose>Return error code for last fdf operation</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>fdf_errno</methodname> <void/> </methodsynopsis> <para> - <function>fdf_errno</function> returns the error code set by - the last FDF function call. This is zero - for a successfull operation or a non-zero error code on failure. - A textual description may be obtained using the - <function>fdf_error</function> function. + Gets the error code set by the last FDF function call. </para> <para> - See also <function>fdf_error</function>. + A textual description of the error may be obtained using with + <function>fdf_error</function>. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the error code as an integer, or zero if there was no errors. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_error</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/fdf/functions/fdf-error.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/fdf/functions/fdf-error.xml diff -u phpdoc/en/reference/fdf/functions/fdf-error.xml:1.2 phpdoc/en/reference/fdf/functions/fdf-error.xml:1.3 --- phpdoc/en/reference/fdf/functions/fdf-error.xml:1.2 Mon Feb 19 00:03:36 2007 +++ phpdoc/en/reference/fdf/functions/fdf-error.xml Mon Feb 19 00:03:52 2007 @@ -1,28 +1,58 @@ <?xml version="1.0" encoding="iso-8859-1"?> - + <refentry id="function.fdf-error"> <refnamediv> <refname>fdf_error</refname> - <refpurpose>Return error description for fdf error code</refpurpose> + <refpurpose>Return error description for FDF error code</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>fdf_error</methodname> <methodparam choice='opt'><type>int</type><parameter>error_code</parameter></methodparam> </methodsynopsis> <para> - <function>fdf_error</function> returns a textual description for - the fdf error code given in <parameter>error_code</parameter>. - The function uses the internal error code set by the last operation - if no <parameter>error_code</parameter> is given, so - <literal>fdf_error()</literal> is a convenient shortcut for - <literal>fdf_error(fdf_errno())</literal>. + Gets a textual description for the FDF error code given in + <parameter>error_code</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>error_code</parameter></term> + <listitem> + <para> + An error code obtained with <function>fdf_errno</function>. + If not provided, this function uses the internal error code set by the + last operation. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_errno</function>. + Returns the error message as a string, or the string + <literal>no error</literal> if nothing went wrong. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_errno</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-get-ap"> <refnamediv> <refname>fdf_get_ap</refname> <refpurpose>Get the appearance of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_get_ap</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -16,14 +16,59 @@ <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_get_ap</function> function gets the - appearance of a <parameter>field</parameter> (i.e. the value of the /AP key) and - stores it in a file. The possible values of <parameter>face</parameter> - are <constant>FDFNormalAP</constant>, <constant>FDFRolloverAP</constant> and - <constant>FDFDownAP</constant>. The appearance is stored in - <parameter>filename</parameter>. + Gets the appearance of a <parameter>field</parameter> (i.e. the value of + the /AP key) and stores it in a file. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>face</parameter></term> + <listitem> + <para> + The possible values are <constant>FDFNormalAP</constant>, + <constant>FDFRolloverAP</constant> and <constant>FDFDownAP</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + The appearance will be stored in this parameter. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  + <refentry id="function.fdf-get-attachment"> <refnamediv> <refname>fdf_get_attachment</refname> <refpurpose>Extracts uploaded file embedded in the FDF</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>fdf_get_attachment</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -16,27 +17,72 @@ <para> Extracts a file uploaded by means of the "file selection" field <parameter>fieldname</parameter> and stores it under - <parameter>savepath</parameter>. <parameter>savepath</parameter> may be - the name of a plain file or an existing directory in which the file is to be created - under its original name. Any existing file under the same name will be overwritten. + <parameter>savepath</parameter>. </para> - <note> - <para> - There seems to be no other way to find out the original filename but to store - the file using a directory as <parameter>savepath</parameter> and check - for the basename it was stored under. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>savepath</parameter></term> + <listitem> + <para> + May be the name of a plain file or an existing directory in which the + file is to be created under its original name. Any existing file under + the same name will be overwritten. + </para> + <note> + <para> + There seems to be no other way to find out the original filename but + to store the file using a directory as + <parameter>savepath</parameter> and check for the basename it was + stored under. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> The returned array contains the following fields: <itemizedlist> <listitem> <simpara><parameter>path</parameter> - path were the file got stored</simpara> + </listitem> + <listitem> <simpara><parameter>size</parameter> - size of the stored file in bytes</simpara> + </listitem> + <listitem> <simpara><parameter>type</parameter> - mimetype if given in the FDF</simpara> </listitem> </itemizedlist> </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Storing an uploaded file</title> @@ -52,6 +98,7 @@ </example> </para> </refsect1> + </refentry>  + <refentry id="function.fdf-get-encoding"> <refnamediv> <refname>fdf_get_encoding</refname> <refpurpose>Get the value of the /Encoding key</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>fdf_get_encoding</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_get_encoding</function> returns the value - of the /Encoding key. An empty string is returned if the default - PDFDocEncoding/Unicode scheme is used. + Gets the value of the <literal>/Encoding</literal> key. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_encoding</function>. + Returns the encoding as a string. An empty string is returned if the + default <literal>PDFDocEncoding/Unicode</literal> scheme is used. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_encoding</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-get-file"> <refnamediv> <refname>fdf_get_file</refname> <refpurpose>Get the value of the /F key</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>fdf_get_file</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_get_file</function> returns the value - of the /F key. + Gets the value of the <literal>/F</literal> key. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_file</function>. + Returns the key value, as a string. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_file</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.fdf-get-flags"> <refnamediv> <refname>fdf_get_flags</refname> <refpurpose>Gets the flags of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>fdf_get_flags</methodname> - <methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> <methodparam><type>int</type><parameter>whichflags</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.fdf-get-opt"> <refnamediv> <refname>fdf_get_opt</refname> <refpurpose>Gets a value from the opt array of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>fdf_get_opt</methodname> - <methodparam><type>resource</type><parameter>fdfdof</parameter></methodparam> + <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> <methodparam choice='opt'><type>int</type><parameter>element</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  - + <refentry id="function.fdf-get-status"> <refnamediv> <refname>fdf_get_status</refname> <refpurpose>Get the value of the /STATUS key</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>fdf_get_status</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_get_status</function> returns the value - of the /STATUS key. + Gets the value of the <literal>/STATUS</literal> key. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_status</function>. + Returns the key value, as a string. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_status</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-get-value"> <refnamediv> <refname>fdf_get_value</refname> <refpurpose>Get the value of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>mixed</type><methodname>fdf_get_value</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -15,24 +15,86 @@ <methodparam choice='opt'><type>int</type><parameter>which</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_get_value</function> function returns the - value for the requested <parameter>fieldname</parameter>. + Gets the value for the requested field. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - Elements of an array field can be retrieved by passing the optional - <parameter>which</parameter>, starting at zero. For non-array fields - the optional parameter <parameter>which</parameter> will be ignored. + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + Name of the FDF field, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>which</parameter></term> + <listitem> + <para> + Elements of an array field can be retrieved by passing this optional + parameter, starting at zero. For non-array fields, this parameter will + be ignored. + </para> + </listitem> + </varlistentry> + </variablelist> </para> - <note> - <para> - Array support and optional <parameter>which</parameter> parameter - were added in PHP 4.3. - </para> - </note> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_value</function>. + Returns the field value. </para> </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.0</entry> + <entry> + Support for arrays and the <parameter>which</parameter> parameter + were added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_value</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.fdf-get-version"> <refnamediv> <refname>fdf_get_version</refname> <refpurpose>Gets version number for FDF API or file </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>fdf_get_version</methodname> <methodparam choice='opt'><type>resource</type><parameter>fdf_document</parameter></methodparam> </methodsynopsis> <para> - This function will return the fdf version for the given - <parameter>fdf_document</parameter>, or the toolkit API - version number if no parameter is given. + Return the FDF version for the given document, or the toolkit API version + number if no parameter is given. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - For the current FDF toolkit 5.0 the API version number is '5.0' - and the document version number is either '1.2', '1.3' or '1.4'. + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_version</function>. + Returns the version as a string. For the current FDF toolkit 5.0 the API + version number is <literal>5.0</literal> and the document version number + is either <literal>1.2</literal>, <literal>1.3</literal> or + <literal>1.4</literal>. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_version</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.fdf-header"> <refnamediv> <refname>fdf_header</refname> <refpurpose>Sets FDF-specific output headers</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>void</type><methodname>fdf_header</methodname> <void/> </methodsynopsis> <para> - This is a convenience function to set appropriate HTTP headers - for FDF output. It sets the <literal>Content-type:</literal> - to <literal>application/vnd.fdf</literal>. + This is a convenience function to set appropriate HTTP headers for FDF + output. It sets the <literal>Content-type:</literal> to + <literal>application/vnd.fdf</literal>. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.void; + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-next-field-name"> <refnamediv> <refname>fdf_next_field_name</refname> <refpurpose>Get the next field name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>fdf_next_field_name</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>fieldname</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_next_field_name</function> function returns the - name of the field after the field in - <parameter>fieldname</parameter> or the field name of the first field - if the second parameter is &null;. + Gets the name of the field after the given field. This name can be used + with several functions. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + Name of the FDF field, as a string. If not given, the first field will + be assumed. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the field name as a string. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Detecting all fieldnames in a FDF</title> @@ -29,17 +64,24 @@ for ($field = fdf_next_field_name($fdf); $field != ""; $field = fdf_next_field_name($fdf, $field)) { - echo "field: $field\n"; + echo "field: $field\n"; } ?> ]]> </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fdf_get_value</function>. + <simplelist> + <member><function>fdf_get_value</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.fdf-open-string"> <refnamediv> <refname>fdf_open_string</refname> <refpurpose>Read a FDF document from a string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>fdf_open_string</methodname> <methodparam><type>string</type><parameter>fdf_data</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_open_string</function> function reads form data - from a string. <parameter>fdf_data</parameter> must contain the data - as returned from a PDF form or created using <function>fdf_create</function> - and <function>fdf_save_string</function>. + Reads form data from a string. </para> <para> - You can <function>fdf_open_string</function> together with - <varname>$HTTP_FDF_DATA</varname> to process fdf form input - from a remote client. + You can use <function>fdf_open_string</function> together with + <varname>$HTTP_FDF_DATA</varname> to process FDF form input from a remote + client. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_data</parameter></term> + <listitem> + <para> + The data as returned from a PDF form or created using + <function>fdf_create</function> and + <function>fdf_save_string</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a FDF document handle, or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Accessing the form data</title> @@ -36,14 +63,20 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>fdf_open</function>, - <function>fdf_close</function>, - <function>fdf_create</function> and - <function>fdf_save_string</function>. + <simplelist> + <member><function>fdf_open</function></member> + <member><function>fdf_close</function></member> + <member><function>fdf_create</function></member> + <member><function>fdf_save_string</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.fdf-open"> <refnamediv> <refname>fdf_open</refname> <refpurpose>Open a FDF document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>resource</type><methodname>fdf_open</methodname> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_open</function> function opens - a file with form data. This file must contain the data as returned - from a PDF form or created using <function>fdf_create</function> and - <function>fdf_save</function>. + Opens a file with form data. </para> <para> - You can process the results of a PDF form POST request by writing - the data received in <varname>$HTTP_FDF_DATA</varname> to a file - and open it using <function>fdf_open</function>. Starting with PHP 4.3 - you can also use <function>fdf_open_string</function> which handles temporary - file creation and cleanup for you. + You can also use <function>fdf_open_string</function> to process the + results of a PDF form POST request. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + Path to the FDF file. This file must contain the data as returned from + a PDF form or created using <function>fdf_create</function> and + <function>fdf_save</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns a FDF document handle, or &false; on error. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Accessing the form data</title> @@ -45,14 +68,20 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>fdf_open_string</function>, - <function>fdf_close</function>, - <function>fdf_create</function> and - <function>fdf_save</function>. + <simplelist> + <member><function>fdf_open_string</function></member> + <member><function>fdf_close</function></member> + <member><function>fdf_create</function></member> + <member><function>fdf_save</function></member> + </simplelist> </para> </refsect1> + </refentry>  + <refentry id="function.fdf-remove-item"> <refnamediv> <refname>fdf_remove_item</refname> <refpurpose>Sets target frame for form</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_remove_item</methodname> - <methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>fieldname</parameter></methodparam> <methodparam><type>int</type><parameter>item</parameter></methodparam> </methodsynopsis> - <para> -&warn.undocumented.func; - </para> + &warn.undocumented.func; </refsect1> + </refentry>  + <refentry id="function.fdf-save-string"> <refnamediv> <refname>fdf_save_string</refname> <refpurpose>Returns the FDF document as a string</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>fdf_save_string</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_save_string</function> function returns the FDF document as a string. + Returns the FDF document as a string. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the document as a string, or &false; on error. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Retrieving FDF as a string</title> @@ -29,9 +57,7 @@ ?> ]]> </programlisting> - <para> - will output something like - </para> + &example.outputs; <screen> <![CDATA[ %FDF-1.2 @@ -56,13 +82,20 @@ </screen> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fdf_save</function>, - <function>fdf_open_string</function>, - <function>fdf_create</function> and - <function>fdf_close</function>. + <simplelist> + <member><function>fdf_open_string</function></member> + <member><function>fdf_close</function></member> + <member><function>fdf_create</function></member> + <member><function>fdf_save</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.fdf-save"> <refnamediv> <refname>fdf_save</refname> <refpurpose>Save a FDF document</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_save</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam choice='opt'><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_save</function> function saves a FDF document. - The resulting FDF will be written to <parameter>filename</parameter>. - Without a <parameter>filename</parameter> <function>fdf_save</function> - will write the FDF to the default PHP output stream. + Saves a FDF document. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + If provided, the resulting FDF will be written in this parameter. + Otherwise, this function will write the FDF to the default PHP output + stream. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_save_string</function>, - <function>fdf_create</function> and - <function>fdf_close</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_close</function></member> + <member><function>fdf_create</function></member> + <member><function>fdf_save_string</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-set-ap"> <refnamediv> <refname>fdf_set_ap</refname> <refpurpose>Set the appearance of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_ap</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -17,13 +17,66 @@ <methodparam><type>int</type><parameter>page_number</parameter></methodparam> </methodsynopsis> <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 <parameter>face</parameter> - are <constant>FDFNormalAP</constant>, <constant>FDFRolloverAP</constant> - and <constant>FDFDownAP</constant>. + Sets the appearance of a field (i.e. the value of the + <literal>/AP</literal> key). </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>field_name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>face</parameter></term> + <listitem> + <para> + The possible values <constant>FDFNormalAP</constant>, + <constant>FDFRolloverAP</constant> and + <constant>FDFDownAP</constant>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>filename</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>page_number</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-set-encoding"> <refnamediv> <refname>fdf_set_encoding</refname> <refpurpose>Sets FDF character encoding</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_encoding</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>encoding</parameter></methodparam> </methodsynopsis> <para> - <function>fdf_set_encoding</function> sets the character - encoding in FDF document <parameter>fdf_document</parameter>. - <parameter>encoding</parameter> should be the valid encoding - name. Currently the following values are supported: - "<literal>Shift-JIS</literal>", "<literal>UHC</literal>", - "<literal>GBK</literal>","<literal>BigFive</literal>". - An empty string resets the encoding to the default PDFDocEncoding/Unicode - scheme. + Sets the character encoding for the FDF document. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>encoding</parameter></term> + <listitem> + <para> + The encoding name. The following values are supported: + "<literal>Shift-JIS</literal>", "<literal>UHC</literal>", + "<literal>GBK</literal>" and "<literal>BigFive</literal>". + </para> + <para> + An empty string resets the encoding to the default + <literal>PDFDocEncoding/Unicode</literal> scheme. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-set-file"> <refnamediv> <refname>fdf_set_file</refname> <refpurpose>Set PDF document to display FDF data in</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_file</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -15,16 +15,55 @@ <methodparam choice='opt'><type>string</type><parameter>target_frame</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_set_file</function> selects a different PDF - document to display the form results in then the form it originated - from. The <parameter>url</parameter> needs to be given as an - absolute URL. + Selects a different PDF document to display the form results in then the + form it originated from. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The frame to display the document in may be selected using the optional - parameter <parameter>target_frame</parameter> or the function - <function>fdf_set_target_frame</function>. + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>url</parameter></term> + <listitem> + <para> + Should be given as an absolute URL. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>target_frame</parameter></term> + <listitem> + <para> + Use this parameter to specify the frame in which the document will be + displayed. You can also set the default value for this parameter using + <function>fdf_set_target_frame</function>. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Passing FDF data to a second form</title> @@ -53,11 +92,18 @@ </programlisting> </example> </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also <function>fdf_get_file</function> and - <function>fdf_set_target_frame</function>. + <simplelist> + <member><function>fdf_get_file</function></member> + <member><function>fdf_set_target_frame</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.fdf-set-flags"> <refnamediv> <refname>fdf_set_flags</refname> <refpurpose>Sets a flag of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_flags</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -16,13 +16,65 @@ <methodparam><type>int</type><parameter>newFlags</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_set_flags</function> sets certain flags - of the given field <parameter>fieldname</parameter>. + Sets certain flags of the given field. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + Name of the FDF field, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>whichFlags</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>newFlags</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_opt</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_opt</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-set-javascript-action"> <refnamediv> <refname>fdf_set_javascript_action</refname> <refpurpose>Sets an javascript action of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_javascript_action</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -16,13 +16,65 @@ <methodparam><type>string</type><parameter>script</parameter></methodparam> </methodsynopsis> <para> - <function>fdf_set_javascript_action</function> sets a javascript - action for the given field <parameter>fieldname</parameter>. + Sets a javascript action for the given field. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + Name of the FDF field, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>trigger</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>script</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_submit_form_action</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_submit_form_action</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id='function.fdf-set-on-import-javascript'> <refnamediv> <refname>fdf_set_on_import_javascript</refname> <refpurpose>Adds javascript code to be executed when Acrobat opens the FDF</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_on_import_javascript</methodname> - <methodparam><type>resource</type><parameter>fdfdoc</parameter></methodparam> + <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>script</parameter></methodparam> <methodparam><type>bool</type><parameter>before_data_import</parameter></methodparam> </methodsynopsis> &warn.undocumented.func; + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>fdf_add_doc_javascript</function>&listendand; - <function>fdf_set_javascript_action</function>. + <simplelist> + <member><function>fdf_add_doc_javascript</function></member> + <member><function>fdf_set_javascript_action</function></member> + </simplelist> </para> </refsect1> + </refentry>  - + <refentry id="function.fdf-set-opt"> <refnamediv> <refname>fdf_set_opt</refname> <refpurpose>Sets an option of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_opt</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -17,13 +17,72 @@ <methodparam><type>string</type><parameter>str2</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_set_opt</function> sets options - of the given field <parameter>fieldname</parameter>. + Sets options of the given field. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + Name of the FDF field, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>element</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str1</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>str2</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_flags</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_flags</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-set-status"> <refnamediv> <refname>fdf_set_status</refname> <refpurpose>Set the value of the /STATUS key</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_status</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>status</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_set_status</function> sets the value - of the /STATUS key. When a client receives a FDF with a status set - it will present the value in an alert box. + Sets the value of the <literal>/STATUS</literal> key. When a client + receives a FDF with a status set it will present the value in an alert + box. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>status</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_get_status</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_get_status</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  - + <refentry id="function.fdf-set-submit-form-action"> <refnamediv> <refname>fdf_set_submit_form_action</refname> <refpurpose>Sets a submit form action of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_submit_form_action</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -17,13 +17,72 @@ <methodparam><type>int</type><parameter>flags</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_set_submit_form_action</function> sets a submit form - action for the given field <parameter>fieldname</parameter>. + Sets a submit form action for the given field. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + Name of the FDF field, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>trigger</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>script</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>flags</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_set_javascript_action</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_set_javascript_action</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.fdf-set-target-frame"> <refnamediv> <refname>fdf_set_target_frame</refname> <refpurpose>Set target frame for form display</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_target_frame</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>frame_name</parameter></methodparam> </methodsynopsis> <para> - Sets the target frame to display a result PDF defined with <function>fdf_save_file</function> in. + Sets the target frame to display a result PDF defined with + <function>fdf_save_file</function> in. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>frame_name</parameter></term> + <listitem> + <para> + The frame name, as a string. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_save_file</function>. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_save_file</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.fdf-set-value"> <refnamediv> <refname>fdf_set_value</refname> <refpurpose>Set the value of a field</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_value</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> @@ -15,28 +16,103 @@ <methodparam choice='opt'><type>int</type><parameter>isName</parameter></methodparam> </methodsynopsis> <para> - The <function>fdf_set_value</function> function sets the - <parameter>value</parameter> for a field named <parameter>fieldname</parameter>. - The <parameter>value</parameter> will be stored as a string unless it is an array. - In this case all array elements will be stored as a value array. + Sets the <parameter>value</parameter> for the given field. </para> - <note> - <para> - In older versions of the fdf toolkit last parameter determined if the field value - was to be converted to a PDF Name (<parameter>isName</parameter> = 1) - or set to a PDF String (<parameter>isName</parameter> = 0). The value is no - longer used in the current toolkit version 5.0. For compatibility reasons it is - still supported as an optional parameter beginning with PHP 4.3, but ignored internally. - </para> - <para> - Support for <parameter>value</parameter> arrays was added in PHP 4.3. - </para> - </note> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>fieldname</parameter></term> + <listitem> + <para> + Name of the FDF field, as a string. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>value</parameter></term> + <listitem> + <para> + This parameter will be stored as a string unless it is an array. In + this case all array elements will be stored as a value array. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>isName</parameter></term> + <listitem> + <note> + <para> + In older versions of the FDF toolkit last parameter determined if the + field value was to be converted to a PDF Name (= 1) or set to a PDF + String (= 0). + </para> + <para> + The value is no longer used in the current toolkit version 5.0. For + compatibility reasons it is still supported as an optional parameter + beginning with PHP 4.3, but ignored internally. + </para> + </note> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>fdf_get_value</function> and - <function>fdf_remove_item</function>. + &return.success; </para> </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.3.0</entry> + <entry> + Support for arrays in the <parameter>value</parameter> parameter was + added. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_get_value</function></member> + <member><function>fdf_remove_item</function></member> + </simplelist> + </para> + </refsect1> + </refentry>  + <refentry id="function.fdf-set-version"> <refnamediv> <refname>fdf_set_version</refname> <refpurpose>Sets version number for a FDF file </refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>fdf_set_version</methodname> <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>version</parameter></methodparam> </methodsynopsis> <para> - This function will set the fdf <parameter>version</parameter> - for the given <parameter>fdf_document</parameter>. Some features - supported by this extension are only available in newer fdf versions. - For the current FDF toolkit 5.0 <parameter>version</parameter> - may be either '1.2', '1.3' or '1.4'. + Sets the FDF <parameter>version</parameter> for the given document. </para> <para> - See also <function>fdf_get_version</function>. + Some features supported by this extension are only available in newer FDF + versions. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>fdf_document</parameter></term> + <listitem> + <para> + The FDF document handle, returned by <function>fdf_create</function>, + <function>fdf_open</function> or <function>fdf_open_string</function>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>version</parameter></term> + <listitem> + <para> + The version number. For the current FDF toolkit 5.0, this may be + either <literal>1.2</literal>, <literal>1.3</literal> or + <literal>1.4</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>fdf_get_version</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file