X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=docs%2Ffunctions.html;h=7139f2a924e9d612ae200d32a9a2f7dcef53f867;hp=d2ceb4f1856686caafa4c6f18eaddafe91e56ad0;hb=24d2d35cd00eca44a97a6b11340c2790421216fa;hpb=b637b6a7dc7e76df505a6f039994ed74c9f8ea1e diff --git a/docs/functions.html b/docs/functions.html index d2ceb4f..7139f2a 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.

-

string http_build_url(mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]])

+

string http_build_url([mixed url[, mixed parts[, int flags = HTTP_URL_REPLACE[, array &new_url]]]])

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

@@ -276,12 +276,12 @@ several consecutive HTTP messages.

 <?php
$headers = "content-type: text/html; charset=UTF-8\r\n".
           "Server: Funky/1.0\r\n".
           "Set-Cookie: foo=bar\r\n".
           "Set-Cookie: baz=quux\r\n".
           "Folded: works\r\n\ttoo\r\n";
print_r(http_parse_headers($headers));

Array
(
    [Content-Type] => text/html; chatset=UTF-8
    [Server] => Funky/1.0
    [Set-Cookie] => Array
        (
            [0] => foo=bar
            [1] => baz=quux
        )
    [Folded] => works
        too 
) 
?>

- +

Parses HTTP cookies like sent in a response into a struct.

Expects a string as parameter containing the value of a Set-Cookie response header.

-

Returns an stdClass object with the cookie params as properties on success or FALSE on failure.

+

Returns an stdClass olike shown in the example on success or FALSE on failure.

Example:



-<?php
print_r(http_parse_cookie("foo=bar; path=/"));

stdClass Object
(
    [name] => foo
    [value] => bar
    [path] => /
)
?>

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

array http_get_request_headers(void)

@@ -310,6 +310,7 @@ array where the following keys will be recognized:

 - redirect:
                      redirects to a different host

  - proxyhost:        string, proxy host in "host[:port]" format

  - proxyport:        int, use another proxy port as specified in proxyhost

+ - proxytype:        int, HTTP_PROXY_HTTP, SOCKS4 or SOCKS5

  - proxyauth:        string, proxy credentials in "user:pass" format

  - proxyauthtype:    int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM

  - httpauth:         string, http credentials in "user:pass" format

@@ -323,9 +324,15 @@ array where the following keys will be recognized:
 - redirect:
                      like array("header" => "value")

  - 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

  - resume:           int, byte offset to start the download from;

                      if the server supports ranges

+ - range:            array, array of arrays, each containing two integers,

+                     specifying the ranges to download if server support is

+                     given; only recognized if the resume option is empty

  - maxfilesize:      int, maximum file size that should be downloaded;

                      has no effect, if the size of the requested entity is not known

  - lastmodified:     int, timestamp for If-(Un)Modified-Since header

@@ -333,6 +340,8 @@ array where the following keys will be recognized:
 - redirect:
  - timeout:          int, seconds the request may take

  - connecttimeout:   int, seconds the connect may take

  - onprogress:       mixed, progress callback

+ - interface:        string, outgoing network interface (ifname, ip or hostname)

+ - portrange:        array, 2 integers specifying outgoing portrange to try

  - ssl:              array, with the following options:

                      cert:        string, path to certificate

                      certtype:    string, type of certificate

@@ -352,7 +361,7 @@ array where the following keys will be recognized:
 - redirect:
 

 
The optional third parameter will be filled with some additional information

 in form of an associative array, if supplied, like the following example:


-<?php
array (
    'effective_url' => 'http://localhost',
    'response_code' => 403,
    'total_time' => 0.017,
    'namelookup_time' => 0.013,
    'connect_time' => 0.014,
    'pretransfer_time' => 0.014,
    'size_upload' => 0,
    'size_download' => 202,
    'speed_download' => 11882,
    'speed_upload' => 0,
    'header_size' => 145,
    'request_size' => 62,
    'ssl_verifyresult' => 0,
    'filetime' => -1,
    'content_length_download' => 202,
    'content_length_upload' => 0,
    'starttransfer_time' => 0.017,
    'content_type' => 'text/html; charset=iso-8859-1',
    'redirect_time' => 0,
    'redirect_count' => 0,
    'http_connectcode' => 0,
    'httpauth_avail' => 0,
    'proxyauth_avail' => 0,
)
?>

