X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Ffunctions.html;h=e1329bb6d9034cea8ed295454eae73dda45a755c;hb=391976a207cfc3effffa0bdbfa14829eb753e9aa;hp=8979c256b455fb05168ffdce2dbcf759e29e4a27;hpb=b63e146a77c6512cae1574c0bb520b3a7bbec1e7;p=m6w6%2Fext-http diff --git a/docs/functions.html b/docs/functions.html index 8979c25..e1329bb 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; + } -
Compose a valid HTTP date regarding RFC 822/1123
looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
For use with ob_start(). Output buffer handler generating an ETag with
the hash algorythm specified with the INI setting "http.etag_mode".
Sets the throttle delay and send buffer size for use with http_send() API.
Provides a basic throttling mechanism, which will yield the current process
resp. thread until the entity has been completely sent, though.
- redirect: - compress: bool, whether to allow gzip/deflate content encoding
(defaults to true)
- port: int, use another port as specified in the url
- - referer: string, the referer to sends
+ - referer: string, the referer to send
- useragent: string, the user agent to send
(defaults to PECL::HTTP/version (PHP/version)))
- headers: array, list of custom headers as associative array
@@ -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 features 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.
Instantiate a new HttpMessage object.
@@ -407,13 +481,14 @@ This provides limited functionality compared to HttpRequest and HttpResponse.Returns the full message as string.
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.
Throws HttpException.
Destroys the HttpRequest object.
@@ -647,7 +722,7 @@ HttpMalformedHeaderException, HttpEncodingException.Instantiate a new HttpRequestPool object. An HttpRequestPool is
@@ -687,7 +762,7 @@ HttpRequestPoolException, HttpMalformedHeaderException.
Returns TRUE until each request has finished its transaction.
Usage:
-<?php
while ($pool->socketPerform()) {
do_something_else();
if (!$pool->socketSelect()) {
die('Socket error');
}
}
?>
+<?php
class MyPool extends HttpRequestPool
{
public function send()
{
while ($this->socketPerform()) {
if (!$this->socketSelect()) {
throw new HttpSocketExcpetion;
}
}
}
protected final function socketPerform()
{
$result = parent::socketPerform();
foreach ($this->getFinishedRequests() as $r) {
$this->detach($r);
// handle response of finished request
}
return $result;
}
}
?>
Implements Iterator::next().
Implements Iterator::rewind().
+Get attached HttpRequest objects.
+Returns an array containing all currently attached HttpRequest objects.
+Get attached HttpRequest objects that already have finished their work.
+Returns an array containing all attached HttpRequest objects that
+already have finished their work.
Send an HTTP header.
Expects a string parameter containing the name of the header and a mixed
@@ -760,7 +842,7 @@ contain a primary and secondary content type part.
Get current Content-Type header setting.
Returns the currently set content type as string.
-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.
Generated at: Wed, 05 Oct 2005 14:35:52 +0000
+Generated at: Fri, 04 Nov 2005 12:29:06 +0100