- fix PHP4 build (has no only_exceptions INI setting
[m6w6/ext-http] / docs / functions.html
1 <html>
2 <head>
3 <title>Function Summary of ext/http</title>
4 <style>
5 body {
6 font-size: 80%;
7 font-family: sans-serif;
8 }
9 h2, h3 {
10 color: #339;
11 clear: both;
12 font-size: 1.2em;
13 background: #ffc;
14 padding: .2em;
15 }
16 h2.o {
17 color: #66b;
18 clear: both;
19 font-size: 1.3em;
20 background: #f0f0f0;
21 padding: .2em;
22 }
23 p {
24 margin-left: 1em;
25 }
26 pre {
27 font-size: 1.2em;
28 }
29 br {
30 display: none;
31 }
32 blockquote {
33 margin-bottom: 3em;
34 border: 1px solid #ccc;
35 background: #f0f0f0;
36 padding: 0em 1em;
37 width: auto;
38 float: left;
39 }
40 p, pre {
41 clear: both;
42 }
43 p br, pre code br {
44 display: block;
45 }
46 </style>
47 </head>
48 <body><h1>http_functions.c</h1>
49 <h2 id="http_date">string http_date([int timestamp])</h2>
50 <p>This function returns a valid HTTP date regarding RFC 822/1123<br />
51 looking like: "Wed, 22 Dec 2004 11:34:47 GMT"</p>
52 <h2 id="http_absolute_uri">string http_absolute_uri(string url[, string proto[, string host[, int port]]])</h2>
53 <p>This function returns an absolute URI constructed from url.<br />
54 If the url is already abolute but a different proto was supplied,<br />
55 only the proto part of the URI will be updated. If url has no<br />
56 path specified, the path of the current REQUEST_URI will be taken.<br />
57 The host will be taken either from the Host HTTP header of the client<br />
58 the SERVER_NAME or just localhost if prior are not available.<br />
59 <br />
60 Some examples:</p><pre> url = "page.php" => http://www.example.com/current/path/page.php<br />
61 url = "/page.php" => http://www.example.com/page.php<br />
62 url = "/page.php", proto = "https" => https://www.example.com/page.php<br />
63 </pre></p>
64 <h2 id="http_negotiate_language">string http_negotiate_language(array supported[, string default = 'en-US'])</h2>
65 <p>This function negotiates the clients preferred language based on its<br />
66 Accept-Language HTTP header. It returns the negotiated language or<br />
67 the default language if none match.<br />
68 <br />
69 The qualifier is recognized and languages without qualifier are rated highest.<br />
70 <br />
71 The supported parameter is expected to be an array having<br />
72 the supported languages as array values.<br />
73 <br />
74 Example:</p><pre><blockquote><code><span style="color: #000000"><br />
75 <span style="color: #0000BB">&lt;?php<br />$langs </span><span style="color: #007700">= array(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'en-US'</span><span style="color: #007700">,</span><span style="color: #FF8000">// default<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'fr'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'fr-FR'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'de'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'de-AT'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'de-CH'</span><span style="color: #007700">,<br />);<br />include </span><span style="color: #DD0000">'./langs/'</span><span style="color: #007700">. </span><span style="color: #0000BB">http_negotiate_language</span><span style="color: #007700">(</span><span style="color: #0000BB">$langs</span><span style="color: #007700">) .</span><span style="color: #DD0000">'.php'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span><br />
76 </span><br />
77 </code></blockquote><br />
78 <br />
79 </pre></p>
80 <h2 id="http_negotiate_charset">string http_negotiate_charset(array supported[, string default = 'iso-8859-1'])</h2>
81 <p>This function negotiates the clients preferred charset based on its<br />
82 Accept-Charset HTTP header. It returns the negotiated charset or<br />
83 the default charset if none match.<br />
84 <br />
85 The qualifier is recognized and charset without qualifier are rated highest.<br />
86 <br />
87 The supported parameter is expected to be an array having<br />
88 the supported charsets as array values.<br />
89 <br />
90 Example:</p><pre><blockquote><code><span style="color: #000000"><br />
91 <span style="color: #0000BB">&lt;?php<br />$charsets </span><span style="color: #007700">= array(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'iso-8859-1'</span><span style="color: #007700">, </span><span style="color: #FF8000">// default<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'iso-8859-2'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'iso-8859-15'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'utf-8'<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pref </span><span style="color: #007700">= </span><span style="color: #0000BB">http_negotiate_charset</span><span style="color: #007700">(</span><span style="color: #0000BB">$charsets</span><span style="color: #007700">);<br />if (!</span><span style="color: #0000BB">strcmp</span><span style="color: #007700">(</span><span style="color: #0000BB">$pref</span><span style="color: #007700">, </span><span style="color: #DD0000">'iso-8859-1'</span><span style="color: #007700">)) {<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">iconv_set_encoding</span><span style="color: #007700">(</span><span style="color: #DD0000">'internal_encoding'</span><span style="color: #007700">, </span><span style="color: #DD0000">'iso-8859-1'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">iconv_set_encoding</span><span style="color: #007700">(</span><span style="color: #DD0000">'output_encoding'</span><span style="color: #007700">, </span><span style="color: #0000BB">$pref</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">ob_start</span><span style="color: #007700">(</span><span style="color: #DD0000">'ob_iconv_handler'</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span><br />
92 </span><br />
93 </code></blockquote><br />
94 <br />
95 </pre></p>
96 <h2 id="http_send_status">bool http_send_status(int status)</h2>
97 <p>Send HTTP status code.</p>
98 <h2 id="http_send_last_modified">bool http_send_last_modified([int timestamp])</h2>
99 <p>This converts the given timestamp to a valid HTTP date and<br />
100 sends it as "Last-Modified" HTTP header. If timestamp is<br />
101 omitted, current time is sent.</p>
102 <h2 id="http_send_content_type">bool http_send_content_type([string content_type = 'application/x-octetstream'])</h2>
103 <p>Sets the content type.</p>
104 <h2 id="http_send_content_disposition">bool http_send_content_disposition(string filename[, bool inline = false])</h2>
105 <p>Set the Content Disposition. The Content-Disposition header is very useful<br />
106 if the data actually sent came from a file or something similar, that should<br />
107 be "saved" by the client/user (i.e. by browsers "Save as..." popup window).</p>
108 <h2 id="http_match_modified">bool http_match_modified([int timestamp[, for_range = false]])</h2>
109 <p>Matches the given timestamp against the clients "If-Modified-Since" resp.<br />
110 "If-Unmodified-Since" HTTP headers.</p>
111 <h2 id="http_match_etag">bool http_match_etag(string etag[, for_range = false])</h2>
112 <p>This matches the given ETag against the clients<br />
113 "If-Match" resp. "If-None-Match" HTTP headers.</p>
114 <h2 id="http_cache_last_modified">bool http_cache_last_modified([int timestamp_or_expires]])</h2>
115 <p>If timestamp_or_expires is greater than 0, it is handled as timestamp<br />
116 and will be sent as date of last modification. If it is 0 or omitted,<br />
117 the current time will be sent as Last-Modified date. If it's negative,<br />
118 it is handled as expiration time in seconds, which means that if the<br />
119 requested last modification date is not between the calculated timespan,<br />
120 the Last-Modified header is updated and the actual body will be sent.</p>
121 <h2 id="http_cache_etag">bool http_cache_etag([string etag])</h2>
122 <p>This function attempts to cache the HTTP body based on an ETag,<br />
123 either supplied or generated through calculation of the MD5<br />
124 checksum of the output (uses output buffering).<br />
125 <br />
126 If clients "If-None-Match" header matches the supplied/calculated<br />
127 ETag, the body is considered cached on the clients side and<br />
128 a "304 Not Modified" status code is issued.</p>
129 <h2 id="ob_etaghandler">string ob_etaghandler(string data, int mode)</h2>
130 <p>For use with ob_start().</p>
131 <h2 id="http_throttle">void http_throttle(double sec[, long bytes = 2097152])</h2>
132 <p>Use with http_send() API.<br />
133 <br />
134 Example:</p><pre><blockquote><code><span style="color: #000000"><br />
135 <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// ~ 20 kbyte/s<br /># http_throttle(1, 20000);<br /># http_throttle(0.5, 10000);<br /># http_throttle(0.1, 2000);<br /></span><span style="color: #0000BB">http_send_file</span><span style="color: #007700">(</span><span style="color: #DD0000">'document.pdf'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span><br />
136 </span><br />
137 </code></blockquote><br />
138 <br />
139 </pre></p>
140 <h2 id="http_redirect">void http_redirect([string url[, array params[, bool session,[ bool permanent]]]])</h2>
141 <p>Redirect to a given url.<br />
142 The supplied url will be expanded with http_absolute_uri(), the params array will<br />
143 be treated with http_build_query() and the session identification will be appended<br />
144 if session is true.<br />
145 <br />
146 Depending on permanent the redirection will be issued with a permanent<br />
147 ("301 Moved Permanently") or a temporary ("302 Found") redirection<br />
148 status code.<br />
149 <br />
150 To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,<br />
151 if the client doesn't redirect immediatly.</p>
152 <h2 id="http_send_data">bool http_send_data(string data)</h2>
153 <p>Sends raw data with support for (multiple) range requests.</p>
154 <h2 id="http_send_file">bool http_send_file(string file)</h2>
155 <p>Sends a file with support for (multiple) range requests.</p>
156 <h2 id="http_send_stream">bool http_send_stream(resource stream)</h2>
157 <p>Sends an already opened stream with support for (multiple) range requests.</p>
158 <h2 id="http_chunked_decode">string http_chunked_decode(string encoded)</h2>
159 <p>This function decodes a string that was HTTP-chunked encoded.<br />
160 Returns false on failure.</p>
161 <h2 id="http_split_response">array http_split_response(string http_response)</h2>
162 <p>This function splits an HTTP response into an array with headers and the<br />
163 content body. The returned array may look simliar to the following example:</p><pre><blockquote><code><span style="color: #000000"><br />
164 <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">array(<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">0 </span><span style="color: #007700">=&gt; array(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'Response Status' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'200 Ok'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'Content-Type' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'text/plain'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'Content-Language' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'en-US'<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">),<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">1 </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"Hello World!"<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span><br />
165 </span><br />
166 </code></blockquote><br />
167 <br />
168 </pre></p>
169 <h2 id="http_parse_headers">array http_parse_headers(string header)</h2>
170 <p></p>
171 <h2 id="http_get_request_headers">array http_get_request_headers(void)</h2>
172 <p>Get a list of incoming HTTP headers.</p>
173 <h2 id="http_get_request_body">string http_get_request_body(void)</h2>
174 <p>Get the raw request body (e.g. POST or PUT data).</p>
175 <h2 id="http_match_request_header">bool http_match_request_header(string header, string value[, bool match_case = false])</h2>
176 <p>Match an incoming HTTP header.</p>
177 <h2 id="http_get">string http_get(string url[, array options[, array &info]])</h2>
178 <p>Performs an HTTP GET request on the supplied url.<br />
179 <br />
180 The second parameter is expected to be an associative<br />
181 array where the following keys will be recognized:</p><pre> - redirect: int, whether and how many redirects to follow<br />
182 - unrestrictedauth: bool, whether to continue sending credentials on<br />
183 redirects to a different host<br />
184 - proxyhost: string, proxy host in "host[:port]" format<br />
185 - proxyport: int, use another proxy port as specified in proxyhost<br />
186 - proxyauth: string, proxy credentials in "user:pass" format<br />
187 - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM<br />
188 - httpauth: string, http credentials in "user:pass" format<br />
189 - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM<br />
190 - compress: bool, whether to allow gzip/deflate content encoding<br />
191 (defaults to true)<br />
192 - port: int, use another port as specified in the url<br />
193 - referer: string, the referer to sends<br />
194 - useragent: string, the user agent to send<br />
195 (defaults to PECL::HTTP/version (PHP/version)))<br />
196 - headers: array, list of custom headers as associative array<br />
197 like array("header" => "value")<br />
198 - cookies: array, list of cookies as associative array<br />
199 like array("cookie" => "value")<br />
200 - cookiestore: string, path to a file where cookies are/will be stored<br />
201 - resume: int, byte offset to start the download from;<br />
202 if the server supports ranges<br />
203 - maxfilesize: int, maximum file size that should be downloaded;<br />
204 has no effect, if the size of the requested entity is not known<br />
205 - lastmodified: int, timestamp for If-(Un)Modified-Since header<br />
206 - timeout: int, seconds the request may take<br />
207 - connecttimeout: int, seconds the connect may take<br />
208 - onprogress: mixed, progress callback</pre><p>The optional third parameter will be filled with some additional information<br />
209 in form af an associative array, if supplied, like the following example:</p><pre><blockquote><code><span style="color: #000000"><br />
210 <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">array (<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'effective_url' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'http://localhost'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'response_code' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">403</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'total_time' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0.017</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'namelookup_time' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0.013</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'connect_time' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0.014</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'pretransfer_time' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0.014</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'size_upload' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'size_download' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">202</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'speed_download' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">11882</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'speed_upload' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'header_size' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">145</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'request_size' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">62</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'ssl_verifyresult' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'filetime' </span><span style="color: #007700">=&gt; -</span><span style="color: #0000BB">1</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'content_length_download' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">202</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'content_length_upload' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'starttransfer_time' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0.017</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'content_type' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'text/html; charset=iso-8859-1'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'redirect_time' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'redirect_count' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'private' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">''</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'http_connectcode' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'httpauth_avail' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #DD0000">'proxyauth_avail' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />)<br /></span><span style="color: #0000BB">?&gt;</span><br />
211 </span><br />
212 </code></blockquote><br />
213 <br />
214 </pre></p>
215 <h2 id="http_head">string http_head(string url[, array options[, array &info]])</h2>
216 <p>Performs an HTTP HEAD request on the suppied url.<br />
217 Returns the HTTP response as string.<br />
218 See http_get() for a full list of available options.</p>
219 <h2 id="http_post_data">string http_post_data(string url, string data[, array options[, &info]])</h2>
220 <p>Performs an HTTP POST request, posting data.<br />
221 Returns the HTTP response as string.<br />
222 See http_get() for a full list of available options.</p>
223 <h2 id="http_post_fields">string http_post_fields(string url, array data[, array files[, array options[, array &info]]])</h2>
224 <p>Performs an HTTP POST request, posting www-form-urlencoded array data.<br />
225 Returns the HTTP response as string.<br />
226 See http_get() for a full list of available options.</p>
227 <h2 id="http_put_file">string http_put_file(string url, string file[, array options[, array &info]])</h2>
228 <p>Performs an HTTP PUT request, uploading file.<br />
229 Returns the HTTP response as string.<br />
230 See http_get() for a full list of available options.</p>
231 <h2 id="http_put_stream">string http_put_stream(string url, resource stream[, array options[, array &info]])</h2>
232 <p>Performs an HTTP PUT request, uploading stream.<br />
233 Returns the HTTP response as string.<br />
234 See http_get() for a full list of available options.</p>
235 <h2 id="http_request_method_register">long http_request_method_register(string method)</h2>
236 <p>Register a custom request method.</p>
237 <h2 id="http_request_method_unregister">bool http_request_method_unregister(mixed method)</h2>
238 <p>Unregister a previously registered custom request method.</p>
239 <h2 id="http_request_method_exists">long http_request_method_exists(mixed method)</h2>
240 <p>Check if a request method is registered (or available by default).</p>
241 <h2 id="http_request_method_name">string http_request_method_name(long method)</h2>
242 <p>Get the literal string representation of a standard or registered request method.</p>
243 <h2 id="http_auth_basic">bool http_auth_basic(string user, string pass[, string realm = "Restricted"])</h2>
244 <p>Example:</p><pre><blockquote><code><span style="color: #000000"><br />
245 <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">if (!</span><span style="color: #0000BB">http_auth_basic</span><span style="color: #007700">(</span><span style="color: #DD0000">'mike'</span><span style="color: #007700">, </span><span style="color: #DD0000">'s3c|r3t'</span><span style="color: #007700">)) {<br />&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">'&lt;h1&gt;Authorization failed!&lt;/h1&gt;'</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span><br />
246 </span><br />
247 </code></blockquote><br />
248 <br />
249 </pre></p>
250 <h2 id="http_auth_basic_cb">bool http_auth_basic_cb(mixed callback[, string realm = "Restricted"])</h2>
251 <p>Example:</p><pre><blockquote><code><span style="color: #000000"><br />
252 <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">function </span><span style="color: #0000BB">auth_cb</span><span style="color: #007700">(</span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$pass</span><span style="color: #007700">)<br />{<br />&nbsp;&nbsp;&nbsp;&nbsp;global </span><span style="color: #0000BB">$db</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$query </span><span style="color: #007700">= </span><span style="color: #DD0000">'SELECT pass FROM users WHERE user='</span><span style="color: #007700">. </span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">quoteSmart</span><span style="color: #007700">(</span><span style="color: #0000BB">$user</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;if (</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$realpass </span><span style="color: #007700">= </span><span style="color: #0000BB">$db</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getOne</span><span style="color: #007700">(</span><span style="color: #0000BB">$query</span><span style="color: #007700">)) {<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return </span><span style="color: #0000BB">$pass </span><span style="color: #007700">=== </span><span style="color: #0000BB">$realpass</span><span style="color: #007700">;<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br />}<br />if (!</span><span style="color: #0000BB">http_auth_basic_cb</span><span style="color: #007700">(</span><span style="color: #DD0000">'auth_cb'</span><span style="color: #007700">)) {<br />&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">'&lt;h1&gt;Authorization failed&lt;/h1&gt;'</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span><br />
253 </span><br />
254 </code></blockquote><br />
255 <br />
256 </pre></p>
257 <h2 id="http_build_query">string http_build_query(mixed formdata [, string prefix[, string arg_separator]])</h2>
258 <p>Generates a form-encoded query string from an associative array or object.</p>
259 <hr noshade>
260 <h1>http_message_object.c</h1>
261 <h2 id="HttpMessage" class="o">HttpMessage</h2>
262 <h3 id="HttpMessage___construct">void HttpMessage::__construct([string message])</h3>
263 <p>Instantiate a new HttpMessage object.</p>
264 <h3 id="HttpMessage_fromString">static HttpMessage HttpMessage::fromString(string raw_message)</h3>
265 <p>Create an HttpMessage object from a string.</p>
266 <h3 id="HttpMessage_getBody">string HttpMessage::getBody()</h3>
267 <p>Get the body of the parsed Message.</p>
268 <h3 id="HttpMessage_getHeaders">array HttpMessage::getHeaders()</h3>
269 <p>Get Message Headers.</p>
270 <h3 id="HttpMessage_setHeaders">void HttpMessage::setHeaders(array headers)</h3>
271 <p>Sets new headers.</p>
272 <h3 id="HttpMessage_addHeaders">void HttpMessage::addHeaders(array headers[, bool append = false])</h3>
273 <p>Add headers. If append is true, headers with the same name will be separated, else overwritten.</p>
274 <h3 id="HttpMessage_getType">long HttpMessage::getType()</h3>
275 <p>Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)</p>
276 <h3 id="HttpMessage_setType">void HttpMessage::setType(long type)</h3>
277 <p>Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)</p>
278 <h3 id="HttpMessage_getResponseCode">long HttpMessage::getResponseCode()</h3>
279 <p>Get the Response Code of the Message.</p>
280 <h3 id="HttpMessage_setResponseCode">bool HttpMessage::setResponseCode(long code)</h3>
281 <p>Set the response code of an HTTP Response Message.<br />
282 Returns false if the Message is not of type HTTP_MSG_RESPONSE,<br />
283 or if the response code is out of range (100-510).</p>
284 <h3 id="HttpMessage_getRequestMethod">string HttpMessage::getRequestMethod()</h3>
285 <p>Get the Request Method of the Message.<br />
286 Returns false if the Message is not of type HTTP_MSG_REQUEST.</p>
287 <h3 id="HttpMessage_setRequestMethod">bool HttpMessage::setRequestMethod(string method)</h3>
288 <p>Set the Request Method of the HTTP Message.<br />
289 Returns false if the Message is not of type HTTP_MSG_REQUEST.</p>
290 <h3 id="HttpMessage_getRequestUri">string HttpMessage::getRequestUri()</h3>
291 <p>Get the Request URI of the Message.</p>
292 <h3 id="HttpMessage_setRequestUri">bool HttpMessage::setRequestUri(string URI)</h3>
293 <p>Set the Request URI of the HTTP Message.<br />
294 Returns false if the Message is not of type HTTP_MSG_REQUEST,<br />
295 or if paramtere URI was empty.</p>
296 <h3 id="HttpMessage_getHttpVersion">string HttpMessage::getHttpVersion()</h3>
297 <p>Get the HTTP Protocol Version of the Message.</p>
298 <h3 id="HttpMessage_setHttpVersion">bool HttpMessage::setHttpVersion(string version)</h3>
299 <p>Set the HTTP Protocol version of the Message.<br />
300 Returns false if version is invalid (1.0 and 1.1).</p>
301 <h3 id="HttpMessage_getParentMessage">HttpMessage HttpMessage::getParentMessage()</h3>
302 <p>Get parent Message.</p>
303 <h3 id="HttpMessage_send">bool HttpMessage::send()</h3>
304 <p>Send the Message according to its type as Response or Request.</p>
305 <h3 id="HttpMessage_toString">string HttpMessage::toString([bool include_parent = true])</h3>
306 <p>Get the string representation of the Message.</p>
307 <hr noshade>
308 <h1>http_request_object.c</h1>
309 <h2 id="HttpRequest" class="o">HttpRequest</h2>
310 <h3 id="HttpRequest___construct">void HttpRequest::__construct([string url[, long request_method = HTTP_GET]])</h3>
311 <p>Instantiate a new HttpRequest object which can be used to issue HEAD, GET<br />
312 and POST (including posting files) HTTP requests.</p>
313 <h3 id="HttpRequest___destruct">void HttpRequest::__destruct()</h3>
314 <p>Destroys the HttpRequest object.</p>
315 <h3 id="HttpRequest_setOptions">bool HttpRequest::setOptions(array options)</h3>
316 <p>Set the request options to use. See http_get() for a full list of available options.</p>
317 <h3 id="HttpRequest_getOptions">array HttpRequest::getOptions()</h3>
318 <p>Get current set options.</p>
319 <h3 id="HttpRequest_unsetOptions">void HttpRequest::unsetOptions()</h3>
320 <p>Unset all options/headers/cookies.</p>
321 <h3 id="HttpRequest_setSslOptions">bool HttpRequest::setSslOptions(array options)</h3>
322 <p>Set additional SSL options.</p>
323 <h3 id="HttpRequest_getSslOptions">array HttpRequest::getSslOtpions()</h3>
324 <p>Get previously set SSL options.</p>
325 <h3 id="HttpRequest_unsetSslOptions">void HttpRequest::unsetSslOptions()</h3>
326 <p>Unset previously set SSL options.</p>
327 <h3 id="HttpRequest_addHeaders">bool HttpRequest::addHeaders(array headers)</h3>
328 <p>Add request header name/value pairs.</p>
329 <h3 id="HttpRequest_getHeaders">array HttpRequest::getHeaders()</h3>
330 <p>Get previously set request headers.</p>
331 <h3 id="HttpRequest_unsetHeaders">void HttpRequest::unsetHeaders()</h3>
332 <p>Unset previously set request headers.</p>
333 <h3 id="HttpRequest_addCookies">bool HttpRequest::addCookies(array cookies)</h3>
334 <p>Add cookies.</p>
335 <h3 id="HttpRequest_getCookies">array HttpRequest::getCookies()</h3>
336 <p>Get previously set cookies.</p>
337 <h3 id="HttpRequest_unsetCookies">void HttpRequest::unsetCookies()</h3>
338 <p></p>
339 <h3 id="HttpRequest_setUrl">bool HttpRequest::setUrl(string url)</h3>
340 <p>Set the request URL.</p>
341 <h3 id="HttpRequest_getUrl">string HttpRequest::getUrl()</h3>
342 <p>Get the previously set request URL.</p>
343 <h3 id="HttpRequest_setMethod">bool HttpRequest::setMethod(long request_method)</h3>
344 <p>Set the request methods; one of the <tt>HTTP_HEAD</tt>, <tt>HTTP_GET</tt> or<br />
345 <tt>HTTP_POST</tt> constants.</p>
346 <h3 id="HttpRequest_getMethod">long HttpRequest::getMethod()</h3>
347 <p>Get the previously set request method.</p>
348 <h3 id="HttpRequest_setContentType">bool HttpRequest::setContentType(string content_type)</h3>
349 <p>Set the content type the post request should have.<br />
350 Use this only if you know what you're doing.</p>
351 <h3 id="HttpRequest_getContentType">string HttpRequest::getContentType()</h3>
352 <p>Get the previously content type.</p>
353 <h3 id="HttpRequest_setQueryData">bool HttpRequest::setQueryData(mixed query_data)</h3>
354 <p>Set the URL query parameters to use.<br />
355 Overwrites previously set query parameters.<br />
356 Affects any request types.</p>
357 <h3 id="HttpRequest_getQueryData">string HttpRequest::getQueryData()</h3>
358 <p>Get the current query data in form of an urlencoded query string.</p>
359 <h3 id="HttpRequest_addQueryData">bool HttpRequest::addQueryData(array query_params)</h3>
360 <p>Add parameters to the query parameter list.<br />
361 Affects any request type.</p>
362 <h3 id="HttpRequest_unsetQueryData">void HttpRequest::unsetQueryData()</h3>
363 <p>Clean the query parameters.<br />
364 Affects any request type.</p>
365 <h3 id="HttpRequest_addPostFields">bool HttpRequest::addPostFields(array post_data)</h3>
366 <p>Adds POST data entries.<br />
367 Affects only POST requests.</p>
368 <h3 id="HttpRequest_setPostFields">bool HttpRequest::setPostFields(array post_data)</h3>
369 <p>Set the POST data entries.<br />
370 Overwrites previously set POST data.<br />
371 Affects only POST requests.</p>
372 <h3 id="HttpRequest_getPostFields">array HttpRequest::getPostFields()</h3>
373 <p>Get previously set POST data.</p>
374 <h3 id="HttpRequest_unsetPostFields">void HttpRequest::unsetPostFields()</h3>
375 <p>Clean POST data entires.<br />
376 Affects only POST requests.</p>
377 <h3 id="HttpRequest_addPostFile">bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])</h3>
378 <p>Add a file to the POST request.<br />
379 Affects only POST requests.</p>
380 <h3 id="HttpRequest_setPostFiles">bool HttpRequest::setPostFiles(array post_files)</h3>
381 <p>Set files to post.<br />
382 Overwrites previously set post files.<br />
383 Affects only POST requests.</p>
384 <h3 id="HttpRequest_getPostFiles">array HttpRequest::getPostFiles()</h3>
385 <p>Get all previously added POST files.</p>
386 <h3 id="HttpRequest_unsetPostFiles">void HttpRequest::unsetPostFiles()</h3>
387 <p>Unset the POST files list.<br />
388 Affects only POST requests.</p>
389 <h3 id="HttpRequest_setPutFile">bool HttpRequest::SetPutFile(string file)</h3>
390 <p>Set file to put.<br />
391 Affects only PUT requests.</p>
392 <h3 id="HttpRequest_getPutFile">string HttpRequest::getPutFile()</h3>
393 <p>Get previously set put file.</p>
394 <h3 id="HttpRequest_unsetPutFile">void HttpRequest::unsetPutFile()</h3>
395 <p>Unset file to put.<br />
396 Affects only PUT requests.</p>
397 <h3 id="HttpRequest_getResponseData">array HttpRequest::getResponseData()</h3>
398 <p>Get all response data after the request has been sent.</p>
399 <h3 id="HttpRequest_getResponseHeader">mixed HttpRequest::getResponseHeader([string name])</h3>
400 <p>Get response header(s) after the request has been sent.</p>
401 <h3 id="HttpRequest_getResponseCookie">array HttpRequest::getResponseCookie([string name])</h3>
402 <p>Get response cookie(s) after the request has been sent.</p>
403 <h3 id="HttpRequest_getResponseBody">string HttpRequest::getResponseBody()</h3>
404 <p>Get the response body after the request has been sent.</p>
405 <h3 id="HttpRequest_getResponseCode">int HttpRequest::getResponseCode()</h3>
406 <p>Get the response code after the request has been sent.</p>
407 <h3 id="HttpRequest_getResponseInfo">array HttpRequest::getResponseInfo([string name])</h3>
408 <p>Get response info after the request has been sent.<br />
409 See http_get() for a full list of returned info.</p>
410 <h3 id="HttpRequest_getResponseMessage">HttpMessage HttpRequest::getResponseMessage()</h3>
411 <p>Get the full response as HttpMessage object.</p>
412 <h3 id="HttpRequest_getRequestMessage">HttpMessage HttpRequest::getRequestMessage()</h3>
413 <p>Get sent HTTP message.</p>
414 <h3 id="HttpRequest_send">bool HttpRequest::send()</h3>
415 <p>Send the HTTP request.<br />
416 <br />
417 GET example:</p><pre><blockquote><code><span style="color: #000000"><br />
418 <span style="color: #0000BB">&lt;?php<br />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">HttpRequest</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://example.com/feed.rss'</span><span style="color: #007700">, </span><span style="color: #0000BB">HTTP_GET</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setOptions</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'lastmodified' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">filemtime</span><span style="color: #007700">(</span><span style="color: #DD0000">'local.rss'</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addQueryData</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'category' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">3</span><span style="color: #007700">));<br />try {<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">send</span><span style="color: #007700">();<br />&nbsp;&nbsp;&nbsp;&nbsp;if (</span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponseCode</span><span style="color: #007700">() == </span><span style="color: #0000BB">200</span><span style="color: #007700">) {<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">file_put_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'local.rss'</span><span style="color: #007700">, </span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponseBody</span><span style="color: #007700">());<br />&nbsp;&nbsp;&nbsp;}<br />} catch (</span><span style="color: #0000BB">HttpException $ex</span><span style="color: #007700">) {<br />&nbsp;&nbsp;&nbsp;&nbsp;echo </span><span style="color: #0000BB">$ex</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span><br />
419 </span><br />
420 </code></blockquote></pre><p>POST example:</p><pre><blockquote><code><span style="color: #000000"><br />
421 <span style="color: #0000BB">&lt;?php<br />$r </span><span style="color: #007700">= new </span><span style="color: #0000BB">HttpRequest</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://example.com/form.php'</span><span style="color: #007700">, </span><span style="color: #0000BB">HTTP_POST</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setOptions</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'cookies' </span><span style="color: #007700">=&gt; array(</span><span style="color: #DD0000">'lang' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'de'</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addpostFields</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'user' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'mike'</span><span style="color: #007700">, </span><span style="color: #DD0000">'pass' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'s3c|r3t'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">addPostFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'image'</span><span style="color: #007700">, </span><span style="color: #DD0000">'profile.jpg'</span><span style="color: #007700">, </span><span style="color: #DD0000">'image/jpeg'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">send</span><span style="color: #007700">()) {<br />&nbsp;&nbsp;&nbsp;&nbsp;echo </span><span style="color: #0000BB">$r</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponseBody</span><span style="color: #007700">();<br />}<br /></span><span style="color: #0000BB">?&gt;</span><br />
422 </span><br />
423 </code></blockquote><br />
424 <br />
425 </pre></p>
426 <hr noshade>
427 <h1>http_requestpool_object.c</h1>
428 <h2 id="HttpRequestPool" class="o">HttpRequestPool</h2>
429 <h3 id="HttpRequestPool___construct">void HttpRequestPool::__construct([HttpRequest request[, ...]])</h3>
430 <p>Instantiate a new HttpRequestPool object. An HttpRequestPool is<br />
431 able to send several HttpRequests in parallel.<br />
432 <br />
433 Example:</p><pre><blockquote><code><span style="color: #000000"><br />
434 <span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">try {<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$pool </span><span style="color: #007700">= new </span><span style="color: #0000BB">HttpRequestPool</span><span style="color: #007700">(<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new </span><span style="color: #0000BB">HttpRequest</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://www.google.com/'</span><span style="color: #007700">, </span><span style="color: #0000BB">HTTP_HEAD</span><span style="color: #007700">),<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new </span><span style="color: #0000BB">HttpRequest</span><span style="color: #007700">(</span><span style="color: #DD0000">'http://www.php.net/'</span><span style="color: #007700">, </span><span style="color: #0000BB">HTTP_HEAD</span><span style="color: #007700">)<br />&nbsp;&nbsp;&nbsp;&nbsp;);<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$pool</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">send</span><span style="color: #007700">();<br />&nbsp;&nbsp;&nbsp;&nbsp;foreach(</span><span style="color: #0000BB">$pool </span><span style="color: #007700">as </span><span style="color: #0000BB">$request</span><span style="color: #007700">) {<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%s is %s (%d)\n"</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$request</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getUrl</span><span style="color: #007700">(),<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$request</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponseCode</span><span style="color: #007700">() ? </span><span style="color: #DD0000">'alive' </span><span style="color: #007700">: </span><span style="color: #DD0000">'not alive'</span><span style="color: #007700">,<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$request</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponseCode</span><span style="color: #007700">()<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;);<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />} catch (</span><span style="color: #0000BB">HttpException $e</span><span style="color: #007700">) {<br />&nbsp;&nbsp;&nbsp;&nbsp;echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span><br />
435 </span><br />
436 </code></blockquote><br />
437 <br />
438 </pre></p>
439 <h3 id="HttpRequestPool___destruct">void HttpRequestPool::__destruct()</h3>
440 <p>Clean up HttpRequestPool object.</p>
441 <h3 id="HttpRequestPool_reset">void HttpRequestPool::reset()</h3>
442 <p>Detach all attached HttpRequest objects.</p>
443 <h3 id="HttpRequestPool_attach">bool HttpRequestPool::attach(HttpRequest request)</h3>
444 <p>Attach an HttpRequest object to this HttpRequestPool.<br />
445 NOTE: set all options prior attaching!</p>
446 <h3 id="HttpRequestPool_detach">bool HttpRequestPool::detach(HttpRequest request)</h3>
447 <p>Detach an HttpRequest object from this HttpRequestPool.</p>
448 <h3 id="HttpRequestPool_send">bool HttpRequestPool::send()</h3>
449 <p>Send all attached HttpRequest objects in parallel.</p>
450 <h3 id="HttpRequestPool_socketSend">protected bool HttpRequestPool::socketSend()</h3>
451 <p>Usage:</p><pre><blockquote><code><span style="color: #000000"><br />
452 <span style="color: #0000BB">&lt;?php<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #007700">while (</span><span style="color: #0000BB">$pool</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">socketSend</span><span style="color: #007700">()) {<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">do_something_else</span><span style="color: #007700">();<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (!</span><span style="color: #0000BB">$pool</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">socketSelect</span><span style="color: #007700">()) {<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;die(</span><span style="color: #DD0000">'Socket error'</span><span style="color: #007700">);<br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;}<br />&nbsp;&nbsp;&nbsp;&nbsp;</span><span style="color: #0000BB">$pool</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">socketRead</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span><br />
453 </span><br />
454 </code></blockquote><br />
455 <br />
456 </pre></p>
457 <h3 id="HttpRequestPool_socketSelect">protected bool HttpRequestPool::socketSelect()</h3>
458 <p>See HttpRequestPool::socketSend().</p>
459 <h3 id="HttpRequestPool_socketRead">protected void HttpRequestPool::socketRead()</h3>
460 <p>See HttpRequestPool::socketSend().</p>
461 <h3 id="HttpRequestPool_valid">bool HttpRequestPool::valid()</h3>
462 <p>Implements Iterator::valid().</p>
463 <h3 id="HttpRequestPool_current">HttpRequest HttpRequestPool::current()</h3>
464 <p>Implements Iterator::current().</p>
465 <h3 id="HttpRequestPool_key">long HttpRequestPool::key()</h3>
466 <p>Implements Iterator::key().</p>
467 <h3 id="HttpRequestPool_next">void HttpRequestPool::next()</h3>
468 <p>Implements Iterator::next().</p>
469 <h3 id="HttpRequestPool_rewind">void HttpRequestPool::rewind()</h3>
470 <p>Implements Iterator::rewind().</p>
471 <hr noshade>
472 <h1>http_response_object.c</h1>
473 <h3 id="HttpResponse_setCache">static bool HttpResponse::setCache(bool cache)</h3>
474 <p>Whether it sould be attempted to cache the entitity.<br />
475 This will result in necessary caching headers and checks of clients<br />
476 "If-Modified-Since" and "If-None-Match" headers. If one of those headers<br />
477 matches a "304 Not Modified" status code will be issued.<br />
478 <br />
479 NOTE: If you're using sessions, be shure that you set session.cache_limiter<br />
480 to something more appropriate than "no-cache"!</p>
481 <h3 id="HttpResponse_getCache">static bool HttpResponse::getCache()</h3>
482 <p>Get current caching setting.</p>
483 <h3 id="HttpResponse_setGzip">static bool HttpResponse::setGzip(bool gzip)</h3>
484 <p>Enable on-thy-fly gzipping of the sent entity. NOT IMPLEMENTED YET.</p>
485 <h3 id="HttpResponse_getGzip">static bool HttpResponse::getGzip()</h3>
486 <p>Get current gzipping setting.</p>
487 <h3 id="HttpResponse_setCacheControl">static bool HttpResponse::setCacheControl(string control[, long max_age = 0])</h3>
488 <p>Set a custom cache-control header, usually being "private" or "public";<br />
489 The max_age parameter controls how long the cache entry is valid on the client side.</p>
490 <h3 id="HttpResponse_getCacheControl">static string HttpResponse::getCacheControl()</h3>
491 <p>Get current Cache-Control header setting.</p>
492 <h3 id="HttpResponse_setContentType">static bool HttpResponse::setContentType(string content_type)</h3>
493 <p>Set the content-type of the sent entity.</p>
494 <h3 id="HttpResponse_getContentType">static string HttpResponse::getContentType()</h3>
495 <p>Get current Content-Type header setting.</p>
496 <h3 id="HttpResponse_setContentDisposition">static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])</h3>
497 <p>Set the Content-Disposition of the sent entity. This setting aims to suggest<br />
498 the receiveing user agent how to handle the sent entity; usually the client<br />
499 will show the user a "Save As..." popup.</p>
500 <h3 id="HttpResponse_getContentDisposition">static string HttpResponse::getContentDisposition()</h3>
501 <p>Get current Content-Disposition setting.</p>
502 <h3 id="HttpResponse_setETag">static bool HttpResponse::setETag(string etag)</h3>
503 <p>Set a custom ETag. Use this only if you know what you're doing.</p>
504 <h3 id="HttpResponse_getETag">static string HttpResponse::getETag()</h3>
505 <p>Get the previously set custom ETag.</p>
506 <h3 id="HttpResponse_setThrottleDelay">static void HttpResponse::setThrottleDelay(double seconds)</h3>
507 <p></p>
508 <h3 id="HttpResponse_getThrottleDelay">static double HttpResponse::getThrottleDelay()</h3>
509 <p></p>
510 <h3 id="HttpResponse_setBufferSize">static void HttpResponse::setBufferSize(long bytes)</h3>
511 <p></p>
512 <h3 id="HttpResponse_getBufferSize">static long HttpResponse::getBufferSize()</h3>
513 <p></p>
514 <h3 id="HttpResponse_setData">static bool HttpResponse::setData(string data)</h3>
515 <p>Set the data to be sent.</p>
516 <h3 id="HttpResponse_getData">static string HttpResponse::getData()</h3>
517 <p>Get the previously set data to be sent.</p>
518 <h3 id="HttpResponse_setStream">static bool HttpResponse::setStream(resource stream)</h3>
519 <p>Set the resource to be sent.</p>
520 <h3 id="HttpResponse_getStream">static resource HttpResponse::getStream()</h3>
521 <p>Get the previously set resource to be sent.</p>
522 <h3 id="HttpResponse_setFile">static bool HttpResponse::setFile(string file)</h3>
523 <p>Set the file to be sent.</p>
524 <h3 id="HttpResponse_getFile">static string HttpResponse::getFile()</h3>
525 <p>Get the previously set file to be sent.</p>
526 <h3 id="HttpResponse_send">static bool HttpResponse::send([bool clean_ob = true])</h3>
527 <p>Finally send the entity.<br />
528 <br />
529 Example:</p><pre><blockquote><code><span style="color: #000000"><br />
530 <span style="color: #0000BB">&lt;?php<br />HttpResponse</span><span style="color: #007700">::</span><span style="color: #0000BB">setCache</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">HttpResponse</span><span style="color: #007700">::</span><span style="color: #0000BB">setContentType</span><span style="color: #007700">(</span><span style="color: #DD0000">'application/pdf'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">HttpResponse</span><span style="color: #007700">::</span><span style="color: #0000BB">setContentDisposition</span><span style="color: #007700">(</span><span style="color: #DD0000">"$user.pdf"</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">HttpResponse</span><span style="color: #007700">::</span><span style="color: #0000BB">setFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'sheet.pdf'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">HttpResponse</span><span style="color: #007700">::</span><span style="color: #0000BB">send</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">?&gt;</span><br />
531 </span><br />
532 </code></blockquote><br />
533 <br />
534 </pre></p>
535 <h3 id="HttpResponse_capture">static void HttpResponse::capture()</h3>
536 <p>Capture script output.<br />
537 <br />
538 Example:</p><pre><blockquote><code><span style="color: #000000"><br />
539 <span style="color: #0000BB">&lt;?php<br />HttpResponse</span><span style="color: #007700">::</span><span style="color: #0000BB">setCache</span><span style="color: #007700">(</span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">HttpResponse</span><span style="color: #007700">::</span><span style="color: #0000BB">capture</span><span style="color: #007700">();<br /></span><span style="color: #FF8000">// script follows<br /></span><span style="color: #0000BB">?&gt;</span><br />
540 </span><br />
541 </code></blockquote><br />
542 <br />
543 </pre></p>
544 <hr noshade>
545 <p><b>Generated at: Mon, 01 Aug 2005 09:46:36 +0200</b></p>
546 </body>
547 </html>
548