+<?php
array (
   'effective_url' => 'http://www.example.com/',
   'response_code' => 302,
   'connect_code' => 0,
   'filetime' => -1,
   'total_time' => 0.212348,
   'namelookup_time' => 0.038296,
   'connect_time' => 0.104144,
   'pretransfer_time' => 0.104307,
   'starttransfer_time' => 0.212077,
   'redirect_time' => 0,
   'redirect_count' => 0,
   'size_upload' => 0,
   'size_download' => 218,
   'speed_download' => 1026,
   'speed_upload' => 0,
   'header_size' => 307,
   'request_size' => 103,
   'ssl_verifyresult' => 0,
   'ssl_engines' =>
   array (
     0 => 'dynamic',
     1 => 'cswift',
     2 => 'chil',
     3 => 'atalla',
     4 => 'nuron',
     5 => 'ubsec',
     6 => 'aep',
     7 => 'sureware',
     8 => '4758cca',
   ),
   'content_length_download' => 218,
   'content_length_upload' => 0,
   'content_type' => 'text/html',
   'httpauth_avail' => 0,
   'proxyauth_avail' => 0,
   'num_connects' => 1,
   'os_errno' => 0,
   'error' => '',
 )
?>

 

 

 
Returns the HTTP response(s) as string on success, or FALSE on failure.

@@ -381,7 +390,21 @@ See http_get() for a full list of available options.

 
Expects the second parameter to be a resource referencing an already 

 opened stream, from which the data to upload should be read.

 See http_get() for a full list of available options.

-
Returns the HTTP response(s) as string on success. or FALSE on failure.

+
Returns the HTTP response(s) as string on success, or FALSE on failure.

+
string http_put_data(string url, string data[, array options[, array &info]])

+
Performs an HTTP PUT request on the supplied url.

+
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.

@@ -453,6 +476,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.

@@ -552,6 +578,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 HttpRuntimeException.

 
bool HttpMessage::send()

 
Send the Message according to its type as Response or Request.

 This provides limited functionality compared to HttpRequest and HttpResponse.

@@ -576,9 +603,13 @@ should also contain any parent messages.

 
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.

 
void HttpMessage::rewind(void)

 
Implements Iterator.

 
bool HttpMessage::valid(void)

@@ -592,7 +623,7 @@ should also contain any parent messages.

 

 
http_querystring_object.c

 
HttpQueryString

