X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Ffunctions.html;h=e0d1e1c07131103a6cac648937d3137e87ae42e1;hb=28676404f30a0814a8e027d63b3cec4959475c46;hp=148840804190bed8a03cf26a4e58d0f17ba34391;hpb=6086d2a97b6959531650c886b10dc814ad2392f9;p=m6w6%2Fext-http diff --git a/docs/functions.html b/docs/functions.html index 1488408..e0d1e1c 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -310,6 +310,7 @@ array where the following keys will be recognized:
- redirect: redirects to a different host
- proxyhost: string, proxy host in "host[:port]" format
- proxyport: int, use another proxy port as specified in proxyhost
+ - proxytype: int, HTTP_PROXY_HTTP, SOCKS4 or SOCKS5
- proxyauth: string, proxy credentials in "user:pass" format
- proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
- httpauth: string, http credentials in "user:pass" format
@@ -329,6 +330,9 @@ array where the following keys will be recognized:- redirect: - cookiesession: bool, accept (true) or reset (false) sessioncookies
- resume: int, byte offset to start the download from;
if the server supports ranges
+ - range: array, array of arrays, each containing two integers,
+ specifying the ranges to download if server support is
+ given; only recognized if the resume option is empty
- maxfilesize: int, maximum file size that should be downloaded;
has no effect, if the size of the requested entity is not known
- lastmodified: int, timestamp for If-(Un)Modified-Since header
@@ -392,6 +396,15 @@ See http_get() for a full list of available options.Expects the second parameter to be a string containing the data to upload.
See http_get() for a full list of available options.Returns the HTTP response(s) as string on success, or FALSE on failure.
+string http_request(int method, string url[, string body[, array options[, array &info]]])
+Performs a custom HTTP request on the supplied url.
+Expects the first parameter to be an integer specifying the request method to use.
+
+Accepts an optional third string parameter containing the raw request body.
+See http_get() for a full list of available options.Returns the HTTP response(s) as string on success, or FALSE on failure.
+string http_request_body_encode(array fields, array files)
+Generate x-www-form-urlencoded resp. form-data encoded request body.
+Returns encoded string on success, or FALSE on failure.
int http_request_method_register(string method)
Register a custom request method.
Expects a string parameter containing the request method name to register.
@@ -562,6 +575,7 @@ HttpMessage::TYPE_REQUEST or supplied URL was empty.HttpMessage HttpMessage::getParentMessage()
Get parent Message.
Returns the parent HttpMessage on success, or NULL if there's none.
+Throws HttpRuntimeException.
bool HttpMessage::send()
Send the Message according to its type as Response or Request.
@@ -586,9 +600,10 @@ should also contain any parent messages.
This provides limited functionality compared to HttpRequest and HttpResponse.Re-constructs the HttpMessage based upon the serialized string.
HttpMessage HttpMessage::detach(void)
Returns a clone of an HttpMessage object detached from any parent messages.
-void HttpMessage::prepend(HttpMessage message)
+void HttpMessage::prepend(HttpMessage message[, bool top = true])
Prepends message(s) to the HTTP message.
Expects an HttpMessage object as parameter.
+Throws HttpInvalidParamException if the message is located within the same message chain.
HttpMessage HttpMessage::reverse()
Reorders the message chain in reverse order.
Returns the most parent HttpMessage object.
@@ -618,9 +633,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.string HttpQueryString::set(mixed params)
Set query string entry/entries. NULL values will unset the variable.
-HttpQueryString HttpQueryString::getInstance([bool global = true])
+static HttpQueryString HttpQueryString::singleton([bool global = true])
Get a single instance (differentiates between the global setting).
-bool HttpQueryString::iconv(string ie, string oe)
+bool HttpQueryString::xlate(string ie, string oe)
Converts the query string from the source encoding ie to the target encoding oe.
WARNING: Don't use any character set that can contain NUL bytes like UTF-16.Returns TRUE on success or FALSE on failure.
@@ -849,7 +864,7 @@ references the last received response. references the last received response. Use HttpMessage::getParentMessage()
to access the data of previously received responses within this request
cycle. -Throws HttpException.
+Throws HttpException, HttpRuntimeException.
HttpMessage HttpRequest::getRequestMessage()
Get sent HTTP message.
Returns an HttpMessage object representing the sent request.
@@ -978,6 +993,7 @@ parameter is unset no header with this name will be sent.Accepts a string as optional parameter which specifies the name of the
+
header to read. If the parameter is empty or omitted, an associative array
with all headers will be returned.NOTE: In Apache2 this only works for PHP-5.1.3 and greater.
Returns either a string containing the value of the header matching name,
FALSE on failure, or an associative array with all headers.static bool HttpResponse::setCache(bool cache)
@@ -1194,6 +1210,10 @@ http.cache_log is set.
Generated at: Fri, 24 Feb 2006 21:29:29 +0100
+Generated at: Thu, 13 Apr 2006 17:25:58 +0200