font-size: 80%;
font-family: sans-serif;
}
- h2 {
+ h2, h3 {
color: #339;
clear: both;
font-size: 1.2em;
background: #ffc;
padding: .2em;
}
+ h2.o {
+ color: #66b;
+ clear: both;
+ font-size: 1.3em;
+ background: #f0f0f0;
+ padding: .2em;
+ }
p {
margin-left: 1em;
}
width: auto;
float: left;
}
+ p, pre {
+ clear: both;
+ }
p br, pre code br {
display: block;
}
<h2 id="http_date">string http_date([int timestamp])</h2>
<p>This function returns a valid HTTP date regarding RFC 822/1123<br />
looking like: "Wed, 22 Dec 2004 11:34:47 GMT"</p>
-<h2 id="http_absolute_uri">string http_absolute_uri(string url[, string proto])</h2>
+<h2 id="http_absolute_uri">string http_absolute_uri(string url[, string proto[, string host[, int port]]])</h2>
<p>This function returns an absolute URI constructed from url.<br />
If the url is already abolute but a different proto was supplied,<br />
only the proto part of the URI will be updated. If url has no<br />
The supported parameter is expected to be an array having<br />
the supported languages as array values.<br />
<br />
-Example:</p><pre><blockquote><code><font color="#000000"><br />
-<font color="#0000BB"><?php<br />$langs </font><font color="#007700">= array(<br /> </font><font color="#DD0000">'en-US'</font><font color="#007700">,</font><font color="#FF8000">// default<br /> </font><font color="#DD0000">'fr'</font><font color="#007700">,<br /> </font><font color="#DD0000">'fr-FR'</font><font color="#007700">,<br /> </font><font color="#DD0000">'de'</font><font color="#007700">,<br /> </font><font color="#DD0000">'de-DE'</font><font color="#007700">,<br /> </font><font color="#DD0000">'de-AT'</font><font color="#007700">,<br /> </font><font color="#DD0000">'de-CH'</font><font color="#007700">,<br />);<br />include </font><font color="#DD0000">'./langs/'</font><font color="#007700">. </font><font color="#0000BB">http_negotiate_language</font><font color="#007700">(</font><font color="#0000BB">$langs</font><font color="#007700">) .</font><font color="#DD0000">'.php'</font><font color="#007700">;<br /></font><font color="#0000BB">?></font><br />
-</font><br />
+Example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br />$langs </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'en-US'</span><span style="color: #007700">,</span><span style="color: #FF8000">// default<br /> </span><span style="color: #DD0000">'fr'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'fr-FR'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'de'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'de-DE'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'de-AT'</span><span style="color: #007700">,<br /> </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">?></span><br />
+</span><br />
</code></blockquote><br />
<br />
</pre></p>
The supported parameter is expected to be an array having<br />
the supported charsets as array values.<br />
<br />
-Example:</p><pre><blockquote><code><font color="#000000"><br />
-<font color="#0000BB"><?php<br />$charsets </font><font color="#007700">= array(<br /> </font><font color="#DD0000">'iso-8859-1'</font><font color="#007700">, </font><font color="#FF8000">// default<br /> </font><font color="#DD0000">'iso-8859-2'</font><font color="#007700">,<br /> </font><font color="#DD0000">'iso-8859-15'</font><font color="#007700">,<br /> </font><font color="#DD0000">'utf-8'<br /></font><font color="#007700">);<br /></font><font color="#0000BB">$pref </font><font color="#007700">= </font><font color="#0000BB">http_negotiate_charset</font><font color="#007700">(</font><font color="#0000BB">$charsets</font><font color="#007700">);<br />if (!</font><font color="#0000BB">strcmp</font><font color="#007700">(</font><font color="#0000BB">$pref</font><font color="#007700">, </font><font color="#DD0000">'iso-8859-1'</font><font color="#007700">)) {<br /> </font><font color="#0000BB">iconv_set_encoding</font><font color="#007700">(</font><font color="#DD0000">'internal_encoding'</font><font color="#007700">, </font><font color="#DD0000">'iso-8859-1'</font><font color="#007700">);<br /> </font><font color="#0000BB">iconv_set_encoding</font><font color="#007700">(</font><font color="#DD0000">'output_encoding'</font><font color="#007700">, </font><font color="#0000BB">$pref</font><font color="#007700">);<br /> </font><font color="#0000BB">ob_start</font><font color="#007700">(</font><font color="#DD0000">'ob_iconv_handler'</font><font color="#007700">);<br />}<br /></font><font color="#0000BB">?></font><br />
-</font><br />
+Example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br />$charsets </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'iso-8859-1'</span><span style="color: #007700">, </span><span style="color: #FF8000">// default<br /> </span><span style="color: #DD0000">'iso-8859-2'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'iso-8859-15'</span><span style="color: #007700">,<br /> </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 /> </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 /> </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 /> </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">?></span><br />
+</span><br />
</code></blockquote><br />
<br />
</pre></p>
<p>This matches the given ETag against the clients<br />
"If-Match" resp. "If-None-Match" HTTP headers.</p>
<h2 id="http_cache_last_modified">bool http_cache_last_modified([int timestamp_or_expires]])</h2>
-<p>If timestamp_or_exires is greater than 0, it is handled as timestamp<br />
+<p>If timestamp_or_expires is greater than 0, it is handled as timestamp<br />
and will be sent as date of last modification. If it is 0 or omitted,<br />
the current time will be sent as Last-Modified date. If it's negative,<br />
it is handled as expiration time in seconds, which means that if the<br />
If clients "If-None-Match" header matches the supplied/calculated<br />
ETag, the body is considered cached on the clients side and<br />
a "304 Not Modified" status code is issued.</p>
-<h2 id="ob_httpetaghandler">string ob_httpetaghandler(string data, int mode)</h2>
-<p>For use with ob_start().<br />
-Note that this has to be started as first output buffer.<br />
-WARNING: Don't use with http_send_*().</p>
+<h2 id="ob_etaghandler">string ob_etaghandler(string data, int mode)</h2>
+<p>For use with ob_start().</p>
+<h2 id="http_throttle">void http_throttle(double sec[, long bytes = 2097152])</h2>
+<p>Use with http_send() API.<br />
+<br />
+Example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?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">?></span><br />
+</span><br />
+</code></blockquote><br />
+<br />
+</pre></p>
<h2 id="http_redirect">void http_redirect([string url[, array params[, bool session,[ bool permanent]]]])</h2>
<p>Redirect to a given url.<br />
The supplied url will be expanded with http_absolute_uri(), the params array will<br />
<h2 id="http_chunked_decode">string http_chunked_decode(string encoded)</h2>
<p>This function decodes a string that was HTTP-chunked encoded.<br />
Returns false on failure.</p>
-<h2 id="http_split_response">array http_split_response(string http_response)</h2>
-<p>This function splits an HTTP response into an array with headers and the<br />
-content body. The returned array may look simliar to the following example:</p><pre><blockquote><code><font color="#000000"><br />
-<font color="#0000BB"><?php<br /></font><font color="#007700">array(<br /> </font><font color="#0000BB">0 </font><font color="#007700">=> array(<br /> </font><font color="#DD0000">'Status' </font><font color="#007700">=> </font><font color="#DD0000">'200 Ok'</font><font color="#007700">,<br /> </font><font color="#DD0000">'Content-Type' </font><font color="#007700">=> </font><font color="#DD0000">'text/plain'</font><font color="#007700">,<br /><br /> </font><font color="#DD0000">'Content-Language' </font><font color="#007700">=> </font><font color="#DD0000">'en-US'<br /> </font><font color="#007700">),<br /> </font><font color="#0000BB">1 </font><font color="#007700">=> </font><font color="#DD0000">"Hello World!"<br /></font><font color="#007700">);<br /></font><font color="#0000BB">?></font><br />
-</font><br />
+<h2 id="http_parse_message">object http_parse_message(string message)</h2>
+<p>Parses (a) http_message(s) into a simple recursive object structure:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">http_parse_message</span><span style="color: #007700">(</span><span style="color: #0000BB">http_get</span><span style="color: #007700">(</span><span style="color: #0000BB">URL</span><span style="color: #007700">, array(</span><span style="color: #DD0000">'redirect' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">)));<br /><br /></span><span style="color: #0000BB">stdClass object<br /></span><span style="color: #007700">(<br /> [</span><span style="color: #0000BB">type</span><span style="color: #007700">] => </span><span style="color: #0000BB">2<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">httpVersion</span><span style="color: #007700">] => </span><span style="color: #0000BB">1.1<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">responseCode</span><span style="color: #007700">] => </span><span style="color: #0000BB">200<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">headers</span><span style="color: #007700">] => Array <br /> (<br /> [</span><span style="color: #0000BB">Content</span><span style="color: #007700">-</span><span style="color: #0000BB">Length</span><span style="color: #007700">] => </span><span style="color: #0000BB">3<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">Server</span><span style="color: #007700">] => </span><span style="color: #0000BB">Apache<br /> </span><span style="color: #007700">)<br /> [</span><span style="color: #0000BB">body</span><span style="color: #007700">] => </span><span style="color: #0000BB">Hi</span><span style="color: #007700">!<br /> [</span><span style="color: #0000BB">parentMessage</span><span style="color: #007700">] => </span><span style="color: #0000BB">stdClass object<br /> </span><span style="color: #007700">(<br /> [</span><span style="color: #0000BB">type</span><span style="color: #007700">] => </span><span style="color: #0000BB">2<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">httpVersion</span><span style="color: #007700">] => </span><span style="color: #0000BB">1.1<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">responseCode</span><span style="color: #007700">] => </span><span style="color: #0000BB">302<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">headers</span><span style="color: #007700">] => Array <br /> (<br /> [</span><span style="color: #0000BB">Content</span><span style="color: #007700">-</span><span style="color: #0000BB">Length</span><span style="color: #007700">] => </span><span style="color: #0000BB">0<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">Location</span><span style="color: #007700">] => ...<br /> )<br /> [</span><span style="color: #0000BB">body</span><span style="color: #007700">] => <br /> [</span><span style="color: #0000BB">parentMessage</span><span style="color: #007700">] => ...<br /> )<br />)<br /></span><span style="color: #0000BB">?></span><br />
+</span><br />
</code></blockquote><br />
<br />
</pre></p>
<h2 id="http_parse_headers">array http_parse_headers(string header)</h2>
<p></p>
<h2 id="http_get_request_headers">array http_get_request_headers(void)</h2>
-<p></p>
+<p>Get a list of incoming HTTP headers.</p>
+<h2 id="http_get_request_body">string http_get_request_body(void)</h2>
+<p>Get the raw request body (e.g. POST or PUT data).</p>
+<h2 id="http_match_request_header">bool http_match_request_header(string header, string value[, bool match_case = false])</h2>
+<p>Match an incoming HTTP header.</p>
<h2 id="http_get">string http_get(string url[, array options[, array &info]])</h2>
<p>Performs an HTTP GET request on the supplied url.<br />
<br />
has no effect, if the size of the requested entity is not known<br />
- lastmodified: int, timestamp for If-(Un)Modified-Since header<br />
- timeout: int, seconds the request may take<br />
- - connecttimeout: int, seconds the connect may take</pre><p>The optional third parameter will be filled with some additional information<br />
-in form af an associative array, if supplied, like the following example:</p><pre><blockquote><code><font color="#000000"><br />
-<font color="#0000BB"><?php<br /></font><font color="#007700">array (<br /> </font><font color="#DD0000">'effective_url' </font><font color="#007700">=> </font><font color="#DD0000">'http://localhost'</font><font color="#007700">,<br /> </font><font color="#DD0000">'response_code' </font><font color="#007700">=> </font><font color="#0000BB">403</font><font color="#007700">,<br /> </font><font color="#DD0000">'total_time' </font><font color="#007700">=> </font><font color="#0000BB">0.017</font><font color="#007700">,<br /> </font><font color="#DD0000">'namelookup_time' </font><font color="#007700">=> </font><font color="#0000BB">0.013</font><font color="#007700">,<br /> </font><font color="#DD0000">'connect_time' </font><font color="#007700">=> </font><font color="#0000BB">0.014</font><font color="#007700">,<br /> </font><font color="#DD0000">'pretransfer_time' </font><font color="#007700">=> </font><font color="#0000BB">0.014</font><font color="#007700">,<br /> </font><font color="#DD0000">'size_upload' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'size_download' </font><font color="#007700">=> </font><font color="#0000BB">202</font><font color="#007700">,<br /> </font><font color="#DD0000">'speed_download' </font><font color="#007700">=> </font><font color="#0000BB">11882</font><font color="#007700">,<br /> </font><font color="#DD0000">'speed_upload' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'header_size' </font><font color="#007700">=> </font><font color="#0000BB">145</font><font color="#007700">,<br /> </font><font color="#DD0000">'request_size' </font><font color="#007700">=> </font><font color="#0000BB">62</font><font color="#007700">,<br /> </font><font color="#DD0000">'ssl_verifyresult' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'filetime' </font><font color="#007700">=> -</font><font color="#0000BB">1</font><font color="#007700">,<br /> </font><font color="#DD0000">'content_length_download' </font><font color="#007700">=> </font><font color="#0000BB">202</font><font color="#007700">,<br /> </font><font color="#DD0000">'content_length_upload' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'starttransfer_time' </font><font color="#007700">=> </font><font color="#0000BB">0.017</font><font color="#007700">,<br /> </font><font color="#DD0000">'content_type' </font><font color="#007700">=> </font><font color="#DD0000">'text/html; charset=iso-8859-1'</font><font color="#007700">,<br /> </font><font color="#DD0000">'redirect_time' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'redirect_count' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'private' </font><font color="#007700">=> </font><font color="#DD0000">''</font><font color="#007700">,<br /> </font><font color="#DD0000">'http_connectcode' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'httpauth_avail' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br /> </font><font color="#DD0000">'proxyauth_avail' </font><font color="#007700">=> </font><font color="#0000BB">0</font><font color="#007700">,<br />)<br /></font><font color="#0000BB">?></font><br />
-</font><br />
+ - connecttimeout: int, seconds the connect may take<br />
+ - onprogress: mixed, progress callback</pre><p>The optional third parameter will be filled with some additional information<br />
+in form af an associative array, if supplied, like the following example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">array (<br /> </span><span style="color: #DD0000">'effective_url' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'http://localhost'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'response_code' </span><span style="color: #007700">=> </span><span style="color: #0000BB">403</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'total_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.017</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'namelookup_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.013</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'connect_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.014</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'pretransfer_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.014</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'size_upload' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'size_download' </span><span style="color: #007700">=> </span><span style="color: #0000BB">202</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'speed_download' </span><span style="color: #007700">=> </span><span style="color: #0000BB">11882</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'speed_upload' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'header_size' </span><span style="color: #007700">=> </span><span style="color: #0000BB">145</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'request_size' </span><span style="color: #007700">=> </span><span style="color: #0000BB">62</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'ssl_verifyresult' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'filetime' </span><span style="color: #007700">=> -</span><span style="color: #0000BB">1</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'content_length_download' </span><span style="color: #007700">=> </span><span style="color: #0000BB">202</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'content_length_upload' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'starttransfer_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.017</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'content_type' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'text/html; charset=iso-8859-1'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'redirect_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'redirect_count' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'http_connectcode' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'httpauth_avail' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'proxyauth_avail' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br />)<br /></span><span style="color: #0000BB">?></span><br />
+</span><br />
</code></blockquote><br />
<br />
</pre></p>
<p>Performs an HTTP HEAD request on the suppied url.<br />
Returns the HTTP response as string.<br />
See http_get() for a full list of available options.</p>
-<h2 id="http_post_data">string http_post_data(string url, string data[, array options[, &info]])</h2>
+<h2 id="http_post_data">string http_post_data(string url, string data[, array options[, array &info]])</h2>
<p>Performs an HTTP POST request, posting data.<br />
Returns the HTTP response as string.<br />
See http_get() for a full list of available options.</p>
-<h2 id="http_post_array">string http_post_array(string url, array data[, array options[, array &info]])</h2>
+<h2 id="http_post_fields">string http_post_fields(string url, array data[, array files[, array options[, array &info]]])</h2>
<p>Performs an HTTP POST request, posting www-form-urlencoded array data.<br />
Returns the HTTP response as string.<br />
See http_get() for a full list of available options.</p>
-<h2 id="http_auth_basic">bool http_auth_basic(string user, string pass[, string realm = "Restricted"])</h2>
-<p>Example:</p><pre><blockquote><code><font color="#000000"><br />
-<font color="#0000BB"><?php<br /></font><font color="#007700">if (!</font><font color="#0000BB">http_auth_basic</font><font color="#007700">(</font><font color="#DD0000">'mike'</font><font color="#007700">, </font><font color="#DD0000">'s3c|r3t'</font><font color="#007700">)) {<br /> die(</font><font color="#DD0000">'<h1>Authorization failed!</h1>'</font><font color="#007700">);<br />}<br /></font><font color="#0000BB">?></font><br />
-</font><br />
+<h2 id="http_put_file">string http_put_file(string url, string file[, array options[, array &info]])</h2>
+<p>Performs an HTTP PUT request, uploading file.<br />
+Returns the HTTP response as string.<br />
+See http_get() for a full list of available options.</p>
+<h2 id="http_put_stream">string http_put_stream(string url, resource stream[, array options[, array &info]])</h2>
+<p>Performs an HTTP PUT request, uploading stream.<br />
+Returns the HTTP response as string.<br />
+See http_get() for a full list of available options.</p>
+<h2 id="http_request_method_register">long http_request_method_register(string method)</h2>
+<p>Register a custom request method.</p>
+<h2 id="http_request_method_unregister">bool http_request_method_unregister(mixed method)</h2>
+<p>Unregister a previously registered custom request method.</p>
+<h2 id="http_request_method_exists">long http_request_method_exists(mixed method)</h2>
+<p>Check if a request method is registered (or available by default).</p>
+<h2 id="http_request_method_name">string http_request_method_name(long method)</h2>
+<p>Get the literal string representation of a standard or registered request method.</p>
+<h2 id="http_build_query">string http_build_query(mixed formdata [, string prefix[, string arg_separator]])</h2>
+<p>Generates a form-encoded query string from an associative array or object.</p>
+<hr noshade>
+<h1>http_message_object.c</h1>
+<h2 id="HttpMessage" class="o">HttpMessage</h2>
+<h3 id="HttpMessage___construct">void HttpMessage::__construct([string message])</h3>
+<p>Instantiate a new HttpMessage object.</p>
+<h3 id="HttpMessage_fromString">static HttpMessage HttpMessage::fromString(string raw_message)</h3>
+<p>Create an HttpMessage object from a string.</p>
+<h3 id="HttpMessage_getBody">string HttpMessage::getBody()</h3>
+<p>Get the body of the parsed Message.</p>
+<h3 id="HttpMessage_getHeaders">array HttpMessage::getHeaders()</h3>
+<p>Get Message Headers.</p>
+<h3 id="HttpMessage_setHeaders">void HttpMessage::setHeaders(array headers)</h3>
+<p>Sets new headers.</p>
+<h3 id="HttpMessage_addHeaders">void HttpMessage::addHeaders(array headers[, bool append = false])</h3>
+<p>Add headers. If append is true, headers with the same name will be separated, else overwritten.</p>
+<h3 id="HttpMessage_getType">long HttpMessage::getType()</h3>
+<p>Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)</p>
+<h3 id="HttpMessage_setType">void HttpMessage::setType(long type)</h3>
+<p>Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)</p>
+<h3 id="HttpMessage_getResponseCode">long HttpMessage::getResponseCode()</h3>
+<p>Get the Response Code of the Message.</p>
+<h3 id="HttpMessage_setResponseCode">bool HttpMessage::setResponseCode(long code)</h3>
+<p>Set the response code of an HTTP Response Message.<br />
+Returns false if the Message is not of type HTTP_MSG_RESPONSE,<br />
+or if the response code is out of range (100-510).</p>
+<h3 id="HttpMessage_getRequestMethod">string HttpMessage::getRequestMethod()</h3>
+<p>Get the Request Method of the Message.<br />
+Returns false if the Message is not of type HTTP_MSG_REQUEST.</p>
+<h3 id="HttpMessage_setRequestMethod">bool HttpMessage::setRequestMethod(string method)</h3>
+<p>Set the Request Method of the HTTP Message.<br />
+Returns false if the Message is not of type HTTP_MSG_REQUEST.</p>
+<h3 id="HttpMessage_getRequestUri">string HttpMessage::getRequestUri()</h3>
+<p>Get the Request URI of the Message.</p>
+<h3 id="HttpMessage_setRequestUri">bool HttpMessage::setRequestUri(string URI)</h3>
+<p>Set the Request URI of the HTTP Message.<br />
+Returns false if the Message is not of type HTTP_MSG_REQUEST,<br />
+or if paramtere URI was empty.</p>
+<h3 id="HttpMessage_getHttpVersion">string HttpMessage::getHttpVersion()</h3>
+<p>Get the HTTP Protocol Version of the Message.</p>
+<h3 id="HttpMessage_setHttpVersion">bool HttpMessage::setHttpVersion(string version)</h3>
+<p>Set the HTTP Protocol version of the Message.<br />
+Returns false if version is invalid (1.0 and 1.1).</p>
+<h3 id="HttpMessage_getParentMessage">HttpMessage HttpMessage::getParentMessage()</h3>
+<p>Get parent Message.</p>
+<h3 id="HttpMessage_send">bool HttpMessage::send()</h3>
+<p>Send the Message according to its type as Response or Request.</p>
+<h3 id="HttpMessage_toString">string HttpMessage::toString([bool include_parent = true])</h3>
+<p>Get the string representation of the Message.</p>
+<hr noshade>
+<h1>http_request_object.c</h1>
+<h2 id="HttpRequest" class="o">HttpRequest</h2>
+<h3 id="HttpRequest___construct">void HttpRequest::__construct([string url[, long request_method = HTTP_GET]])</h3>
+<p>Instantiate a new HttpRequest object which can be used to issue HEAD, GET<br />
+and POST (including posting files) HTTP requests.</p>
+<h3 id="HttpRequest___destruct">void HttpRequest::__destruct()</h3>
+<p>Destroys the HttpRequest object.</p>
+<h3 id="HttpRequest_setOptions">bool HttpRequest::setOptions([array options])</h3>
+<p>Set the request options to use. See http_get() for a full list of available options.</p>
+<h3 id="HttpRequest_getOptions">array HttpRequest::getOptions()</h3>
+<p>Get currently set options.</p>
+<h3 id="HttpRequest_setSslOptions">bool HttpRequest::setSslOptions([array options])</h3>
+<p>Set SSL options.</p>
+<h3 id="HttpRequest_addSslOptions">bool HttpRequest::addSslOptions(array options)</h3>
+<p>Set additional SSL options.</p>
+<h3 id="HttpRequest_getSslOptions">array HttpRequest::getSslOtpions()</h3>
+<p>Get previously set SSL options.</p>
+<h3 id="HttpRequest_addHeaders">bool HttpRequest::addHeaders(array headers)</h3>
+<p>Add request header name/value pairs.</p>
+<h3 id="HttpRequest_setHeaders">bool HttpRequest::setHeaders([array headers])</h3>
+<p>Set request header name/value pairs.</p>
+<h3 id="HttpRequest_getHeaders">array HttpRequest::getHeaders()</h3>
+<p>Get previously set request headers.</p>
+<h3 id="HttpRequest_setCookies">bool HttpRequest::setCookies([array cookies])</h3>
+<p>Set cookies.</p>
+<h3 id="HttpRequest_addCookies">bool HttpRequest::addCookies(array cookies)</h3>
+<p>Add cookies.</p>
+<h3 id="HttpRequest_getCookies">array HttpRequest::getCookies()</h3>
+<p>Get previously set cookies.</p>
+<h3 id="HttpRequest_setUrl">bool HttpRequest::setUrl(string url)</h3>
+<p>Set the request URL.</p>
+<h3 id="HttpRequest_getUrl">string HttpRequest::getUrl()</h3>
+<p>Get the previously set request URL.</p>
+<h3 id="HttpRequest_setMethod">bool HttpRequest::setMethod(long request_method)</h3>
+<p>Set the request methods; one of the <tt>HTTP_HEAD</tt>, <tt>HTTP_GET</tt> or<br />
+<tt>HTTP_POST</tt> constants.</p>
+<h3 id="HttpRequest_getMethod">long HttpRequest::getMethod()</h3>
+<p>Get the previously set request method.</p>
+<h3 id="HttpRequest_setContentType">bool HttpRequest::setContentType(string content_type)</h3>
+<p>Set the content type the post request should have.<br />
+Use this only if you know what you're doing.</p>
+<h3 id="HttpRequest_getContentType">string HttpRequest::getContentType()</h3>
+<p>Get the previously content type.</p>
+<h3 id="HttpRequest_setQueryData">bool HttpRequest::setQueryData([mixed query_data])</h3>
+<p>Set the URL query parameters to use.<br />
+Overwrites previously set query parameters.<br />
+Affects any request types.</p>
+<h3 id="HttpRequest_getQueryData">string HttpRequest::getQueryData()</h3>
+<p>Get the current query data in form of an urlencoded query string.</p>
+<h3 id="HttpRequest_addQueryData">bool HttpRequest::addQueryData(array query_params)</h3>
+<p>Add parameters to the query parameter list.<br />
+Affects any request type.</p>
+<h3 id="HttpRequest_addPostFields">bool HttpRequest::addPostFields(array post_data)</h3>
+<p>Adds POST data entries.<br />
+Affects only POST requests.</p>
+<h3 id="HttpRequest_setPostFields">bool HttpRequest::setPostFields([array post_data])</h3>
+<p>Set the POST data entries.<br />
+Overwrites previously set POST data.<br />
+Affects only POST requests.</p>
+<h3 id="HttpRequest_getPostFields">array HttpRequest::getPostFields()</h3>
+<p>Get previously set POST data.</p>
+<h3 id="HttpRequest_addPostFile">bool HttpRequest::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])</h3>
+<p>Add a file to the POST request.<br />
+Affects only POST requests.</p>
+<h3 id="HttpRequest_setPostFiles">bool HttpRequest::setPostFiles([array post_files])</h3>
+<p>Set files to post.<br />
+Overwrites previously set post files.<br />
+Affects only POST requests.</p>
+<h3 id="HttpRequest_getPostFiles">array HttpRequest::getPostFiles()</h3>
+<p>Get all previously added POST files.</p>
+<h3 id="HttpRequest_setPutFile">bool HttpRequest::setPutFile([string file])</h3>
+<p>Set file to put.<br />
+Affects only PUT requests.</p>
+<h3 id="HttpRequest_getPutFile">string HttpRequest::getPutFile()</h3>
+<p>Get previously set put file.</p>
+<h3 id="HttpRequest_getResponseData">array HttpRequest::getResponseData()</h3>
+<p>Get all response data after the request has been sent.</p>
+<h3 id="HttpRequest_getResponseHeader">mixed HttpRequest::getResponseHeader([string name])</h3>
+<p>Get response header(s) after the request has been sent.</p>
+<h3 id="HttpRequest_getResponseCookie">array HttpRequest::getResponseCookie([string name])</h3>
+<p>Get response cookie(s) after the request has been sent.</p>
+<h3 id="HttpRequest_getResponseBody">string HttpRequest::getResponseBody()</h3>
+<p>Get the response body after the request has been sent.</p>
+<h3 id="HttpRequest_getResponseCode">int HttpRequest::getResponseCode()</h3>
+<p>Get the response code after the request has been sent.</p>
+<h3 id="HttpRequest_getResponseInfo">array HttpRequest::getResponseInfo([string name])</h3>
+<p>Get response info after the request has been sent.<br />
+See http_get() for a full list of returned info.</p>
+<h3 id="HttpRequest_getResponseMessage">HttpMessage HttpRequest::getResponseMessage()</h3>
+<p>Get the full response as HttpMessage object.</p>
+<h3 id="HttpRequest_getRequestMessage">HttpMessage HttpRequest::getRequestMessage()</h3>
+<p>Get sent HTTP message.</p>
+<h3 id="HttpRequest_send">HttpMessage HttpRequest::send()</h3>
+<p>Send the HTTP request.<br />
+<br />
+GET example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?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">-></span><span style="color: #0000BB">setOptions</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'lastmodified' </span><span style="color: #007700">=> </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">-></span><span style="color: #0000BB">addQueryData</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'category' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">));<br />try {<br /> </span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">();<br /> if (</span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">getResponseCode</span><span style="color: #007700">() == </span><span style="color: #0000BB">200</span><span style="color: #007700">) {<br /> </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">-></span><span style="color: #0000BB">getResponseBody</span><span style="color: #007700">());<br /> }<br />} catch (</span><span style="color: #0000BB">HttpException $ex</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$ex</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span><br />
+</span><br />
+</code></blockquote></pre><p>POST example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?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">-></span><span style="color: #0000BB">setOptions</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'cookies' </span><span style="color: #007700">=> array(</span><span style="color: #DD0000">'lang' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'de'</span><span style="color: #007700">)));<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">addPostFields</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'user' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'mike'</span><span style="color: #007700">, </span><span style="color: #DD0000">'pass' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'s3c|r3t'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">$r</span><span style="color: #007700">-></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 />try {<br /> echo </span><span style="color: #0000BB">$r</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">()-></span><span style="color: #0000BB">getBody</span><span style="color: #007700">();<br />} catch (</span><span style="color: #0000BB">HttpException $ex</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$ex</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span><br />
+</span><br />
</code></blockquote><br />
<br />
</pre></p>
-<h2 id="http_auth_basic_cb">bool http_auth_basic_cb(mixed callback[, string realm = "Restricted"])</h2>
-<p>Example:</p><pre><blockquote><code><font color="#000000"><br />
-<font color="#0000BB"><?php<br /></font><font color="#007700">function </font><font color="#0000BB">auth_cb</font><font color="#007700">(</font><font color="#0000BB">$user</font><font color="#007700">, </font><font color="#0000BB">$pass</font><font color="#007700">)<br />{<br /> global </font><font color="#0000BB">$db</font><font color="#007700">;<br /> </font><font color="#0000BB">$query </font><font color="#007700">= </font><font color="#DD0000">'SELECT pass FROM users WHERE user='</font><font color="#007700">. </font><font color="#0000BB">$db</font><font color="#007700">-></font><font color="#0000BB">quoteSmart</font><font color="#007700">(</font><font color="#0000BB">$user</font><font color="#007700">);<br /> if (</font><font color="#0000BB">strlen</font><font color="#007700">(</font><font color="#0000BB">$realpass </font><font color="#007700">= </font><font color="#0000BB">$db</font><font color="#007700">-></font><font color="#0000BB">getOne</font><font color="#007700">(</font><font color="#0000BB">$query</font><font color="#007700">)) {<br /> return </font><font color="#0000BB">$pass </font><font color="#007700">=== </font><font color="#0000BB">$realpass</font><font color="#007700">;<br /> }<br /> return </font><font color="#0000BB">false</font><font color="#007700">;<br />}<br />if (!</font><font color="#0000BB">http_auth_basic_cb</font><font color="#007700">(</font><font color="#DD0000">'auth_cb'</font><font color="#007700">)) {<br /> die(</font><font color="#DD0000">'<h1>Authorization failed</h1>'</font><font color="#007700">);<br />}<br /></font><font color="#0000BB">?></font><br />
-</font><br />
+<hr noshade>
+<h1>http_requestpool_object.c</h1>
+<h2 id="HttpRequestPool" class="o">HttpRequestPool</h2>
+<h3 id="HttpRequestPool___construct">void HttpRequestPool::__construct([HttpRequest request[, ...]])</h3>
+<p>Instantiate a new HttpRequestPool object. An HttpRequestPool is<br />
+able to send several HttpRequests in parallel.<br />
+<br />
+Example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">try {<br /> </span><span style="color: #0000BB">$pool </span><span style="color: #007700">= new </span><span style="color: #0000BB">HttpRequestPool</span><span style="color: #007700">(<br /> 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 /> 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 /> );<br /> </span><span style="color: #0000BB">$pool</span><span style="color: #007700">-></span><span style="color: #0000BB">send</span><span style="color: #007700">();<br /> 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 /> </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 /> </span><span style="color: #0000BB">$request</span><span style="color: #007700">-></span><span style="color: #0000BB">getUrl</span><span style="color: #007700">(),<br /> </span><span style="color: #0000BB">$request</span><span style="color: #007700">-></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 /> </span><span style="color: #0000BB">$request</span><span style="color: #007700">-></span><span style="color: #0000BB">getResponseCode</span><span style="color: #007700">()<br /> );<br /> }<br />} catch (</span><span style="color: #0000BB">HttpException $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span><br />
+</span><br />
</code></blockquote><br />
<br />
</pre></p>
-<h2 id="http_build_query">string http_build_query(mixed formdata [, string prefix])</h2>
-<p>Generates a form-encoded query string from an associative array or object.</p>
+<h3 id="HttpRequestPool___destruct">void HttpRequestPool::__destruct()</h3>
+<p>Clean up HttpRequestPool object.</p>
+<h3 id="HttpRequestPool_reset">void HttpRequestPool::reset()</h3>
+<p>Detach all attached HttpRequest objects.</p>
+<h3 id="HttpRequestPool_attach">bool HttpRequestPool::attach(HttpRequest request)</h3>
+<p>Attach an HttpRequest object to this HttpRequestPool.<br />
+NOTE: set all options prior attaching!</p>
+<h3 id="HttpRequestPool_detach">bool HttpRequestPool::detach(HttpRequest request)</h3>
+<p>Detach an HttpRequest object from this HttpRequestPool.</p>
+<h3 id="HttpRequestPool_send">bool HttpRequestPool::send()</h3>
+<p>Send all attached HttpRequest objects in parallel.</p>
+<h3 id="HttpRequestPool_socketPerform">protected bool HttpRequestPool::socketSend()</h3>
+<p>Usage:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br /> </span><span style="color: #007700">while (</span><span style="color: #0000BB">$pool</span><span style="color: #007700">-></span><span style="color: #0000BB">socketPerform</span><span style="color: #007700">()) {<br /> </span><span style="color: #0000BB">do_something_else</span><span style="color: #007700">();<br /> if (!</span><span style="color: #0000BB">$pool</span><span style="color: #007700">-></span><span style="color: #0000BB">socketSelect</span><span style="color: #007700">()) {<br /> die(</span><span style="color: #DD0000">'Socket error'</span><span style="color: #007700">);<br /> }<br /> }<br /></span><span style="color: #0000BB">?></span><br />
+</span><br />
+</code></blockquote><br />
+<br />
+</pre></p>
+<h3 id="HttpRequestPool_socketSelect">protected bool HttpRequestPool::socketSelect()</h3>
+<p>See HttpRequestPool::socketPerform().</p>
+<h3 id="HttpRequestPool_valid">bool HttpRequestPool::valid()</h3>
+<p>Implements Iterator::valid().</p>
+<h3 id="HttpRequestPool_current">HttpRequest HttpRequestPool::current()</h3>
+<p>Implements Iterator::current().</p>
+<h3 id="HttpRequestPool_key">long HttpRequestPool::key()</h3>
+<p>Implements Iterator::key().</p>
+<h3 id="HttpRequestPool_next">void HttpRequestPool::next()</h3>
+<p>Implements Iterator::next().</p>
+<h3 id="HttpRequestPool_rewind">void HttpRequestPool::rewind()</h3>
+<p>Implements Iterator::rewind().</p>
<hr noshade>
-<h1>http_methods.c</h1>
-<h2 id="HTTPi_Response, __construct">void HTTPi_Response::__construct(bool cache, bool gzip)</h2>
-<p></p>
-<h2 id="HTTPi_Response, setCache">bool HTTPi_Response::setCache(bool cache)</h2>
-<p></p>
-<h2 id="HTTPi_Response, getCache">bool HTTPi_Response::getCache()</h2>
-<p></p>
-<h2 id="HTTPi_Response, setGzip">bool HTTPi_Response::setGzip(bool gzip)</h2>
-<p></p>
-<h2 id="HTTPi_Response, getGzip">bool HTTPi_Response::getGzip()</h2>
-<p></p>
-<h2 id="HTTPi_Response, setCacheControl">bool HTTPi_Response::setCacheControl(string control[, bool raw = false])</h2>
-<p></p>
-<h2 id="HTTPi_Response, getCacheControl">string HTTPi_Response::getCacheControl()</h2>
-<p></p>
-<h2 id="HTTPi_Response, setContentType">bool HTTPi::setContentType(string content_type)</h2>
-<p></p>
-<h2 id="HTTPi_Response, getContentType">string HTTPi_Response::getContentType()</h2>
-<p></p>
-<h2 id="HTTPi_Response, setContentDisposition">bool HTTPi_Response::setContentDisposition(string filename[, bool inline = false])</h2>
-<p></p>
-<h2 id="HTTPi_Response, getContentDisposition">array HTTPi_Response::getContentDisposition()</h2>
-<p></p>
-<h2 id="HTTPi_Response, setETag">bool HTTPi_Response::setETag(string etag)</h2>
-<p></p>
-<h2 id="HTTPi_Response, getETag">string HTTPi_Response::getETag()</h2>
-<p></p>
-<h2 id="HTTPi_Response, setData">bool HTTPi_Response::setData(string data)</h2>
-<p></p>
-<h2 id="HTTPi_Response, getData">string HTTPi_Response::getData()</h2>
+<h1>http_response_object.c</h1>
+<h3 id="HttpResponse_setHeader">static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true)</h3>
<p></p>
-<h2 id="HTTPi_Response, setStream">bool HTTPi_Response::setStream(resource stream)</h2>
-<p></p>
-<h2 id="HTTPi_Response, getStream">resource HTTPi_Response::getStream()</h2>
-<p></p>
-<h2 id="HTTPi_Response, setFile">bool HTTPi_Response::setFile(string file)</h2>
-<p></p>
-<h2 id="HTTPi_Response, getFile">string HTTPi_Response::getFile()</h2>
-<p></p>
-<h2 id="HTTPi_Request, __construct">void HTTPi_Request::__construct([string url[, long request_method = HTTP_GET]])</h2>
-<p></p>
-<h2 id="HTTPi_Request, __destruct">void HTTPi_Request::__destruct()</h2>
-<p></p>
-<h2 id="HTTPi_Request, setOptions">bool HTTPi_Request::setOptions(array options)</h2>
-<p></p>
-<h2 id="HTTPi_Request, getOptions">array HTTPi_Request::getOptions()</h2>
-<p></p>
-<h2 id="HTTPi_Request, setURL">bool HTTPi_Request::setURL(string url)</h2>
-<p></p>
-<h2 id="HTTPi_Request, getURL">string HTTPi_Request::getUrl()</h2>
-<p></p>
-<h2 id="HTTPi_Request, setMethod">bool HTTPi_Request::setMethod(long request_method)</h2>
-<p></p>
-<h2 id="HTTPi_Request, getMethod">long HTTPi_Request::getMethod()</h2>
-<p></p>
-<h2 id="HTTPi_Request, setContentType">bool HTTPi_Request::setContentType(string content_type)</h2>
-<p></p>
-<h2 id="HTTPi_Request, getContentType">string HTTPi_Request::getContentType()</h2>
-<p></p>
-<h2 id="HTTPi_Request, setQueryData">bool HTTPi_Request::setQueryData(mixed query_data)</h2>
-<p></p>
-<h2 id="HTTPi_Request, getQueryData">string HTTPi_Request::getQueryData()</h2>
-<p></p>
-<h2 id="HTTPi_Request, addQueryData">bool HTTPi_Request::addQueryData(array query_params)</h2>
-<p></p>
-<h2 id="HTTPi_Request, unsetQueryData">void HTTPi_Request::unsetQueryData()</h2>
-<p></p>
-<h2 id="HTTPi_Request, addPostData">bool HTTPi_Request::addPostData(array post_data)</h2>
-<p></p>
-<h2 id="HTTPi_Request, setPostData">bool HTTPi_Request::setPostData(array post_data)</h2>
-<p></p>
-<h2 id="HTTPi_Request, getPostData">array HTTPi_Request::getPostData()</h2>
-<p></p>
-<h2 id="HTTPi_Request, unsetPostData">void HTTPi_Request::unsetPostData()</h2>
-<p></p>
-<h2 id="HTTPi_Request, addPostFile">bool HTTPi_Request::addPostFile(string name, string file[, string content_type = "application/x-octetstream"])</h2>
-<p></p>
-<h2 id="HTTPi_Request, getPostFiles">array HTTPi_Request::getPostFiles()</h2>
-<p></p>
-<h2 id="HTTPi_Request, unsetPostFiles">void HTTPi_Request::unsetPostFiles()</h2>
-<p></p>
-<h2 id="HTTPi_Request, getResponseData">array HTTPi_Request::getResponseData()</h2>
-<p></p>
-<h2 id="HTTPi_Request, getResponseHeaders">array HTTPi_Request::getResponseHeaders()</h2>
-<p></p>
-<h2 id="HTTPi_Request, getResponseBody">string HTTPi_Request::getResponseBody()</h2>
-<p></p>
-<h2 id="HTTPi_Request, getResponseInfo">array HTTPi_Request::getResponseInfo()</h2>
-<p></p>
-<h2 id="HTTPi_Request, send">bool HTTPi_Request::send()</h2>
+<h3 id="HttpResponse_getHeader">static mixed HttpResponse::getHeader([string name])</h3>
<p></p>
+<h3 id="HttpResponse_setCache">static bool HttpResponse::setCache(bool cache)</h3>
+<p>Whether it sould be attempted to cache the entitity.<br />
+This will result in necessary caching headers and checks of clients<br />
+"If-Modified-Since" and "If-None-Match" headers. If one of those headers<br />
+matches a "304 Not Modified" status code will be issued.<br />
+<br />
+NOTE: If you're using sessions, be shure that you set session.cache_limiter<br />
+to something more appropriate than "no-cache"!</p>
+<h3 id="HttpResponse_getCache">static bool HttpResponse::getCache()</h3>
+<p>Get current caching setting.</p>
+<h3 id="HttpResponse_setGzip">static bool HttpResponse::setGzip(bool gzip)</h3>
+<p>Enable on-thy-fly gzipping of the sent entity.</p>
+<h3 id="HttpResponse_getGzip">static bool HttpResponse::getGzip()</h3>
+<p>Get current gzipping setting.</p>
+<h3 id="HttpResponse_setCacheControl">static bool HttpResponse::setCacheControl(string control[, long max_age = 0])</h3>
+<p>Set a custom cache-control header, usually being "private" or "public";<br />
+The max_age parameter controls how long the cache entry is valid on the client side.</p>
+<h3 id="HttpResponse_getCacheControl">static string HttpResponse::getCacheControl()</h3>
+<p>Get current Cache-Control header setting.</p>
+<h3 id="HttpResponse_setContentType">static bool HttpResponse::setContentType(string content_type)</h3>
+<p>Set the content-type of the sent entity.</p>
+<h3 id="HttpResponse_getContentType">static string HttpResponse::getContentType()</h3>
+<p>Get current Content-Type header setting.</p>
+<h3 id="HttpResponse_setContentDisposition">static bool HttpResponse::setContentDisposition(string filename[, bool inline = false])</h3>
+<p>Set the Content-Disposition of the sent entity. This setting aims to suggest<br />
+the receiveing user agent how to handle the sent entity; usually the client<br />
+will show the user a "Save As..." popup.</p>
+<h3 id="HttpResponse_getContentDisposition">static string HttpResponse::getContentDisposition()</h3>
+<p>Get current Content-Disposition setting.</p>
+<h3 id="HttpResponse_setETag">static bool HttpResponse::setETag(string etag)</h3>
+<p>Set a custom ETag. Use this only if you know what you're doing.</p>
+<h3 id="HttpResponse_getETag">static string HttpResponse::getETag()</h3>
+<p>Get calculated or previously set custom ETag.</p>
+<h3 id="HttpResponse_setLastModified">static bool HttpResponse::setLastModified(long timestamp)</h3>
+<p>Set a custom Last-Modified date.</p>
+<h3 id="HttpResponse_getLastModified">static HttpResponse::getLastModified()</h3>
+<p>Get calculated or previously set custom Last-Modified date.</p>
+<h3 id="HttpResponse_setThrottleDelay">static bool HttpResponse::setThrottleDelay(double seconds)</h3>
+<p></p>
+<h3 id="HttpResponse_getThrottleDelay">static double HttpResponse::getThrottleDelay()</h3>
+<p></p>
+<h3 id="HttpResponse_setBufferSize">static bool HttpResponse::setBufferSize(long bytes)</h3>
+<p></p>
+<h3 id="HttpResponse_getBufferSize">static long HttpResponse::getBufferSize()</h3>
+<p></p>
+<h3 id="HttpResponse_setData">static bool HttpResponse::setData(string data)</h3>
+<p>Set the data to be sent.</p>
+<h3 id="HttpResponse_getData">static string HttpResponse::getData()</h3>
+<p>Get the previously set data to be sent.</p>
+<h3 id="HttpResponse_setStream">static bool HttpResponse::setStream(resource stream)</h3>
+<p>Set the resource to be sent.</p>
+<h3 id="HttpResponse_getStream">static resource HttpResponse::getStream()</h3>
+<p>Get the previously set resource to be sent.</p>
+<h3 id="HttpResponse_setFile">static bool HttpResponse::setFile(string file)</h3>
+<p>Set the file to be sent.</p>
+<h3 id="HttpResponse_getFile">static string HttpResponse::getFile()</h3>
+<p>Get the previously set file to be sent.</p>
+<h3 id="HttpResponse_send">static bool HttpResponse::send([bool clean_ob = true])</h3>
+<p>Finally send the entity.<br />
+<br />
+Example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?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">?></span><br />
+</span><br />
+</code></blockquote><br />
+<br />
+</pre></p>
+<h3 id="HttpResponse_capture">static void HttpResponse::capture()</h3>
+<p>Capture script output.<br />
+<br />
+Example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?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 />// note that you need to call<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: #FF8000">// at the end of the script unless <br />// you use PHP-5.1 or greater<br /></span><span style="color: #0000BB">?></span><br />
+</span><br />
+</code></blockquote><br />
+<br />
+</pre></p>
<hr noshade>
- <p><b>Generated at: Fri, 4 Mar 2005 14:02:55 +0100</b></p>
+ <p><b>Generated at: Fri, 26 Aug 2005 11:08:03 +0000</b></p>
</body>
-</html>
\ No newline at end of file
+</html>
+
projects / m6w6 / ext-http / blobdiff