X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Ffunctions.html;h=f785fd092f8916f6c99c7a4757743875670650a3;hb=4c47eabee60a0266f3f27bf91528830b32da842e;hp=8979c256b455fb05168ffdce2dbcf759e29e4a27;hpb=b63e146a77c6512cae1574c0bb520b3a7bbec1e7;p=m6w6%2Fext-http diff --git a/docs/functions.html b/docs/functions.html index 8979c25..f785fd0 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -43,9 +43,29 @@ p br, pre code br { display: block; } + .toc { + position: absolute; + top: 10px; + right: 10px; + width: 300px; + height: 95%; + overflow: scroll; + font-size: .9em; + } + body>div.toc { + position: fixed; + } + .toc ul { + padding-left: 15px; + margin-left: 0; + } + .toc li { + padding: 0; + margin: 0; + } -

http_functions.c

+

http_functions.c

string http_date([int timestamp])

Compose a valid HTTP date regarding RFC 822/1123
looking like: "Wed, 22 Dec 2004 11:34:47 GMT"

@@ -307,7 +327,7 @@ See http_get() for a full list of available options.

Unregister a previously registered custom request method.

Expects either the request method name or ID.

Returns TRUE on success, or FALSE on failure.

-

long http_request_method_exists(mixed method)

+

int http_request_method_exists(mixed method)

Check if a request method is registered (or available by default).

Expects either the request method name or ID as parameter.

Returns TRUE if the request method is known, else FALSE.

@@ -317,8 +337,62 @@ See http_get() for a full list of available options.

Returns the request method name as string on success, or FALSE on failure.

string http_build_query(mixed formdata [, string prefix[, string arg_separator]])

Generates a form-encoded query string from an associative array or object.

+

string http_gzencode(string data[, int level = -1])

+

Compress data with the HTTP compatible GZIP encoding.

+

Expects the first parameter to be a string which contains the data that
+should be encoded. Additionally accepts an optional in paramter specifying
+the compression level, where -1 is default, 0 is no compression and 9 is
+best compression ratio.

+

Returns the encoded string on success, or NULL on failure.

+

string http_gzdecode(string data)

+

Uncompress data compressed with the HTTP compatible GZIP encoding.

+

Expects a string as parameter containing the compressed data.

+

Returns the decoded string on success, or NULL on failure.

+

string http_deflate(string data[, int level = -1])

+

Compress data with the HTTP compatible DEFLATE encoding.

+

Expects the first parameter to be a string containing the data that should
+be encoded. Additionally accepts an optional int parameter specifying the
+compression level, where -1 is default, 0 is no compression and 9 is best
+compression ratio.

+

Returns the encoded string on success, or NULL on failure.

+

string http_inflate(string data)

+

Uncompress data compressed with the HTTP compatible DEFLATE encoding.

+

Expects a string as parameter containing the compressed data.

+

Returns the decoded string on success, or NULL on failure.

+

string http_compress(string data[, int level = -1])

+

Compress data with the HTTP compatible COMPRESS encoding.

+

Expects the first parameter to be a string containing the data which should
+be encoded. Additionally accepts an optional int parameter specifying the
+compression level, where -1 is default, 0 is no compression and 9 is best
+compression ratio.

+

Returns the encoded string on success, or NULL on failure.

+

string http_uncompress(string data)

+

Uncompress data compressed with the HTTP compatible COMPRESS encoding.

+

Expects a string as parameter containing the compressed data.

+

Returns the decoded string on success, or NULL on failure.

+

int http_support([int feature = 0])

+

Check for feature that require external libraries.

+

Accpepts an optional in parameter specifying which feature to probe for.
+If the parameter is 0 or omitted, the return value contains a bitmask of
+all supported featuers that depend on external libraries.

+

Available features to probe for are:
+

+

Returns int, whether requested feature is supported, or a bitmask with
+all supported features.


-

http_message_object.c

+

http_message_object.c

HttpMessage

void HttpMessage::__construct([string message])

Instantiate a new HttpMessage object.

@@ -407,13 +481,14 @@ This provides limited functionality compared to HttpRequest and HttpResponse.

Returns the full message as string.


-

http_request_object.c

+

http_request_object.c

HttpRequest

-

void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET]])

+

void HttpRequest::__construct([string url[, int request_method = HTTP_METH_GET[, array options]]])

Instantiate a new HttpRequest object.

Accepts a string as optional parameter containing the target request url.
Additianally accepts an optional int parameter specifying the request method
-to use.

+to use and an associative array as optional third parameter which will be
+passed to HttpRequest::setOptions().

Throws HttpException.

void HttpRequest::__destruct()

Destroys the HttpRequest object.

@@ -647,7 +722,7 @@ HttpMalformedHeaderException, HttpEncodingException.


-

http_requestpool_object.c

+

http_requestpool_object.c

HttpRequestPool

void HttpRequestPool::__construct([HttpRequest request[, ...]])

Instantiate a new HttpRequestPool object. An HttpRequestPool is
@@ -704,7 +779,7 @@ HttpRequestPoolException, HttpMalformedHeaderException.

void HttpRequestPool::rewind()

Implements Iterator::rewind().


-

http_response_object.c

+

http_response_object.c

static bool HttpResponse::setHeader(string name, mixed value[, bool replace = true])

Send an HTTP header.

Expects a string parameter containing the name of the header and a mixed
@@ -760,7 +835,7 @@ contain a primary and secondary content type part.

static string HttpResponse::getContentType()

Get current Content-Type header setting.

Returns the currently set content type as string.

-

static string HttpResponse::guessContentType(string magic_file[, long magic_mode = MAGIC_MIME])

+

static string HttpResponse::guessContentType(string magic_file[, int magic_mode = MAGIC_MIME])

Attempts to guess the content type of supplied payload through libmagic.
If the attempt is successful, the guessed content type will automatically
be set as response content type.

@@ -859,7 +934,225 @@ http.cache_log is set.


-

Generated at: Wed, 05 Oct 2005 14:35:52 +0000

+
Table of Contents + +
+

Generated at: Tue, 11 Oct 2005 11:33:16 +0000