File: curl.xml

package info (click to toggle)
php-doc 20081024-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 57,752 kB
  • ctags: 3,858
  • sloc: xml: 686,554; php: 19,446; perl: 610; cpp: 500; makefile: 336; sh: 114; awk: 28
file content (215 lines) | stat: -rw-r--r-- 5,429 bytes parent folder | download
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.2 $ -->

<refentry xml:id="context.curl" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" role="noversion">
 <refnamediv>
  <refname>CURL context options</refname>
  <refpurpose>CURL context option listing</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <para>
   CURL context options are available when the
   <link linkend="intro.curl">CURL</link> extension was compiled using the
   <option>--with-curlwrappers</option> configure option.
  </para>
 </refsect1>

 <refsect1 role="options"><!-- {{{ -->
  &reftitle.options;
  <para>
   <variablelist>
    <varlistentry xml:id="context.curl.method">
     <term>
      <parameter>method</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       <constant>GET</constant>, <constant>POST</constant>, or
       any other HTTP method supported by the remote server.
      </para>
      <para>
       Defaults to <constant>GET</constant>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.curl.header">
     <term>
      <parameter>header</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Additional headers to be sent during request. Values
       in this option will override other values (such as
       <literal>User-agent:</literal>, <literal>Host:</literal>,
       and <literal>Authentication:</literal>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.curl.user-agent">
     <term>
      <parameter>user_agent</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Value to send with User-Agent: header.
      </para>
      <para>
       By default the
       <link linkend="ini.user-agent">user_agent</link>
       &php.ini; setting is used.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.curl.content">
     <term>
      <parameter>content</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       Additional data to be sent after the headers. This option is not used
       for <constant>GET</constant> or <constant>HEAD</constant> requests.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.curl.proxy">
     <term>
      <parameter>proxy</parameter>
      <type>string</type>
     </term>
     <listitem>
      <para>
       URI specifying address of proxy server. (e.g.
       <literal>tcp://proxy.example.com:5100</literal>).
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.curl.max-redirects">
     <term>
      <parameter>max_redirects</parameter>
      <type>integer</type>
     </term>
     <listitem>
      <para>
       The max number of redirects to follow. Value <literal>1</literal> or
       less means that no redirects are followed.
      </para>
      <para>
       Defaults to <literal>20</literal>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.curl.curl-verify-ssl-host">
     <term>
      <parameter>curl_verify_ssl_host</parameter>
      <type>boolean</type>
     </term>
     <listitem>
      <para>
       Verify the host.
      </para>
      <para>
       Defaults to &false;
      </para>
      <note>
       <para>
        This option is available for both the http and ftp protocol wrappers.
       </para>
      </note>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="context.curl.curl-verify-ssl-peer">
     <term>
      <parameter>curl_verify_ssl_peer</parameter>
      <type>boolean</type>
     </term>
     <listitem>
      <para>
       Require verification of SSL certificate used.
      </para>
      <para>
       Defaults to &false;
      </para>
      <note>
       <para>
        This option is available for both the http and ftp protocol wrappers.
       </para>
      </note>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1><!-- }}} -->
 
 <refsect1 role="examples"><!-- {{{ -->
  &reftitle.examples;
  <para>
   <example xml:id="context.curl.example-post"><!-- {{{ -->
    <title>Fetch a page and send POST data</title>
    <programlisting role="php">
<![CDATA[
<?php

$postdata = http_build_query(
    array(
        'var1' => 'some content',
        'var2' => 'doh'
    )
);

$opts = array('http' =>
    array(
        'method'  => 'POST',
        'header'  => 'Content-type: application/x-www-form-urlencoded',
        'content' => $postdata
    )
);

$context  = stream_context_create($opts);

$result = file_get_contents('http://example.com/submit.php', false, $context);

?>
]]>
    </programlisting>
   </example><!-- }}} -->
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><xref linkend="context.socket" /></member>
   </simplelist>
  </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
-->