X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;ds=sidebyside;f=docs%2Ffunctions.html;h=b27ed0799bae4709bf67515230a4092a77b61f5e;hb=b3dd66ed1452139236b7101f7d73f19917bd1ea2;hp=2f7668eba3f34fa59899367cc1ff42e8f450232d;hpb=2d31adababe7af92c0153f8eff813c582c3d566c;p=m6w6%2Fext-http diff --git a/docs/functions.html b/docs/functions.html index 2f7668e..b27ed07 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -74,7 +74,7 @@ looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
Accepts an optional unix timestamp as parameter.
Returns the HTTP date as string.
-Build an URL.
Expexts (part(s) of) an URL as first parameter in form of a string or assoziative array
like parse_url() returns. Accepts an optional second parameter in the same way as the
@@ -84,7 +84,7 @@ with the results as associative array like parse_url() would return.
The parts of the second URL will be merged into the first according to the flags argument.
The following flags are recognized:
- HTTP_URL_REPLACE: (default) set parts of the second url will replace the parts in the first+
- HTTP_URL_JOIN_PATH: the path of the second url will be merged into the one of the first
- - HTTP_URL_JOIN_QUERY: the two querystrings will be merged naivly; no replacements are done
+ - HTTP_URL_JOIN_QUERY: the two querystrings will be merged recursively
- HTTP_URL_STRIP_USER: the user part will not appear in the result
- HTTP_URL_STRIP_PASS: the password part will not appear in the result
- HTTP_URL_STRIP_AUTH: neither the user nor the password part will appear in the result
@@ -284,6 +284,8 @@ several consecutive HTTP messages. <?php
print_r(http_parse_cookie("foo=bar; bar=baz; path=/; domain=example.com; comment=; secure", 0, array("comment")));
stdClass Object
(
[cookies] => Array
(
[foo] => bar
[bar] => baz
)
[extras] => Array
(
[comment] =>
)
[flags] => 16
[expires] => 0
[path] => /
[domain] => example.com
)
?>
Parse parameter list.
Get a list of incoming HTTP headers.
Returns an associative array of incoming request headers.
@@ -325,9 +327,8 @@ array where the following keys will be recognized:- redirect: - cookies: array, list of cookies as associative array
like array("cookie" => "value")
- encodecookies: bool, whether to urlencode the cookies (default: true)
- - resetcookies: bool, wheter to reset the cookies
- cookiestore: string, path to a file where cookies are/will be stored
- - cookiesession: bool, accept (true) or reset (false) sessioncookies
+ - cookiesession: bool, don't load session cookies from cookiestore if TRUE
- resume: int, byte offset to start the download from;
if the server supports ranges
- range: array, array of arrays, each containing two integers,
@@ -396,6 +397,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.
@@ -467,6 +477,9 @@ all supported features.
http_inflatestream_object.c
HttpInflateStream
+void HttpInflateStream::__construct([int flags = 0])
+Creates a new HttpInflateStream object instance.
+Accepts an optional int parameter specifying how to initialize the inflate stream.
string HttpInflateStream::update(string data)
Passes more data through the inflate stream.
Expects a string parameter containing (a part of) the data to inflate.
@@ -566,7 +579,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 HttpMessageException.
+Throws HttpRuntimeException.
bool HttpMessage::send()
Send the Message according to its type as Response or Request.
@@ -591,9 +604,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.
@@ -623,7 +637,7 @@ 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::singleton([bool global = true])
+static HttpQueryString HttpQueryString::singleton([bool global = true])
Get a single instance (differentiates between the global setting).
bool HttpQueryString::xlate(string ie, string oe)
Converts the query string from the source encoding ie to the target encoding oe.
@@ -690,6 +704,16 @@ pairs to add.array HttpRequest::getCookies()
Get previously set cookies.
Returns an associative array containing any previously set cookies.
+bool HttpRequest::enableCookies()
+Enable automatic sending of received cookies.
+
+Note that cuutomly set cookies will be sent anyway.bool HttpRequest::resetCookies([bool session_only = FALSE])
+Reset all automatically received/sent cookies.
+
+Note that customly set cookies are not affected.Accepts an optional bool parameter specifying
+
+whether only session cookies should be reset
+(needs libcurl >= v7.15.4, else libcurl >= v7.14.1).Returns TRUE on success, or FALSE on failure.
bool HttpRequest::setUrl(string url)
Set the request URL.
Expects a string as parameter specifying the request url.
@@ -983,6 +1007,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)
@@ -1177,6 +1202,8 @@ http.cache_log is set.
Generated at: Tue, 07 Mar 2006 15:57:21 +0100
+Generated at: Thu, 25 May 2006 10:46:03 +0200