-
void HttpQueryString::__construct([bool global = true[, mixed add])

+
final void HttpQueryString::__construct([bool global = true[, mixed add])

 
Creates a new HttpQueryString object instance.

 Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.

 
string HttpQueryString::toString()

@@ -605,8 +636,16 @@ Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.
 
string HttpQueryString::set(mixed params)

 
Set query string entry/entries. NULL values will unset the variable.

-
HttpQueryString HttpQueryString::getInstance([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.

+WARNING: Don't use any character set that can contain NUL bytes like UTF-16.

+
Returns TRUE on success or FALSE on failure.

+
string HttpQueryString::serialize()

+
Implements Serializable.

+
void HttpQueryString::unserialize(string serialized)

+
Implements Serializable.

 

 
http_request_object.c

 
HttpRequest

@@ -761,6 +800,22 @@ If the parameter is empty or omitted the put file will be unset.

 
string HttpRequest::getPutFile()

 
Get previously set put file.

 
Returns a string containing the path to the currently set put file.

+
bool HttpRequest::setPutData([string put_data])

+
Set PUT data to send, overwriting previously set PUT data.

+Affects only PUT requests.

+Only either PUT data or PUT file can be used for each request.

+PUT data has higher precedence and will be used even if a PUT

+file is set.  

+
Accepts a string as parameter containing the data to upload.

+
Returns TRUE on success, or FALSE on failure.

+
bool HttpRequest::addPutData(string put_data)

+
Add PUT data, leaving previously set PUT data unchanged.

+Affects only PUT requests.

+
Expects a string as parameter containing the data to concatenate.

+
Returns TRUE on success, or FALSE on failure.

+
string HttpRequest::getPutData()

+
Get previously set PUT data.

+
Returns a string containing the currently set raw post data.

 
array HttpRequest::getResponseData()

 
Get all response data after the request has been sent.

 
Returns an associative array with the key "headers" containing an associative

@@ -776,14 +831,9 @@ If the parameter is empty or omitted all response headers will be returned.

 FALSE on failure, or an associative array containing all response headers.

 
If redirects were allowed and several responses were received, the data 

 references the last received response.

-
array HttpRequest::getResponseCookie([string name])

+
array HttpRequest::getResponseCookies([int flags[, array allowed_extras]])

 
Get response cookie(s) after the request has been sent.

-
Accepts a string as optional parameter specifying the name of the cookie to read.

-If the parameter is empty or omitted, an associative array with all received

-cookies will be returned.

-
Returns either an associative array with the cookie's name, value and any

-additional params of the cookie matching name if requested, FALSE on failure,

-or an array containing all received cookies as arrays.

+
Returns an array of stdClass objects like http_parse_cookie would return.

 
If redirects were allowed and several responses were received, the data 

 references the last received response.

 
string HttpRequest::getResponseBody()

@@ -817,7 +867,7 @@ references the last received response.

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

 to access the data of previously received responses within this request

 cycle.

-
Throws HttpException.

+
Throws HttpException, HttpRuntimeException.

 
HttpMessage HttpRequest::getRequestMessage()

 
Get sent HTTP message.

 
Returns an HttpMessage object representing the sent request.

@@ -838,16 +888,13 @@ may have made to the returned object.

 
Returns the complete web server response, including the headers in a form of a string.

 
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

-HttpRequest::$recordHistory to FALSE. 

+
If you want to record history, set the instance variable

+HttpRequest::$recordHistory to TRUE.

 
Returns an HttpMessage object representing the complete request/response

 history.

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

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

-
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.

+
Throws HttpRuntimeException.

 
void HttpRequest::clearHistory()

 
Clear the history.

 
HttpMessage HttpRequest::send()

@@ -949,6 +996,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)

@@ -970,11 +1018,13 @@ to something more appropriate than "no-cache"!

 
static bool HttpResponse::getGzip()

 
Get current gzipping setting.

 
Returns TRUE if GZip compression is enabled, else FALSE.

-
static bool HttpResponse::setCacheControl(string control[, int max_age = 0])

+
static bool HttpResponse::setCacheControl(string control[, int max_age = 0[, bool must_revalidate = true]])

 
Set a custom cache-control header, usually being "private" or "public";

 The max_age parameter controls how long the cache entry is valid on the client side.

 
Expects a string parameter containing the primary cache control setting.

-Additionally accepts an int parameter specifying the max-age setting.

+Additionally accepts an int parameter specifying the max-age setting.

+Accepts an optional third bool parameter indicating whether the cache

+must be revalidated every request.

 
Returns TRUE on success, or FALSE if control does not match one of

 "public" , "private" or "no-cache".

 
Throws HttpInvalidParamException if http.only_exceptions is TRUE.

@@ -1161,6 +1211,12 @@ http.cache_log is set.

 
 
  • http_put_stream
 
    • 
+
  • http_put_data
+
    • 
+
  • http_request
+
    • 
+
  • http_request_body_encode
+
    • 
 
  • http_request_method_register
 
    • 
 
  • http_request_method_unregister
@@ -1192,6 +1248,7 @@ http.cache_log is set.
    
 
    • 
 
  • http_inflatestream_object.c
 
 
    • 
@@ -1281,9 +1342,12 @@ http.cache_log is set.
    
 
  • HttpRequest::getPostFiles()
    • 
 
  • HttpRequest::setPutFile()
    • 
 
  • HttpRequest::getPutFile()
    • 
+
  • HttpRequest::setPutData()
    • 
+
  • HttpRequest::addPutData()
    • 
+
  • HttpRequest::getPutData()
    • 
 
  • HttpRequest::getResponseData()
    • 
 
  • HttpRequest::getResponseHeader()
    • 
-
  • HttpRequest::getResponseCookie()
    • 
+
  • HttpRequest::getResponseCookies()
    • 
 
  • HttpRequest::getResponseBody()
    • 
 
  • HttpRequest::getResponseCode()
    • 
 
  • HttpRequest::getResponseStatus()
    • 
@@ -1355,7 +1419,7 @@ http.cache_log is set.
    
 
 
 
-    
    Generated at: Mon, 06 Feb 2006 16:10:01 +0100
    
+    
    Generated at: Sat, 22 Apr 2006 23:03:59 +0200