</head>
<body><h1 id="http_functions.c">http_functions.c</h1>
<h2 id="http_date">string http_date([int timestamp])</h2>
-<p>Compose a valid HTTP date regarding RFC 822/1123<br />
+<p>Compose a valid HTTP date regarding RFC 1123<br />
looking like: "Wed, 22 Dec 2004 11:34:47 GMT"</p>
<p>Accepts an optional unix timestamp as parameter.</p>
<p>Returns the HTTP date as string.</p>
-<h2 id="http_build_url">string http_build_url(mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]])</h2>
-<p>Returns the new URL as string on success or FALSE on failure.</p>
+<h2 id="http_build_url">string http_build_url([mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]]])</h2>
+<p>Build an URL.</p>
+<p>Expexts (part(s) of) an URL as first parameter in form of a string or assoziative array<br />
+like parse_url() returns. Accepts an optional second parameter in the same way as the<br />
+first argument. Accepts an optional third integer parameter, which is a bitmask of<br />
+binary or'ed HTTP_URL_* constants. The optional fourth parameter will be filled<br />
+with the results as associative array like parse_url() would return.</p>
+<p>The parts of the second URL will be merged into the first according to the flags argument.<br />
+The following flags are recognized:</p><pre> - HTTP_URL_REPLACE: (default) set parts of the second url will replace the parts in the first<br />
+ - HTTP_URL_JOIN_PATH: the path of the second url will be merged into the one of the first<br />
+ - HTTP_URL_JOIN_QUERY: the two querystrings will be merged recursively<br />
+ - HTTP_URL_STRIP_USER: the user part will not appear in the result<br />
+ - HTTP_URL_STRIP_PASS: the password part will not appear in the result<br />
+ - HTTP_URL_STRIP_AUTH: neither the user nor the password part will appear in the result<br />
+ - HTTP_URL_STRIP_PORT: no explicit port will be set in the result<br />
+ - HTTP_URL_STRIP_PATH: the path part will not appear in the result<br />
+ - HTTP_URL_STRIP_QUERY: no query string will be present in the result<br />
+ - HTTP_URL_STRIP_FRAGMENT: no fragment will be present in the result<br />
+</pre></p>
+<p>Example:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">// ftp://ftp.example.com/pub/files/current/?a=b&a=c<br /> </span><span style="color: #007700">echo </span><span style="color: #0000BB">http_build_url</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://user@www.example.com/pub/index.php?a=b#files"</span><span style="color: #007700">,<br /> array(<br /> </span><span style="color: #DD0000">"scheme" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"ftp"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"host" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"ftp.example.com"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"path" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"files/current/"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"query" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"a=c"<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">HTTP_URL_STRIP_AUTH </span><span style="color: #007700">| </span><span style="color: #0000BB">HTTP_URL_JOIN_PATH </span><span style="color: #007700">| </span><span style="color: #0000BB">HTTP_URL_JOIN_QUERY </span><span style="color: #007700">| </span><span style="color: #0000BB">HTTP_URL_STRIP_FRAGMENT<br /> </span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span><br />
+</span></code></blockquote></p>
+<p></pre><br />
+Returns the new URL as string on success or FALSE on failure.</p>
+<h2 id="http_build_str">string http_build_str(array query [, string prefix[, string arg_separator]])</h2>
+<p>Opponent to parse_str().</p>
+<p>Expects an array as first argument which represents the parts of the query string to build.<br />
+Accepts a string as optional second parameter containing a top-level prefix to use.<br />
+The optional third parameter should specify an argument separator to use (by default the<br />
+INI setting arg_separator.output will be used, or "&" if neither is set).</p>
+<p>Returns the built query as string on success or FALSE on failure.</p>
<h2 id="http_negotiate_language">string http_negotiate_language(array supported[, array &result])</h2>
<p>This function negotiates the clients preferred language based on its<br />
Accept-Language HTTP header. The qualifier is recognized and languages <br />
without qualifier are rated highest. The qualifier will be decreased by<br />
10% for partial matches (i.e. matching primary language).</p>
-<p>Expects an array as parameter cotaining the supported languages as values.<br />
+<p>Expects an array as parameter containing the supported languages as values.<br />
If the optional second parameter is supplied, it will be filled with an<br />
array containing the negotiation results.</p>
<p>Returns the negotiated language or the default language (i.e. first array entry) <br />
<p>This function negotiates the clients preferred charset based on its<br />
Accept-Charset HTTP header. The qualifier is recognized and charsets <br />
without qualifier are rated highest.</p>
-<p>Expects an array as parameter cotaining the supported charsets as values.<br />
+<p>Expects an array as parameter containing the supported charsets as values.<br />
If the optional second parameter is supplied, it will be filled with an<br />
array containing the negotiation results.</p>
<p>Returns the negotiated charset or the default charset (i.e. first array entry) <br />
<p>This function negotiates the clients preferred content type based on its<br />
Accept HTTP header. The qualifier is recognized and content types <br />
without qualifier are rated highest.</p>
-<p>Expects an array as parameter cotaining the supported content types as values.<br />
+<p>Expects an array as parameter containing the supported content types as values.<br />
If the optional second parameter is supplied, it will be filled with an<br />
array containing the negotiation results.</p>
<p>Returns the negotiated content type or the default content type <br />
<p>Send the Content-Disposition. The Content-Disposition header is very useful<br />
if the data actually sent came from a file or something similar, that should<br />
be "saved" by the client/user (i.e. by browsers "Save as..." popup window).</p>
-<p>Expects a string parameter specifying the file name the "Save as..." dialogue<br />
+<p>Expects a string parameter specifying the file name the "Save as..." dialog<br />
should display. Optionally accepts a bool parameter, which, if set to true<br />
and the user agent knows how to handle the content type, will probably not<br />
cause the popup window to be shown.</p>
<p>Expects a string parameter containing the ETag to compare. Optionally<br />
accepts a bool parameter, which, if set to true, will check the header<br />
usually used to validate HTTP ranges.</p>
-<p>Retuns TRUE if ETag matches or the header contained the asterisk ("*"),<br />
+<p>Returns TRUE if ETag matches or the header contained the asterisk ("*"),<br />
else FALSE.</p>
<h2 id="http_cache_last_modified">bool http_cache_last_modified([int timestamp_or_expires]])</h2>
<p>Attempts to cache the sent entity by its last modification date.</p>
the Last-Modified header is updated and the actual body will be sent.</p>
<p>Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.</p>
<p>A log entry will be written to the cache log if the INI entry<br />
-http.cache_log is set and the cache attempt was successful.</p>
+http.log.cache is set and the cache attempt was successful.</p>
<h2 id="http_cache_etag">bool http_cache_etag([string etag])</h2>
<p>Attempts to cache the sent entity by its ETag, either supplied or generated <br />
-by the hash algorythm specified by the INI setting "http.etag_mode".</p>
+by the hash algorithm specified by the INI setting "http.etag.mode".</p>
<p>If the 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>
<p>Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.</p>
<p>A log entry is written to the cache log if the INI entry<br />
-"http.cache_log" is set and the cache attempt was successful.</p>
+"http.log.cache" is set and the cache attempt was successful.</p>
<h2 id="ob_etaghandler">string ob_etaghandler(string data, int mode)</h2>
<p>For use with ob_start(). Output buffer handler generating an ETag with<br />
-the hash algorythm specified with the INI setting "http.etag_mode".</p>
+the hash algorithm specified with the INI setting "http.etag.mode".</p>
<h2 id="http_throttle">void http_throttle(double sec[, int bytes = 40960])</h2>
<p>Sets the throttle delay and send buffer size for use with http_send() API.<br />
Provides a basic throttling mechanism, which will yield the current process<br />
<p>Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3<br />
for which redirect response code to use in which situation.</p>
<p>To be RFC compliant, "Redirecting to <a>URL</a>." will be displayed,<br />
-if the client doesn't redirect immediatly, and the request method was<br />
+if the client doesn't redirect immediately, and the request method was<br />
another one than HEAD.</p>
<p>Returns FALSE on failure, or *exits* on success.</p>
<p>A log entry will be written to the redirect log, if the INI entry<br />
-"http.redirect_log" is set and the redirect attempt was successful.</p>
+"http.log.redirect" is set and the redirect attempt was successful.</p>
<h2 id="http_send_data">bool http_send_data(string data)</h2>
<p>Sends raw data with support for (multiple) range requests.</p>
-<p>Retursn TRUE on success, or FALSE on failure.</p>
+<p>Returns TRUE on success, or FALSE on failure.</p>
<h2 id="http_send_file">bool http_send_file(string file)</h2>
<p>Sends a file with support for (multiple) range requests.</p>
<p>Expects a string parameter referencing the file to send.</p>
<p>Returns TRUE on success, or FALSE on failure.</p>
<h2 id="http_send_stream">bool http_send_stream(resource stream)</h2>
<p>Sends an already opened stream with support for (multiple) range requests.</p>
-<p>Expects a resource parameter referncing the stream to read from.</p>
+<p>Expects a resource parameter referencing the stream to read from.</p>
<p>Returns TRUE on success, or FALSE on failure.</p>
<h2 id="http_chunked_decode">string http_chunked_decode(string encoded)</h2>
<p>Decodes a string that was HTTP-chunked encoded.</p>
<p>Parses (a) http_message(s) into a simple recursive object structure.</p>
<p>Expects a string parameter containing a single HTTP message or<br />
several consecutive HTTP messages.</p>
-<p>Returns an hierachical object structure of the parsed messages.</p>
+<p>Returns an hierarchical object structure of the parsed messages.</p>
<p>Example:</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></code></blockquote></p>
<span style="color: #0000BB"><?php<br />$headers </span><span style="color: #007700">= </span><span style="color: #DD0000">"content-type: text/html; charset=UTF-8\r\n"</span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">"Server: Funky/1.0\r\n"</span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">"Set-Cookie: foo=bar\r\n"</span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">"Set-Cookie: baz=quux\r\n"</span><span style="color: #007700">.<br /> </span><span style="color: #DD0000">"Folded: works\r\n\ttoo\r\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">http_parse_headers</span><span style="color: #007700">(</span><span style="color: #0000BB">$headers</span><span style="color: #007700">));<br /><br />Array<br />(<br /> [</span><span style="color: #0000BB">Content</span><span style="color: #007700">-</span><span style="color: #0000BB">Type</span><span style="color: #007700">] => </span><span style="color: #0000BB">text</span><span style="color: #007700">/</span><span style="color: #0000BB">html</span><span style="color: #007700">; </span><span style="color: #0000BB">chatset</span><span style="color: #007700">=</span><span style="color: #0000BB">UTF</span><span style="color: #007700">-</span><span style="color: #0000BB">8<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">Server</span><span style="color: #007700">] => </span><span style="color: #0000BB">Funky</span><span style="color: #007700">/</span><span style="color: #0000BB">1.0<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">Set</span><span style="color: #007700">-</span><span style="color: #0000BB">Cookie</span><span style="color: #007700">] => Array<br /> (<br /> [</span><span style="color: #0000BB">0</span><span style="color: #007700">] => </span><span style="color: #0000BB">foo</span><span style="color: #007700">=</span><span style="color: #0000BB">bar<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">1</span><span style="color: #007700">] => </span><span style="color: #0000BB">baz</span><span style="color: #007700">=</span><span style="color: #0000BB">quux<br /> </span><span style="color: #007700">)<br /> [</span><span style="color: #0000BB">Folded</span><span style="color: #007700">] => </span><span style="color: #0000BB">works<br /> too <br /></span><span style="color: #007700">) <br /></span><span style="color: #0000BB">?></span><br />
</span></code></blockquote></p>
<p></pre></p>
-<h2 id="http_parse_cookie">object http_parse_cookie(string cookie)</h2>
+<h2 id="http_parse_cookie">object http_parse_cookie(string cookie[, int flags[, array allowed_extras]])</h2>
<p>Parses HTTP cookies like sent in a response into a struct.</p>
<p>Expects a string as parameter containing the value of a Set-Cookie response header.</p>
-<p>Returns an stdClass object with the cookie params as properties on success or FALSE on failure.</p>
+<p>Returns an stdClass olike shown in the example on success or FALSE on failure.</p>
<p>Example:</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_cookie</span><span style="color: #007700">(</span><span style="color: #DD0000">"foo=bar; path=/"</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">name</span><span style="color: #007700">] => </span><span style="color: #0000BB">foo<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">value</span><span style="color: #007700">] => </span><span style="color: #0000BB">bar<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">path</span><span style="color: #007700">] => /<br />)<br /></span><span style="color: #0000BB">?></span><br />
+<span style="color: #0000BB"><?php<br />print_r</span><span style="color: #007700">(</span><span style="color: #0000BB">http_parse_cookie</span><span style="color: #007700">(</span><span style="color: #DD0000">"foo=bar; bar=baz; path=/; domain=example.com; comment=; secure"</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"comment"</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">cookies</span><span style="color: #007700">] => Array<br /> (<br /> [</span><span style="color: #0000BB">foo</span><span style="color: #007700">] => </span><span style="color: #0000BB">bar<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">bar</span><span style="color: #007700">] => </span><span style="color: #0000BB">baz<br /> </span><span style="color: #007700">)<br /><br /> [</span><span style="color: #0000BB">extras</span><span style="color: #007700">] => Array<br /> (<br /> [</span><span style="color: #0000BB">comment</span><span style="color: #007700">] =><br /> )<br /><br /> [</span><span style="color: #0000BB">flags</span><span style="color: #007700">] => </span><span style="color: #0000BB">16<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">expires</span><span style="color: #007700">] => </span><span style="color: #0000BB">0<br /> </span><span style="color: #007700">[</span><span style="color: #0000BB">path</span><span style="color: #007700">] => /<br /> [</span><span style="color: #0000BB">domain</span><span style="color: #007700">] => </span><span style="color: #0000BB">example</span><span style="color: #007700">.</span><span style="color: #0000BB">com<br /></span><span style="color: #007700">)<br /></span><span style="color: #0000BB">?></span><br />
</span></code></blockquote></p>
<p></pre></p>
+<h2 id="http_parse_params">object http_parse_params(string param[, int flags = HTTP_PARAMS_DEFAULT])</h2>
+<p>Parse parameter list.</p>
<h2 id="http_get_request_headers">array http_get_request_headers(void)</h2>
<p>Get a list of incoming HTTP headers.</p>
<p>Returns an associative array of incoming request headers.</p>
redirects to a different host<br />
- proxyhost: string, proxy host in "host[:port]" format<br />
- proxyport: int, use another proxy port as specified in proxyhost<br />
+ - proxytype: int, HTTP_PROXY_HTTP, SOCKS4 or SOCKS5<br />
- proxyauth: string, proxy credentials in "user:pass" format<br />
- proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM<br />
- httpauth: string, http credentials in "user:pass" format<br />
- httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM<br />
- compress: bool, whether to allow gzip/deflate content encoding<br />
- (defaults to true)<br />
- port: int, use another port as specified in the url<br />
- referer: string, the referer to send<br />
- useragent: string, the user agent to send<br />
like array("header" => "value")<br />
- cookies: array, list of cookies as associative array<br />
like array("cookie" => "value")<br />
+ - encodecookies: bool, whether to urlencode the cookies (default: true)<br />
- cookiestore: string, path to a file where cookies are/will be stored<br />
+ - cookiesession: bool, don't load session cookies from cookiestore if TRUE<br />
- resume: int, byte offset to start the download from;<br />
if the server supports ranges<br />
+ - range: array, array of arrays, each containing two integers,<br />
+ specifying the ranges to download if server support is<br />
+ given; only recognized if the resume option is empty<br />
- maxfilesize: int, maximum file size that should be downloaded;<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 />
+ - etag: string, quoted etag for If-(None-)Match header<br />
- timeout: int, seconds the request may take<br />
- connecttimeout: int, seconds the connect may take<br />
- onprogress: mixed, progress callback<br />
+ - interface: string, outgoing network interface (ifname, ip or hostname)<br />
+ - portrange: array, 2 integers specifying outgoing portrange to try<br />
+ - ssl: array, with the following options:<br />
+ cert: string, path to certificate<br />
+ certtype: string, type of certificate<br />
+ certpasswd: string, password for certificate<br />
+ key: string, path to key<br />
+ keytype: string, type of key<br />
+ keypasswd: string, pasword for key<br />
+ engine: string, ssl engine to use<br />
+ version: int, ssl version to use<br />
+ verifypeer: bool, whether to verify the peer<br />
+ verifyhost: bool whether to verify the host<br />
+ cipher_list: string, list of allowed ciphers<br />
+ cainfo: string<br />
+ capath: string<br />
+ random_file: string<br />
+ egdsocket: string<br />
</pre></p>
<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 />
+in form
of 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://www.example.com/'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'response_code' </span><span style="color: #007700">=> </span><span style="color: #0000BB">302</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'connect_code' </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">'total_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.212348</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'namelookup_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.038296</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'connect_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.104144</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'pretransfer_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.104307</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'starttransfer_time' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0.212077</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">'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">218</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'speed_download' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1026</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">307</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'request_size' </span><span style="color: #007700">=> </span><span style="color: #0000BB">103</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">'ssl_engines' </span><span style="color: #007700">=><br /> array (<br /> </span><span style="color: #0000BB">0 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'dynamic'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">1 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'cswift'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">2 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'chil'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">3 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'atalla'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">4 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'nuron'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">5 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'ubsec'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">6 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'aep'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">7 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'sureware'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">8 </span><span style="color: #007700">=> </span><span style="color: #DD0000">'4758cca'</span><span style="color: #007700">,<br /> ),<br /> </span><span style="color: #DD0000">'content_length_download' </span><span style="color: #007700">=> </span><span style="color: #0000BB">218</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">'content_type' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'text/html'</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 /> </span><span style="color: #DD0000">'num_connects' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'os_errno' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'error' </span><span style="color: #007700">=> </span><span style="color: #DD0000">''</span><span style="color: #007700">,<br /> )<br /></span><span style="color: #0000BB">?></span><br />
</span></code></blockquote></p>
<p></pre></p>
<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
<p>See http_get() for a full list of available parameters and options.</p>
<p>Returns the HTTP response as string on success, or FALSE on failure.</p>
<h2 id="http_post_data">string http_post_data(string url, string data[, array options[, array &info]])</h2>
-<p>Performs an HTTP POST requeston the supplied url.</p>
+<p>Performs an HTTP POST request on the supplied url.</p>
<p>Expects a string as second parameter containing the pre-encoded post data.<br />
See http_get() for a full list of available parameters and options.<br />
<br />
Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
<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 on the supplied url.</p>
-<p>Expecrs an associative array as second parameter, which will be<br />
+<p>Expects an associative array as second parameter, which will be<br />
www-form-urlencoded. See http_get() for a full list of available options.</p>
<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
<h2 id="http_put_file">string http_put_file(string url, string file[, array options[, array &info]])</h2>
<p>Performs an HTTP PUT request on the supplied url.</p>
-<p>Expects the second parameter to be a string referncing the file to upload.<br />
+<p>Expects the second parameter to be a string referencing the file to upload.<br />
See http_get() for a full list of available options.</p>
<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
<h2 id="http_put_stream">string http_put_stream(string url, resource stream[, array options[, array &info]])</h2>
<p>Expects the second parameter to be a resource referencing an already <br />
opened stream, from which the data to upload should be read.<br />
See http_get() for a full list of available options.</p>
-<p>Returns the HTTP response(s) as string on success. or FALSE on failure.</p>
+<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
+<h2 id="http_put_data">string http_put_data(string url, string data[, array options[, array &info]])</h2>
+<p>Performs an HTTP PUT request on the supplied url.</p>
+<p>Expects the second parameter to be a string containing the data to upload.<br />
+See http_get() for a full list of available options.</p>
+<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
+<h2 id="http_request">string http_request(int method, string url[, string body[, array options[, array &info]]])</h2>
+<p>Performs a custom HTTP request on the supplied url.</p>
+<p>Expects the first parameter to be an integer specifying the request method to use.<br />
+Accepts an optional third string parameter containing the raw request body.<br />
+See http_get() for a full list of available options.</p>
+<p>Returns the HTTP response(s) as string on success, or FALSE on failure.</p>
+<h2 id="http_request_body_encode">string http_request_body_encode(array fields, array files)</h2>
+<p>Generate x-www-form-urlencoded resp. form-data encoded request body.</p>
+<p>Returns encoded string on success, or FALSE on failure.</p>
<h2 id="http_request_method_register">int http_request_method_register(string method)</h2>
<p>Register a custom request method.</p>
<p>Expects a string parameter containing the request method name to register.</p>
<p>Get the literal string representation of a standard or registered request method.</p>
<p>Expects the request method ID as parameter.</p>
<p>Returns the request method name as string on success, or FALSE on failure.</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>
<h2 id="http_deflate">string http_deflate(string data[, int flags = 0])</h2>
<p>Compress data with gzip, zlib AKA deflate or raw deflate encoding.</p>
<p>Expects the first parameter to be a string containing the data that should<br />
be encoded.</p>
<p>Returns the encoded string on success, or NULL on failure.</p>
<h2 id="http_inflate">string http_inflate(string data)</h2>
-<p>Uncompress data compressed with either gzip, deflate AKA zlib or raw<br />
+<p>Decompress data compressed with either gzip, deflate AKA zlib or raw<br />
deflate encoding.</p>
<p>Expects a string as parameter containing the compressed data.</p>
<p>Returns the decoded string on success, or NULL on failure.</p>
<h2 id="ob_deflatehandler">string ob_deflatehandler(string data, int mode)</h2>
<p>For use with ob_start(). The deflate output buffer handler can only be used once.<br />
-It conflicts with ob_gzhanlder and zlib.output_compression as well and should<br />
+It conflicts with ob_gzhandler and zlib.output_compression as well and should<br />
not be used after ext/mbstrings mb_output_handler and ext/sessions URL-Rewriter (AKA<br />
session.use_trans_sid).</p>
<h2 id="ob_inflatehandler">string ob_inflatehandler(string data, int mode)</h2>
<p>For use with ob_start(). Same restrictions as with ob_deflatehandler apply.</p>
<h2 id="http_support">int http_support([int feature = 0])</h2>
<p>Check for feature that require external libraries.</p>
-<p>Accpepts an optional in parameter specifying which feature to probe for.<br />
+<p>Accepts an optional in parameter specifying which feature to probe for.<br />
If the parameter is 0 or omitted, the return value contains a bitmask of <br />
all supported features that depend on external libraries.</p>
<p>Available features to probe for are:<br />
<hr noshade>
<h1 id="http_inflatestream_object.c">http_inflatestream_object.c</h1>
<h2 id="HttpInflateStream" class="o">HttpInflateStream</h2>
+<h3 id="HttpInflateStream___construct">void HttpInflateStream::__construct([int flags = 0])</h3>
+<p>Creates a new HttpInflateStream object instance.</p>
+<p>Accepts an optional int parameter specifying how to initialize the inflate stream.</p>
<h3 id="HttpInflateStream_update">string HttpInflateStream::update(string data)</h3>
<p>Passes more data through the inflate stream.</p>
<p>Expects a string parameter containing (a part of) the data to inflate.</p>
<p>Throws HttpMalformedHeaderException.</p>
<h3 id="HttpMessage_fromString">static HttpMessage HttpMessage::fromString(string raw_message[, string class_name = "HttpMessage"])</h3>
<p>Create an HttpMessage object from a string. Kind of a static constructor.</p>
-<p>Expects a string parameter containing a sinlge or several consecutive<br />
-HTTP messages. Accepts an optionsl string parameter specifying the class to use.</p>
+<p>Expects a string parameter containing a single or several consecutive<br />
+HTTP messages. Accepts an optional string parameter specifying the class to use.</p>
<p>Returns an HttpMessage object on success or NULL on failure.</p>
<p>Throws HttpMalformedHeadersException.</p>
<h3 id="HttpMessage_getBody">string HttpMessage::getBody()</h3>
<p>Set the body of the HttpMessage.<br />
NOTE: Don't forget to update any headers accordingly.</p>
<p>Expects a string parameter containing the new body of the message.</p>
+<h3 id="HttpMessage_getHeader">string HttpMessage::getHeader(string header)</h3>
+<p>Get message header.</p>
+<p>Returns the header value on success or NULL if the header does not exist.</p>
<h3 id="HttpMessage_getHeaders">array HttpMessage::getHeaders()</h3>
<p>Get Message Headers.</p>
<p>Returns an associative array containing the messages HTTP headers.</p>
<p>Returns the HttpMessage::TYPE.</p>
<h3 id="HttpMessage_setType">void HttpMessage::setType(int type)</h3>
<p>Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)</p>
-<p>Exptects an int parameter, the HttpMessage::TYPE.</p>
+<p>Expects an int parameter, the HttpMessage::TYPE.</p>
<h3 id="HttpMessage_getResponseCode">int HttpMessage::getResponseCode()</h3>
<p>Get the Response Code of the Message.</p>
<p>Returns the HTTP response code if the message is of type <br />
<p>Expects an int parameter with the HTTP response code.</p>
<p>Returns TRUE on success, or FALSE if the message is not of type<br />
HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510).</p>
+<h3 id="HttpMessage_getResponseStatus">string HttpMessage::getResponseStatus()</h3>
+<p>Get the Response Status of the message (i.e. the string following the response code).</p>
+<p>Returns the HTTP response status string if the message is of type <br />
+HttpMessage::TYPE_RESPONSE, else FALSE.</p>
+<h3 id="HttpMessage_setResponseStatus">bool HttpMessage::setResponseStatus(string status)</h3>
+<p>Set the Response Status of the HTTP message (i.e. the string following the response code).</p>
+<p>Expects a string parameter containing the response status text.</p>
+<p>Returns TRUE on success or FALSE if the message is not of type<br />
+HttpMessage::TYPE_RESPONSE.</p>
<h3 id="HttpMessage_getRequestMethod">string HttpMessage::getRequestMethod()</h3>
<p>Get the Request Method of the Message.</p>
<p>Returns the request method name on success, or FALSE if the message is<br />
<p>Set the HTTP Protocol version of the Message.</p>
<p>Expects a string parameter containing the HTTP protocol version.</p>
<p>Returns TRUE on success, or FALSE if supplied version is out of range (1.0/1.1).</p>
+<h3 id="HttpMessage_guessContentType">string HttpMessage::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])</h3>
+<p>Attempts to guess the content type of supplied payload through libmagic.</p>
+<p>Expects a string parameter specifying the magic.mime database to use.<br />
+Additionally accepts an optional int parameter, being flags for libmagic.</p>
+<p>Returns the guessed content type on success, or FALSE on failure.</p>
+<p>Throws HttpRuntimeException, HttpInvalidParamException <br />
+if http.only_exceptions is TRUE.</p>
<h3 id="HttpMessage_getParentMessage">HttpMessage HttpMessage::getParentMessage()</h3>
<p>Get parent Message.</p>
<p>Returns the parent HttpMessage on success, or NULL if there's none.</p>
+<p>Throws HttpRuntimeException.</p>
<h3 id="HttpMessage_send">bool HttpMessage::send()</h3>
<p>Send the Message according to its type as Response or Request.<br />
This provides limited functionality compared to HttpRequest and HttpResponse.</p>
<p>Re-constructs the HttpMessage based upon the serialized string.</p>
<h3 id="HttpMessage_detach">HttpMessage HttpMessage::detach(void)</h3>
<p>Returns a clone of an HttpMessage object detached from any parent messages.</p>
-<h3 id="HttpMessage_prepend">void HttpMessage::prepend(HttpMessage message)</h3>
+<h3 id="HttpMessage_prepend">void HttpMessage::prepend(HttpMessage message[, bool top = true])</h3>
<p>Prepends message(s) to the HTTP message.</p>
<p>Expects an HttpMessage object as parameter.</p>
+<p>Throws HttpInvalidParamException if the message is located within the same message chain.</p>
+<h3 id="HttpMessage_reverse">HttpMessage HttpMessage::reverse()</h3>
+<p>Reorders the message chain in reverse order.</p>
+<p>Returns the most parent HttpMessage object.</p>
<h3 id="HttpMessage_rewind">void HttpMessage::rewind(void)</h3>
<p>Implements Iterator.</p>
<h3 id="HttpMessage_valid">bool HttpMessage::valid(void)</h3>
<hr noshade>
<h1 id="http_querystring_object.c">http_querystring_object.c</h1>
<h2 id="HttpQueryString" class="o">HttpQueryString</h2>
-<h3 id="HttpQueryString___construct">void HttpQueryString::__construct([bool global = true[, mixed add])</h3>
+<h3 id="HttpQueryString___construct">final void HttpQueryString::__construct([bool global = true[, mixed add])</h3>
<p>Creates a new HttpQueryString object instance.<br />
Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.</p>
<h3 id="HttpQueryString_toString">string HttpQueryString::toString()</h3>
"b" for bool, "i" for int, "f" for float, "s" for string, "a" for array and "o" for a stdClass object.</p>
<h3 id="HttpQueryString_set">string HttpQueryString::set(mixed params)</h3>
<p>Set query string entry/entries. NULL values will unset the variable.</p>
-<h3 id="HttpQueryString_getInstance">HttpQueryString HttpQueryString::getInstance([bool global = true])</h3>
+<h3 id="HttpQueryString_mod">HttpQueryString HttpQueryString::mod(mixed params)</h3>
+<p>Copies the query string object and sets provided params at the clone.<br />
+This is basically shorthand for:</p><pre><blockquote><code><span style="color: #000000"><br />
+<span style="color: #0000BB"><?php<br />$newQS </span><span style="color: #007700">= new </span><span style="color: #0000BB">HttpQueryString</span><span style="color: #007700">(</span><span style="color: #0000BB">false</span><span style="color: #007700">, </span><span style="color: #0000BB">$oldQS</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$newQS</span><span style="color: #007700">-></span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #0000BB">$other_params</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span><br />
+</span></code></blockquote></p>
+<p></pre></p>
+<h3 id="HttpQueryString_singleton">static HttpQueryString HttpQueryString::singleton([bool global = true])</h3>
<p>Get a single instance (differentiates between the global setting).</p>
+<h3 id="HttpQueryString_xlate">bool HttpQueryString::xlate(string ie, string oe)</h3>
+<p>Converts the query string from the source encoding ie to the target encoding oe.<br />
+WARNING: Don't use any character set that can contain NUL bytes like UTF-16.</p>
+<p>Returns TRUE on success or FALSE on failure.</p>
+<h3 id="HttpQueryString_serialize">string HttpQueryString::serialize()</h3>
+<p>Implements Serializable.</p>
+<h3 id="HttpQueryString_unserialize">void HttpQueryString::unserialize(string serialized)</h3>
+<p>Implements Serializable.</p>
+<h3 id="HttpQueryString_offsetGet">mixed HttpQueryString::offsetGet(string offset)</h3>
+<p>Implements ArrayAccess.</p>
+<h3 id="HttpQueryString_offsetSet">void HttpQueryString::offsetSet(string offset, mixed value)</h3>
+<p>Implements ArrayAccess.</p>
+<h3 id="HttpQueryString_offsetExists">bool HttpQueryString::offsetExists(string offset)</h3>
+<p>Implements ArrayAccess.</p>
+<h3 id="HttpQueryString_offsetUnset">void HttpQueryString::offsetUnset(string offset)</h3>
+<p>Implements ArrayAccess.</p>
<hr noshade>
<h1 id="http_request_object.c">http_request_object.c</h1>
<h2 id="HttpRequest" class="o">HttpRequest</h2>
<h3 id="HttpRequest___construct">void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])</h3>
<p>Instantiate a new HttpRequest object.</p>
<p>Accepts a string as optional parameter containing the target request url.<br />
-Additianally accepts an optional int parameter specifying the request method<br />
+Additionally accepts an optional int parameter specifying the request method<br />
to use and an associative array as optional third parameter which will be<br />
passed to HttpRequest::setOptions(). </p>
<p>Throws HttpException.</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>
-<p>Accepts an array as optional parameters, wich values will overwrite the <br />
-currently set request options. If the parameter is empty or mitted,<br />
-the optoions of the HttpRequest object will be reset.</p>
+<p>Accepts an array as optional parameters, which values will overwrite the <br />
+currently set request options. If the parameter is empty or omitted,<br />
+the options of the HttpRequest object will be reset.</p>
<p>Returns TRUE on success, or FALSE on failure.</p>
<h3 id="HttpRequest_getOptions">array HttpRequest::getOptions()</h3>
<p>Get currently set options.</p>
<p>Returns an associative array containing any previously set SSL options.</p>
<h3 id="HttpRequest_addHeaders">bool HttpRequest::addHeaders(array headers)</h3>
<p>Add request header name/value pairs.</p>
-<p>Expects an ssociative array as parameter containing additional header<br />
+<p>Expects an associative array as parameter containing additional header<br />
name/value pairs.</p>
<p>Returns TRUE on success, or FALSE on failure.</p>
<h3 id="HttpRequest_setHeaders">bool HttpRequest::setHeaders([array headers])</h3>
<h3 id="HttpRequest_getCookies">array HttpRequest::getCookies()</h3>
<p>Get previously set cookies.</p>
<p>Returns an associative array containing any previously set cookies.</p>
+<h3 id="HttpRequest_enableCookies">bool HttpRequest::enableCookies()</h3>
+<p>Enable automatic sending of received cookies.<br />
+Note that cuutomly set cookies will be sent anyway.</p>
+<h3 id="HttpRequest_resetCookies">bool HttpRequest::resetCookies([bool session_only = FALSE])</h3>
+<p>Reset all automatically received/sent cookies.<br />
+Note that customly set cookies are not affected.</p>
+<p>Accepts an optional bool parameter specifying<br />
+whether only session cookies should be reset<br />
+(needs libcurl >= v7.15.4, else libcurl >= v7.14.1).</p>
+<p>Returns TRUE on success, or FALSE on failure.</p>
<h3 id="HttpRequest_setUrl">bool HttpRequest::setUrl(string url)</h3>
<p>Set the request URL.</p>
<p>Expects a string as parameter specifying the request url.</p>
<p>Get previously set raw post data.</p>
<p>Returns a string containing the currently set raw 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, leaving prefiously set files unchanged.<br />
+<p>Add a file to the POST request, leaving previously set files unchanged.<br />
Affects only POST and custom requests. Cannot be used with raw post data.</p>
<p>Expects a string parameter containing the form element name, and a string<br />
paremeter containing the path to the file which should be uploaded.<br />
-Additionally accepts an optional string parameter which chould contain<br />
+Additionally accepts an optional string parameter which should contain<br />
the content type of the file.</p>
<p>Returns TRUE on success, or FALSE if the content type seems not to contain a <br />
primary and a secondary content type part.</p>
<h3 id="HttpRequest_getPutFile">string HttpRequest::getPutFile()</h3>
<p>Get previously set put file.</p>
<p>Returns a string containing the path to the currently set put file.</p>
+<h3 id="HttpRequest_setPutData">bool HttpRequest::setPutData([string put_data])</h3>
+<p>Set PUT data to send, overwriting previously set PUT data.<br />
+Affects only PUT requests.<br />
+Only either PUT data or PUT file can be used for each request.<br />
+PUT data has higher precedence and will be used even if a PUT<br />
+file is set. </p>
+<p>Accepts a string as parameter containing the data to upload.</p>
+<p>Returns TRUE on success, or FALSE on failure.</p>
+<h3 id="HttpRequest_addPutData">bool HttpRequest::addPutData(string put_data)</h3>
+<p>Add PUT data, leaving previously set PUT data unchanged.<br />
+Affects only PUT requests.</p>
+<p>Expects a string as parameter containing the data to concatenate.</p>
+<p>Returns TRUE on success, or FALSE on failure.</p>
+<h3 id="HttpRequest_getPutData">string HttpRequest::getPutData()</h3>
+<p>Get previously set PUT data.</p>
+<p>Returns a string containing the currently set raw post data.</p>
<h3 id="HttpRequest_getResponseData">array HttpRequest::getResponseData()</h3>
<p>Get all response data after the request has been sent.</p>
<p>Returns an associative array with the key "headers" containing an associative<br />
-array holding all response headers, as well as the ley "body" containing a<br />
+array holding all response headers, as well as the key "body" containing a<br />
string with the response body. </p>
<p>If redirects were allowed and several responses were received, the data <br />
references the last received response.</p>
<p>Accepts an string as optional parameter specifying a certain header to read.<br />
If the parameter is empty or omitted all response headers will be returned.</p>
<p>Returns either a string with the value of the header matching name if requested, <br />
-FALSE on failure, or an associative array containing all reponse headers.</p>
+FALSE on failure, or an associative array containing all response headers.</p>
<p>If redirects were allowed and several responses were received, the data <br />
references the last received response.</p>
-<h3 id="HttpRequest_getResponseCookie">array HttpRequest::getResponseCookie([string name])</h3>
+<h3 id="HttpRequest_getResponseCookies">array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])</h3>
<p>Get response cookie(s) after the request has been sent.</p>
-<p>Accepts a string as optional parameter specifying the name of the cookie to read.<br />
-If the parameter is empty or omitted, an associative array with all received<br />
-cookies will be returned.</p>
-<p>Returns either an associative array with the cookie's name, value and any<br />
-additional params of the cookie matching name if requested, FALSE on failure,<br />
-or an array containing all received cookies as arrays.</p>
+<p>Returns an array of stdClass objects like http_parse_cookie would return.</p>
<p>If redirects were allowed and several responses were received, the data <br />
references the last received response.</p>
<h3 id="HttpRequest_getResponseBody">string HttpRequest::getResponseBody()</h3>
<p>Returns an int representing the response code.</p>
<p>If redirects were allowed and several responses were received, the data <br />
references the last received response.</p>
+<h3 id="HttpRequest_getResponseStatus">string HttpRequest::getResponseStatus()</h3>
+<p>Get the response status (i.e. the string after the response code) after the message has been sent.</p>
+<p>Returns a string containing the response status text.</p>
<h3 id="HttpRequest_getResponseInfo">mixed 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>
<p>Returns an HttpMessage object of the response.</p>
<p>If redirects were allowed and several responses were received, the data <br />
references the last received response. Use HttpMessage::getParentMessage()<br />
-to access the data of previously received responses whithin this request<br />
+to access the data of previously received responses within this request<br />
cycle.</p>
-<p>Throws HttpException.</p>
+<p>Throws HttpException, HttpRuntimeException.</p>
<h3 id="HttpRequest_getRequestMessage">HttpMessage HttpRequest::getRequestMessage()</h3>
<p>Get sent HTTP message.</p>
<p>Returns an HttpMessage object representing the sent request.</p>
<p>If redirects were allowed and several responses were received, the data <br />
references the last received response. Use HttpMessage::getParentMessage()<br />
-to access the data of previously sent requests whithin this request<br />
+to access the data of previously sent requests within this request<br />
cycle.</p>
<p>Note that the internal request message is immutable, that means that the<br />
request message received through HttpRequest::getRequestMessage() will<br />
<p>Returns the complete web server response, including the headers in a form of a string.</p>
<h3 id="HttpRequest_getHistory">HttpMessage HttpRequest::getHistory()</h3>
<p>Get all sent requests and received responses as an HttpMessage object.</p>
-<p>If you don't want to record history at all, set the instance variable<br />
-HttpRequest::$recoedHistory to FALSE. </p>
+<p>If you want to record history, set the instance variable<br />
+HttpRequest::$recordHistory to TRUE.</p>
<p>Returns an HttpMessage object representing the complete request/response<br />
history.</p>
<p>The object references the last received response, use HttpMessage::getParentMessage() <br />
to access the data of previously sent requests and received responses.</p>
-<p>Note that the internal history is immutable, that means that any changes<br />
-you make the the message list won't affect a history message list newly <br />
-created by another call to HttpRequest::getHistory().</p>
-<p>Throws HttpMalformedHeaderException, HttpEncodingException.</p>
+<p>Throws HttpRuntimeException.</p>
<h3 id="HttpRequest_clearHistory">void HttpRequest::clearHistory()</h3>
<p>Clear the history.</p>
<h3 id="HttpRequest_send">HttpMessage HttpRequest::send()</h3>
<h3 id="HttpRequestPool_attach">bool HttpRequestPool::attach(HttpRequest request)</h3>
<p>Attach an HttpRequest object to this HttpRequestPool.<br />
WARNING: set all options prior attaching!</p>
-<p>Expects the parameter to be an HttpRequest object not alread attached to<br />
+<p>Expects the parameter to be an HttpRequest object not already attached to<br />
antother HttpRequestPool object.</p>
<p>Returns TRUE on success, or FALSE on failure.</p>
<p>Throws HttpInvalidParamException, HttpRequestException, <br />
<p>Accepts a string as optional parameter which specifies the name of the<br />
header to read. If the parameter is empty or omitted, an associative array<br />
with all headers will be returned.</p>
+<p>NOTE: In Apache2 this only works for PHP-5.1.3 and greater.</p>
<p>Returns either a string containing the value of the header matching name,<br />
FALSE on failure, or an associative array with all headers.</p>
<h3 id="HttpResponse_setCache">static bool HttpResponse::setCache(bool cache)</h3>
-<p>Whether it sould be attempted to cache the entitity.<br />
+<p>Whether it should be attempted to cache the entity.<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.</p>
-<p>NOTE: If you're using sessions, be shure that you set session.cache_limiter<br />
+<p>NOTE: If you're using sessions, be sure that you set session.cache_limiter<br />
to something more appropriate than "no-cache"!</p>
<p>Expects a boolean as parameter specifying whether caching should be attempted.</p>
-<p>Returns TRUE ons success, or FALSE on failure.</p>
+<p>Returns TRUE on success, or FALSE on failure.</p>
<h3 id="HttpResponse_getCache">static bool HttpResponse::getCache()</h3>
<p>Get current caching setting.</p>
<p>Returns TRUE if caching should be attempted, else FALSE.</p>
<h3 id="HttpResponse_getGzip">static bool HttpResponse::getGzip()</h3>
<p>Get current gzipping setting.</p>
<p>Returns TRUE if GZip compression is enabled, else FALSE.</p>
-<h3 id="HttpResponse_setCacheControl">static bool HttpResponse::setCacheControl(string control[, int max_age = 0])</h3>
+<h3 id="HttpResponse_setCacheControl">static bool HttpResponse::setCacheControl(string control[, int max_age = 0[, bool must_revalidate = true]])</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>
<p>Expects a string parameter containing the primary cache control setting.<br />
-Addtitionally accepts an int parameter specifying the max-age setting.</p>
+Additionally accepts an int parameter specifying the max-age setting.<br />
+Accepts an optional third bool parameter indicating whether the cache<br />
+must be revalidated every request.</p>
<p>Returns TRUE on success, or FALSE if control does not match one of<br />
"public" , "private" or "no-cache".</p>
<p>Throws HttpInvalidParamException if http.only_exceptions is TRUE.</p>
<p>Set the Content-Disposition. The Content-Disposition header is very useful<br />
if the data actually sent came from a file or something similar, that should<br />
be "saved" by the client/user (i.e. by browsers "Save as..." popup window).</p>
-<p>Expects a string parameter specifying the file name the "Save as..." dialogue<br />
+<p>Expects a string parameter specifying the file name the "Save as..." dialog<br />
should display. Optionally accepts a bool parameter, which, if set to true<br />
and the user agent knows how to handle the content type, will probably not<br />
cause the popup window to be shown.</p>
<p>Returns the previously set path to the file to send as string.</p>
<h3 id="HttpResponse_send">static bool HttpResponse::send([bool clean_ob = true])</h3>
<p>Finally send the entity.</p>
-<p>Accepts an optional boolean parameter, specifying wheter the ouput<br />
+<p>Accepts an optional boolean parameter, specifying whether the output<br />
buffers should be discarded prior sending. A successful caching attempt<br />
will cause a script termination, and write a log entry if the INI setting<br />
http.cache_log is set.</p>
<p>Returns TRUE on success, or FALSE on failure.</p>
-<p>Throws HttpHeaderException, HttpResponseException if http.onyl_excpetions is TRUE.</p>
+<p>Throws HttpHeaderException, HttpResponseException if http.only_exceptions is TRUE.</p>
<p>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></code></blockquote></p>
</li>
<li><a href="#http_build_url">http_build_url</a>
</li>
+<li><a href="#http_build_str">http_build_str</a>
+</li>
<li><a href="#http_negotiate_language">http_negotiate_language</a>
</li>
<li><a href="#http_negotiate_charset">http_negotiate_charset</a>
</li>
<li><a href="#http_parse_cookie">http_parse_cookie</a>
</li>
+<li><a href="#http_parse_params">http_parse_params</a>
+</li>
<li><a href="#http_get_request_headers">http_get_request_headers</a>
</li>
<li><a href="#http_get_request_body">http_get_request_body</a>
</li>
<li><a href="#http_put_stream">http_put_stream</a>
</li>
+<li><a href="#http_put_data">http_put_data</a>
+</li>
+<li><a href="#http_request">http_request</a>
+</li>
+<li><a href="#http_request_body_encode">http_request_body_encode</a>
+</li>
<li><a href="#http_request_method_register">http_request_method_register</a>
</li>
<li><a href="#http_request_method_unregister">http_request_method_unregister</a>
</li>
<li><a href="#http_request_method_name">http_request_method_name</a>
</li>
-<li><a href="#http_build_query">http_build_query</a>
-</li>
<li><a href="#http_deflate">http_deflate</a>
</li>
<li><a href="#http_inflate">http_inflate</a>
</li>
<li><a class="tocfile" href="#http_inflatestream_object.c">http_inflatestream_object.c</a>
<ul>
+<li><a href="#HttpInflateStream___construct">HttpInflateStream::__construct()</a></li>
<li><a href="#HttpInflateStream_update">HttpInflateStream::update()</a></li>
<li><a href="#HttpInflateStream_flush">HttpInflateStream::flush()</a></li>
<li><a href="#HttpInflateStream_finish">HttpInflateStream::finish()</a></li>
<li><a href="#HttpMessage_fromString">HttpMessage::fromString()</a></li>
<li><a href="#HttpMessage_getBody">HttpMessage::getBody()</a></li>
<li><a href="#HttpMessage_setBody">HttpMessage::setBody()</a></li>
+<li><a href="#HttpMessage_getHeader">HttpMessage::getHeader()</a></li>
<li><a href="#HttpMessage_getHeaders">HttpMessage::getHeaders()</a></li>
<li><a href="#HttpMessage_setHeaders">HttpMessage::setHeaders()</a></li>
<li><a href="#HttpMessage_addHeaders">HttpMessage::addHeaders()</a></li>
<li><a href="#HttpMessage_setType">HttpMessage::setType()</a></li>
<li><a href="#HttpMessage_getResponseCode">HttpMessage::getResponseCode()</a></li>
<li><a href="#HttpMessage_setResponseCode">HttpMessage::setResponseCode()</a></li>
+<li><a href="#HttpMessage_getResponseStatus">HttpMessage::getResponseStatus()</a></li>
+<li><a href="#HttpMessage_setResponseStatus">HttpMessage::setResponseStatus()</a></li>
<li><a href="#HttpMessage_getRequestMethod">HttpMessage::getRequestMethod()</a></li>
<li><a href="#HttpMessage_setRequestMethod">HttpMessage::setRequestMethod()</a></li>
<li><a href="#HttpMessage_getRequestUrl">HttpMessage::getRequestUrl()</a></li>
<li><a href="#HttpMessage_setRequestUrl">HttpMessage::setRequestUrl()</a></li>
<li><a href="#HttpMessage_getHttpVersion">HttpMessage::getHttpVersion()</a></li>
<li><a href="#HttpMessage_setHttpVersion">HttpMessage::setHttpVersion()</a></li>
+<li><a href="#HttpMessage_guessContentType">HttpMessage::guessContentType()</a></li>
<li><a href="#HttpMessage_getParentMessage">HttpMessage::getParentMessage()</a></li>
<li><a href="#HttpMessage_send">HttpMessage::send()</a></li>
<li><a href="#HttpMessage_toString">HttpMessage::toString()</a></li>
<li><a href="#HttpMessage_unserialize">HttpMessage::unserialize()</a></li>
<li><a href="#HttpMessage_detach">HttpMessage::detach()</a></li>
<li><a href="#HttpMessage_prepend">HttpMessage::prepend()</a></li>
+<li><a href="#HttpMessage_reverse">HttpMessage::reverse()</a></li>
<li><a href="#HttpMessage_rewind">HttpMessage::rewind()</a></li>
<li><a href="#HttpMessage_valid">HttpMessage::valid()</a></li>
<li><a href="#HttpMessage_next">HttpMessage::next()</a></li>
<li><a href="#HttpQueryString_toArray">HttpQueryString::toArray()</a></li>
<li><a href="#HttpQueryString_get">HttpQueryString::get()</a></li>
<li><a href="#HttpQueryString_set">HttpQueryString::set()</a></li>
-<li><a href="#HttpQueryString_getInstance">HttpQueryString::getInstance()</a></li>
+<li><a href="#HttpQueryString_mod">HttpQueryString::mod()</a></li>
+<li><a href="#HttpQueryString_singleton">HttpQueryString::singleton()</a></li>
+<li><a href="#HttpQueryString_xlate">HttpQueryString::xlate()</a></li>
+<li><a href="#HttpQueryString_serialize">HttpQueryString::serialize()</a></li>
+<li><a href="#HttpQueryString_unserialize">HttpQueryString::unserialize()</a></li>
+<li><a href="#HttpQueryString_offsetGet">HttpQueryString::offsetGet()</a></li>
+<li><a href="#HttpQueryString_offsetSet">HttpQueryString::offsetSet()</a></li>
+<li><a href="#HttpQueryString_offsetExists">HttpQueryString::offsetExists()</a></li>
+<li><a href="#HttpQueryString_offsetUnset">HttpQueryString::offsetUnset()</a></li>
</li>
</ul>
</li>
<li><a href="#HttpRequest_setCookies">HttpRequest::setCookies()</a></li>
<li><a href="#HttpRequest_addCookies">HttpRequest::addCookies()</a></li>
<li><a href="#HttpRequest_getCookies">HttpRequest::getCookies()</a></li>
+<li><a href="#HttpRequest_enableCookies">HttpRequest::enableCookies()</a></li>
+<li><a href="#HttpRequest_resetCookies">HttpRequest::resetCookies()</a></li>
<li><a href="#HttpRequest_setUrl">HttpRequest::setUrl()</a></li>
<li><a href="#HttpRequest_getUrl">HttpRequest::getUrl()</a></li>
<li><a href="#HttpRequest_setMethod">HttpRequest::setMethod()</a></li>
<li><a href="#HttpRequest_getPostFiles">HttpRequest::getPostFiles()</a></li>
<li><a href="#HttpRequest_setPutFile">HttpRequest::setPutFile()</a></li>
<li><a href="#HttpRequest_getPutFile">HttpRequest::getPutFile()</a></li>
+<li><a href="#HttpRequest_setPutData">HttpRequest::setPutData()</a></li>
+<li><a href="#HttpRequest_addPutData">HttpRequest::addPutData()</a></li>
+<li><a href="#HttpRequest_getPutData">HttpRequest::getPutData()</a></li>
<li><a href="#HttpRequest_getResponseData">HttpRequest::getResponseData()</a></li>
<li><a href="#HttpRequest_getResponseHeader">HttpRequest::getResponseHeader()</a></li>
-<li><a href="#HttpRequest_getResponseCookie">HttpRequest::getResponseCookie()</a></li>
+<li><a href="#HttpRequest_getResponseCookies">HttpRequest::getResponseCookies()</a></li>
<li><a href="#HttpRequest_getResponseBody">HttpRequest::getResponseBody()</a></li>
<li><a href="#HttpRequest_getResponseCode">HttpRequest::getResponseCode()</a></li>
+<li><a href="#HttpRequest_getResponseStatus">HttpRequest::getResponseStatus()</a></li>
<li><a href="#HttpRequest_getResponseInfo">HttpRequest::getResponseInfo()</a></li>
<li><a href="#HttpRequest_getResponseMessage">HttpRequest::getResponseMessage()</a></li>
<li><a href="#HttpRequest_getRequestMessage">HttpRequest::getRequestMessage()</a></li>
</li>
</ul>
</div>
- <p><b>Generated at: Fri, 03 Feb 2006 10:38:18 +0100</b></p>
+ <p><b>Generated at: Fri, 07 Jul 2006 21:23:59 +0200</b></p>
</body>
</html>
projects / m6w6 / ext-http / blobdiff