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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 297028 $ -->
<refentry xml:id='function.curl-getinfo' xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>curl_getinfo</refname>
<refpurpose>Get information regarding a specific transfer</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>curl_getinfo</methodname>
<methodparam><type>resource</type><parameter>ch</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>opt</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
Gets information about the last transfer.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
&curl.ch.description;
<varlistentry>
<term><parameter>opt</parameter></term>
<listitem>
<para>
This may be one of the following constants:
<itemizedlist>
<listitem>
<simpara>
<constant>CURLINFO_EFFECTIVE_URL</constant> - Last effective URL
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_HTTP_CODE</constant> - Last received HTTP code
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_FILETIME</constant> - Remote time of the retrieved document, if -1 is returned the time of the document is unknown
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_TOTAL_TIME</constant> - Total transaction time in seconds for last transfer
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_NAMELOOKUP_TIME</constant> - Time in seconds until name resolving was complete
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_CONNECT_TIME</constant> - Time in seconds it took to establish the connection
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_PRETRANSFER_TIME</constant> - Time in seconds from start until just before file transfer begins
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_STARTTRANSFER_TIME</constant> - Time in seconds until the first byte is about to be transferred
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_REDIRECT_TIME</constant> - Time in seconds of all redirection steps before final transaction was started
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_SIZE_UPLOAD</constant> - Total number of bytes uploaded
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_SIZE_DOWNLOAD</constant> - Total number of bytes downloaded
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_SPEED_DOWNLOAD</constant> - Average download speed
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_SPEED_UPLOAD</constant> - Average upload speed
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_HEADER_SIZE</constant> - Total size of all headers received
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_HEADER_OUT</constant> - The request string sent
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_REQUEST_SIZE</constant> - Total size of issued requests, currently only for HTTP requests
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_SSL_VERIFYRESULT</constant> - Result of SSL certification verification requested by setting <constant>CURLOPT_SSL_VERIFYPEER</constant>
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_CONTENT_LENGTH_DOWNLOAD</constant> - content-length of download, read from <literal>Content-Length:</literal> field
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_CONTENT_LENGTH_UPLOAD</constant> - Specified size of upload
</simpara>
</listitem>
<listitem>
<simpara>
<constant>CURLINFO_CONTENT_TYPE</constant> - <literal>Content-Type:</literal> of downloaded object, NULL indicates server did not send valid <literal>Content-Type:</literal> header
</simpara>
</listitem>
</itemizedlist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
If <parameter>opt</parameter> is given, returns its value as a string.
Otherwise, returns an associative array with the following elements
(which correspond to <parameter>opt</parameter>):
<itemizedlist>
<listitem>
<simpara>
"url"
</simpara>
</listitem>
<listitem>
<simpara>
"content_type"
</simpara>
</listitem>
<listitem>
<simpara>
"http_code"
</simpara>
</listitem>
<listitem>
<simpara>
"header_size"
</simpara>
</listitem>
<listitem>
<simpara>
"request_size"
</simpara>
</listitem>
<listitem>
<simpara>
"filetime"
</simpara>
</listitem>
<listitem>
<simpara>
"ssl_verify_result"
</simpara>
</listitem>
<listitem>
<simpara>
"redirect_count"
</simpara>
</listitem>
<listitem>
<simpara>
"total_time"
</simpara>
</listitem>
<listitem>
<simpara>
"namelookup_time"
</simpara>
</listitem>
<listitem>
<simpara>
"connect_time"
</simpara>
</listitem>
<listitem>
<simpara>
"pretransfer_time"
</simpara>
</listitem>
<listitem>
<simpara>
"size_upload"
</simpara>
</listitem>
<listitem>
<simpara>
"size_download"
</simpara>
</listitem>
<listitem>
<simpara>
"speed_download"
</simpara>
</listitem>
<listitem>
<simpara>
"speed_upload"
</simpara>
</listitem>
<listitem>
<simpara>
"download_content_length"
</simpara>
</listitem>
<listitem>
<simpara>
"upload_content_length"
</simpara>
</listitem>
<listitem>
<simpara>
"starttransfer_time"
</simpara>
</listitem>
<listitem>
<simpara>
"redirect_time"
</simpara>
</listitem>
</itemizedlist>
</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>5.1.3</entry>
<entry>
Introduced <constant>CURLINFO_HEADER_OUT</constant>.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>curl_getinfo</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Create a curl handle
$ch = curl_init('http://www.yahoo.com/');
// Execute
curl_exec($ch);
// Check if any error occured
if(!curl_errno($ch))
{
$info = curl_getinfo($ch);
echo 'Took ' . $info['total_time'] . ' seconds to send a request to ' . $info['url'];
}
// Close handle
curl_close($ch);
?>
]]>
</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:"~/.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
-->
|
