- cleanup

[m6w6/ext-http] / docs / functions.html

diff --git a/docs/functions.html b/docs/functions.html
index 148840804190bed8a03cf26a4e58d0f17ba34391..164af4c00b2e784569423379e7dd8e31f811fcaa 100644 (file)
--- a/docs/functions.html
+++ b/docs/functions.html
@@ -310,6 +310,7 @@ array where the following keys will be recognized:</p><pre> - redirect:
                      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 />
@@ -329,6 +330,9 @@ array where the following keys will be recognized:</p><pre> - redirect:
  - cookiesession:    bool, accept (true) or reset (false) sessioncookies<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 />
@@ -392,6 +396,12 @@ See http_get() for a full list of available options.</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_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>
@@ -562,6 +572,7 @@ HttpMessage::TYPE_REQUEST or supplied URL was empty.</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>
@@ -586,9 +597,10 @@ should also contain any parent messages.</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>
@@ -618,9 +630,9 @@ Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.</
 "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_singleton">static HttpQueryString HttpQueryString::singleton([bool global = true])</h3>
 <p>Get a single instance (differentiates between the global setting).</p>
-<h3 id="HttpQueryString_iconv">bool HttpQueryString::iconv(string ie, string oe)</h3>
+<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>
@@ -849,7 +861,7 @@ references the last received response.</p>
 references the last received response.  Use HttpMessage::getParentMessage()<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>
@@ -978,6 +990,7 @@ parameter is unset no header with this name will be sent. </p>
 <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>
@@ -1194,6 +1207,8 @@ http.cache_log is set.</p>
 </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_method_register">http_request_method_register</a>
 </li>
 <li><a href="#http_request_method_unregister">http_request_method_unregister</a>
@@ -1277,8 +1292,8 @@ http.cache_log is set.</p>
 <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_iconv">HttpQueryString::iconv()</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>
@@ -1395,7 +1410,7 @@ http.cache_log is set.</p>
 </li>
 </ul>
 </div>
-    <p><b>Generated at: Fri, 24 Feb 2006 21:29:29 +0100</b></p>
+    <p><b>Generated at: Thu, 06 Apr 2006 15:55:09 +0200</b></p>
 </body>
 </html>