doc-en/reference/curl/curlstringfile.xml at master · php/doc-en · GitHub

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
<?xml version="1.0" encoding="utf-8"?>
<reference xml:id="class.curlstringfile" 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 CURLStringFile class</title>
 <titleabbrev>CURLStringFile</titleabbrev>

 <partintro>

<!-- {{{ CURLStringFile intro -->
  <section xml:id="curlstringfile.intro">
   &reftitle.intro;
   <para>
    <classname>CURLStringFile</classname> makes it possible to upload a file directly from a variable.
    This is similar to <classname>CURLFile</classname>, but works with the contents of the file, not filename.
    This class or <classname>CURLFile</classname> should be used to upload the contents of the file with <constant>CURLOPT_POSTFIELDS</constant>.
   </para>
  </section>
<!-- }}} -->

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

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

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

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

  </section>

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

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

 </partintro>

 &reference.curl.entities.curlstringfile;

</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
-->