X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Ffunctions.html;h=25b14cc58520389e19bc74f074de10c25d7fde1b;hb=fb5d0ef47f1f54dad0efa1f091324e3d7d18050b;hp=7139f2a924e9d612ae200d32a9a2f7dcef53f867;hpb=24d2d35cd00eca44a97a6b11340c2790421216fa;p=m6w6%2Fext-http diff --git a/docs/functions.html b/docs/functions.html index 7139f2a..25b14cc 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -198,19 +198,19 @@ requested last modification date is not between the calculated timespan,
the Last-Modified header is updated and the actual body will be sent.

Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.

A log entry will be written to the cache log if the INI entry
-http.cache_log is set and the cache attempt was successful.

+http.log.cache is set and the cache attempt was successful.

bool http_cache_etag([string etag])

Attempts to cache the sent entity by its ETag, either supplied or generated
-by the hash algorithm specified by the INI setting "http.etag_mode".

+by the hash algorithm specified by the INI setting "http.etag.mode".

If the clients "If-None-Match" header matches the supplied/calculated
ETag, the body is considered cached on the clients side and
a "304 Not Modified" status code is issued.

Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.

A log entry is written to the cache log if the INI entry
-"http.cache_log" is set and the cache attempt was successful.

+"http.log.cache" is set and the cache attempt was successful.

string ob_etaghandler(string data, int mode)

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

+the hash algorithm specified with the INI setting "http.etag.mode".

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
@@ -243,7 +243,7 @@ if the client doesn't redirect immediately, and the request method was
another one than HEAD.

Returns FALSE on failure, or *exits* on success.

A log entry will be written to the redirect log, if the INI entry
-"http.redirect_log" is set and the redirect attempt was successful.

+"http.log.redirect" is set and the redirect attempt was successful.

bool http_send_data(string data)

Sends raw data with support for (multiple) range requests.

Returns TRUE on success, or FALSE on failure.

@@ -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
)
?>

+

object http_parse_params(string param[, int flags = HTTP_PARAMS_DEFAULT])

+

Parse parameter list.

array http_get_request_headers(void)

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,

@@ -703,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.

@@ -1191,6 +1202,8 @@ http.cache_log is set.

 
 
  • http_parse_cookie
 
    • 
+
  • http_parse_params
+
    • 
 
  • http_get_request_headers
 
    • 
 
  • http_get_request_body
@@ -1322,6 +1335,8 @@ http.cache_log is set.
    
 
  • HttpRequest::setCookies()
    • 
 
  • HttpRequest::addCookies()
    • 
 
  • HttpRequest::getCookies()
    • 
+
  • HttpRequest::enableCookies()
    • 
+
  • HttpRequest::resetCookies()
    • 
 
  • HttpRequest::setUrl()
    • 
 
  • HttpRequest::getUrl()
    • 
 
  • HttpRequest::setMethod()
    • 
@@ -1419,7 +1434,7 @@ http.cache_log is set.
    
 
 
 
-    
    Generated at: Sat, 22 Apr 2006 23:03:59 +0200
    
+    
    Generated at: Sun, 28 May 2006 17:55:39 +0200