X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Ffunctions.html;h=b815071d31a3cf5b33523658f2e578956c086127;hb=f2d0dbf38d7b00455d3dfba8f2de087105ae0f35;hp=1503d1a33ada8f096e9caa237a4bf1888c9d2d24;hpb=19ad90d1f12058345ceb651b4bed6ff0f298dd08;p=m6w6%2Fext-http diff --git a/docs/functions.html b/docs/functions.html index 1503d1a..b815071 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -113,6 +113,19 @@ if none match.

<?php
$charsets = array(
        'iso-8859-1', // default
        'iso-8859-2',
        'iso-8859-15',
        'utf-8'
);

$pref = http_negotiate_charset($charsets, $result);

if (strcmp($pref, 'iso-8859-1')) {
        iconv_set_encoding('internal_encoding', 'iso-8859-1');
        iconv_set_encoding('output_encoding', $pref);
        ob_start('ob_iconv_handler');
}

print_r($result);
?>

+

string http_negotiate_ctype(array supported[, array &result])

+

This function negotiates the clients preferred content type based on its
+Accept HTTP header. The qualifier is recognized and content types
+without qualifier are rated highest.

+

Expects an array as parameter cotaining the supported content types as values.
+If the optional second parameter is supplied, it will be filled with an
+array containing the negotiation results.

+

Returns the negotiated content type or the default content type
+(i.e. first array entry) if none match.

+

Example:



+<?php
$ctypes = array('application/xhtml+xml', 'text/html');
http_send_content_type(http_negotiate_content_type($ctypes));
?>

+

+

bool http_send_status(int status)

Send HTTP status code.

Expects an HTTP status code as parameter.

@@ -179,7 +192,7 @@ a "304 Not Modified" status code is issued.

string ob_etaghandler(string data, int mode)

For use with ob_start(). Output buffer handler generating an ETag with
the hash algorythm specified with the INI setting "http.etag_mode".

-

void http_throttle(double sec[, int bytes = 2097152])

+

void http_throttle(double sec[, int bytes = 40960])

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.

@@ -270,7 +283,7 @@ array where the following keys will be recognized:

 - 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

@@ -337,6 +350,58 @@ 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.

 

 
http_message_object.c

 
HttpMessage

@@ -426,14 +491,24 @@ This provides limited functionality compared to HttpRequest and HttpResponse.
Accepts a bool parameter which specifies whether the returned string

 should also contain any parent messages.

 
Returns the full message as string.

+
int HttpMessage::count()

+
Implements Countable.

+
Returns the number of parent messages + 1.

+
string HttpMessage::serialize()

+
Implements Serializable.

+
Returns the serialized representation of the HttpMessage.

+
void HttpMessage::unserialize(string serialized)

+
Implements Serializable.

+
Re-constructs the HttpMessage based upon the serialized string.

 

 
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.

@@ -642,6 +717,11 @@ cycle.

 references the last received response.  Use HttpMessage::getParentMessage()

 to access the data of previously sent requests whithin this request

 cycle.

+
Note that the internal request message is immutable, that means that the

+request message received through HttpRequest::getRequestMessage() will

+always look the same for the same request, regardless of any changes you

+may have made to the returned object.

+
Throws HttpMalformedHeadersException, HttpEncodingException.

 
HttpMessage HttpRequest::getHistory()

 
Get all sent requests and received responses as an HttpMessage object.

 
If you don't want to record history at all, set the instance variable

@@ -650,12 +730,18 @@ HttpRequest::$recoedHistory to FALSE. 

 history.

 
The object references the last received response, use HttpMessage::getParentMessage() 

 to access the data of previously sent requests and received responses.

-
Throws HttpMalformedHeaderException.

+
Note that the internal history is immutable, that means that any changes

+you make the the message list won't affect a history message list newly 

+created by another call to HttpRequest::getHistory().

+
Throws HttpMalformedHeaderException, HttpEncodingException.

 
void HttpRequest::clearHistory()

 
Clear the history.

 
HttpMessage HttpRequest::send()

 
Send the HTTP request.

 
Returns the received response as HttpMessage object.

+
NOTE: While an exception may be thrown, the transfer could have succeeded 

+at least partially, so you might want to check the return values of various

+HttpRequest::getResponse*() methods.

 
Throws HttpRuntimeException, HttpRequestException, 

 HttpMalformedHeaderException, HttpEncodingException.

 
GET example:


@@ -707,7 +793,7 @@ HttpRequestPoolException, HttpMalformedHeaderException.

 
protected bool HttpRequestPool::socketPerform()

 
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;
    }
} 
?>

 

 

 
protected bool HttpRequestPool::socketSelect()

@@ -723,6 +809,16 @@ HttpRequestPoolException, HttpMalformedHeaderException.

 
Implements Iterator::next().

 
void HttpRequestPool::rewind()

 
Implements Iterator::rewind().

+
int HttpRequestPool::count()

+
Implements Countable.

+
Returns the number of attached HttpRequest objects.

+
array HttpRequestPool::getAttachedRequests()

+
Get attached HttpRequest objects.

+
Returns an array containing all currently attached HttpRequest objects.

+
array HttpRequestPool::getFinishedRequests()

+
Get attached HttpRequest objects that already have finished their work.

+
Returns an array containing all attached HttpRequest objects that

+already have finished their work.

 

 
http_response_object.c

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

@@ -891,6 +987,8 @@ http.cache_log is set.

 
 
  • http_negotiate_charset
 
    • 
+
  • http_negotiate_content_type
+
    • 
 
  • http_send_status
 
    • 
 
  • http_send_last_modified
@@ -953,6 +1051,20 @@ http.cache_log is set.
    
 
    • 
 
  • http_build_query
 
    • 
+
  • http_gzencode
+
    • 
+
  • http_gzdecode
+
    • 
+
  • http_deflate
+
    • 
+
  • http_inflate
+
    • 
+
  • http_compress
+
    • 
+
  • http_uncompress
+
    • 
+
  • http_support
+
    • 
 
 
 
  • http_message_object.c
@@ -977,6 +1089,9 @@ http.cache_log is set.
    
 
  • HttpMessage::getParentMessage()
    • 
 
  • HttpMessage::send()
    • 
 
  • HttpMessage::toString()
    • 
+
  • HttpMessage::count()
    • 
+
  • HttpMessage::serialize()
    • 
+
  • HttpMessage::unserialize()
    • 
 
 
 
@@ -1044,6 +1159,9 @@ http.cache_log is set.
    
 
  • HttpRequestPool::key()
    • 
 
  • HttpRequestPool::next()
    • 
 
  • HttpRequestPool::rewind()
    • 
+
  • HttpRequestPool::count()
    • 
+
  • HttpRequestPool::getAttachedRequests()
    • 
+
  • HttpRequestPool::getFinishedRequests()
    • 
 
 
 
@@ -1083,7 +1201,7 @@ http.cache_log is set.
    
 
 
 
-    
    Generated at: Wed, 05 Oct 2005 15:34:24 +0000
    
+    
    Generated at: Mon, 21 Nov 2005 16:56:18 +0100