File: curlfile.xml

package info (click to toggle)
php-doc 20241205~git.dfcbb86%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 70,956 kB
  • sloc: xml: 968,269; php: 23,883; javascript: 671; sh: 177; makefile: 37
file content (129 lines) | stat: -rw-r--r-- 3,826 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
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.curlfile" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The CURLFile class</title>
 <titleabbrev>CURLFile</titleabbrev>

 <partintro>

<!-- {{{ CURLFile intro -->
  <section xml:id="curlfile.intro">
   &reftitle.intro;
   <para>
    This class or <classname>CURLStringFile</classname> should be used to upload a file with
    <constant>CURLOPT_POSTFIELDS</constant>.
   </para>
   <para>
    Unserialization of <classname>CURLFile</classname> instances is not allowed.
    As of PHP 7.4.0, serialization is forbidden in the first place.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="curlfile.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>CURLFile</classname>
    </ooclass>

    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="curlfile.props.name">name</varname>
     <initializer>""</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="curlfile.props.mime">mime</varname>
     <initializer>""</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <type>string</type>
     <varname linkend="curlfile.props.postname">postname</varname>
     <initializer>""</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.curlfile')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='CURLFile'])">
     <xi:fallback/>
    </xi:include>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.curlfile')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='CURLFile'])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ CURLFile properties -->
  <section xml:id="curlfile.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="curlfile.props.name">
     <term><varname>name</varname></term>
     <listitem>
      <para>Name of the file to be uploaded.</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="curlfile.props.mime">
     <term><varname>mime</varname></term>
     <listitem>
      <para>MIME type of the file (default is <literal>application/octet-stream</literal>).</para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="curlfile.props.postname">
     <term><varname>postname</varname></term>
     <listitem>
      <para>The name of the file in the upload data (defaults to the <varname>name</varname> property).</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->

  <section xml:id="curlfile.seealso">
   &reftitle.seealso;
   <para>
    <simplelist>
     <member>
      <function>curl_setopt</function>
     </member>
     <member><classname>CURLStringFile</classname></member>
    </simplelist>
   </para>
  </section>


 </partintro>

 &reference.curl.entities.curlfile;

</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:"~/.phpdoc/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
-->