File: fdf-get-attachment.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (76 lines) | stat: -rw-r--r-- 2,480 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<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>
  <methodsynopsis>
   <type>array</type><methodname>fdf_get_attachment</methodname>
   <methodparam><type>resource</type><parameter>fdf_document</parameter></methodparam>
   <methodparam><type>string</type><parameter>fieldname</parameter></methodparam>
   <methodparam><type>string</type><parameter>savepath</parameter></methodparam>
  </methodsynopsis>
  <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. 
  </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>
  <para>
   The returned array contains the following fields:
   <itemizedlist>
    <listitem>
     <simpara><parameter>path</parameter> - path were the file got stored</simpara>
     <simpara><parameter>size</parameter> - size of the stored file in bytes</simpara>
     <simpara><parameter>type</parameter> - mimetype if given in the FDF</simpara>
    </listitem>
   </itemizedlist>
  </para>
  <para>
   <example>
    <title>Storing an uploaded file</title>
    <programlisting role="php">
<![CDATA[
<?php 
  $fdf = fdf_open_string($HTTP_FDF_DATA);
  $data = fdf_get_attachment($fdf, "filename", "/tmpdir");
  echo "The uploaded file is stored in $data[path]";
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
</refentry>

<!-- 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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->