This function returns a valid HTTP date regarding RFC 822/1123
+
Compose a valid HTTP date regarding RFC 1123
looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
This function returns an absolute URI constructed from url.
-If the url is already abolute but a different proto was supplied,
-only the proto part of the URI will be updated. If url has no
-path specified, the path of the current REQUEST_URI will be taken.
-The host will be taken either from the Host HTTP header of the client
-the SERVER_NAME or just localhost if prior are not available.
-
-Some examples:
url = "page.php" => http://www.example.com/current/path/page.php
- url = "/page.php" => http://www.example.com/page.php
- url = "/page.php", proto = "https" => https://www.example.com/page.php
+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]]]])
+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
+first argument. Accepts an optional third integer parameter, which is a bitmask of
+binary or'ed HTTP_URL_* constants. The optional fourth parameter will be filled
+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 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
+ - HTTP_URL_STRIP_PORT: no explicit port will be set in the result
+ - HTTP_URL_STRIP_PATH: the path part will not appear in the result
+ - HTTP_URL_STRIP_QUERY: no query string will be present in the result
+ - HTTP_URL_STRIP_FRAGMENT: no fragment will be present in the result
string http_negotiate_language(array supported[, string default = 'en-US'])
+Example:
+
+<?php
// ftp://ftp.example.com/pub/files/current/?a=b&a=c
echo http_build_url("http://user@www.example.com/pub/index.php?a=b#files",
array(
"scheme" => "ftp",
"host" => "ftp.example.com",
"path" => "files/current/",
"query" => "a=c"
),
HTTP_URL_STRIP_AUTH | HTTP_URL_JOIN_PATH | HTTP_URL_JOIN_QUERY | HTTP_URL_STRIP_FRAGMENT
);
?>
+
+Returns the new URL as string on success or FALSE on failure. +string http_build_str(array query [, string prefix[, string arg_separator]])
+Opponent to parse_str().
+Expects an array as first argument which represents the parts of the query string to build.
+
+Accepts a string as optional second parameter containing a top-level prefix to use.
+The optional third parameter should specify an argument separator to use (by default the
+INI setting arg_separator.output will be used, or "&" if neither is set).Returns the built query as string on success or FALSE on failure.
+string http_negotiate_language(array supported[, array &result])
This function negotiates the clients preferred language based on its
-Accept-Language HTTP header. It returns the negotiated language or
-the default language if none match.
-
-The qualifier is recognized and languages without qualifier are rated highest.
-
-The supported parameter is expected to be an array having
-the supported languages as array values.
-
-Example:-
-<?php
$langs = array(
'en-US',// default
'fr',
'fr-FR',
'de',
'de-DE',
'de-AT',
'de-CH',
);
include './langs/'. http_negotiate_language($langs) .'.php';
?>
-
-
-
-string http_negotiate_charset(array supported[, string default = 'iso-8859-1'])
+Accept-Language HTTP header. The qualifier is recognized and languages
+without qualifier are rated highest. The qualifier will be decreased by
+10% for partial matches (i.e. matching primary language). +Expects an array as parameter containing the supported languages as values.
+
+If the optional second parameter is supplied, it will be filled with an
+array containing the negotiation results.Returns the negotiated language or the default language (i.e. first array entry)
+
+if none match.Example:
++
+<?php
$langs = array(
'en-US',// default
'fr',
'fr-FR',
'de',
'de-DE',
'de-AT',
'de-CH',
);
include './langs/'. http_negotiate_language($langs, $result) .'.php';
print_r($result);
?>
+string http_negotiate_charset(array supported[, array &result])
This function negotiates the clients preferred charset based on its
-Accept-Charset HTTP header. It returns the negotiated charset or
-the default charset if none match.
-
-The qualifier is recognized and charset without qualifier are rated highest.
-
-The supported parameter is expected to be an array having
-the supported charsets as array values.
-
-Example:+Accept-Charset HTTP header. The qualifier is recognized and charsets
-<?php
$charsets = array(
'iso-8859-1', // default
'iso-8859-2',
'iso-8859-15',
'utf-8'
);
$pref = http_negotiate_charset($charsets);
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');
}
?>
-
-
-
-
+without qualifier are rated highest. +Expects an array as parameter containing the supported charsets as values.
+
+If the optional second parameter is supplied, it will be filled with an
+array containing the negotiation results.Returns the negotiated charset or the default charset (i.e. first array entry)
+
+if none match.Example:
++
+<?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 containing 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.
+Returns TRUE on success or FALSE on failure.
bool http_send_last_modified([int timestamp])
-This converts the given timestamp to a valid HTTP date and
+Send a "Last-Modified" header with a valid HTTP date.
+Accepts a unix timestamp, converts it to a valid HTTP date and
+omitted, the current time will be sent. +
sends it as "Last-Modified" HTTP header. If timestamp is
-omitted, current time is sent.Returns TRUE on success or FALSE on failure.
bool http_send_content_type([string content_type = 'application/x-octetstream'])
-Sets the content type.
+Send the Content-Type of the sent entity. This is particularly important
+
+if you use the http_send() API.Accepts an optional string parameter containing the desired content type
+
+(primary/secondary).Returns TRUE on success or FALSE on failure.
bool http_send_content_disposition(string filename[, bool inline = false])
-Set the Content Disposition. The Content-Disposition header is very useful
+Send the Content-Disposition. The Content-Disposition header is very useful
-
if the data actually sent came from a file or something similar, that should
be "saved" by the client/user (i.e. by browsers "Save as..." popup window).bool http_match_modified([int timestamp[, for_range = false]])
-Matches the given timestamp against the clients "If-Modified-Since" resp.
-
-"If-Unmodified-Since" HTTP headers.bool http_match_etag(string etag[, for_range = false])
-This matches the given ETag against the clients
+
-"If-Match" resp. "If-None-Match" HTTP headers.Expects a string parameter specifying the file name the "Save as..." dialog
+
+should display. Optionally accepts a bool parameter, which, if set to true
+and the user agent knows how to handle the content type, will probably not
+cause the popup window to be shown.Returns TRUE on success or FALSE on failure.
+bool http_match_modified([int timestamp[, bool for_range = false]])
+Matches the given unix timestamp against the clients "If-Modified-Since"
+
+resp. "If-Unmodified-Since" HTTP headers.Accepts a unix timestamp which should be matched. Optionally accepts an
+
+additional bool parameter, which if set to true will check the header
+usually used to validate HTTP ranges. If timestamp is omitted, the
+current time will be used.Returns TRUE if timestamp represents an earlier date than the header,
+
+else FALSE.bool http_match_etag(string etag[, bool for_range = false])
+Matches the given ETag against the clients "If-Match" resp.
+
+"If-None-Match" HTTP headers.Expects a string parameter containing the ETag to compare. Optionally
+
+accepts a bool parameter, which, if set to true, will check the header
+usually used to validate HTTP ranges.Returns TRUE if ETag matches or the header contained the asterisk ("*"),
+else FALSE.bool http_cache_last_modified([int timestamp_or_expires]])
+Attempts to cache the sent entity by its last modification date.
+Accepts a unix timestamp as parameter which is handled as follows:
If timestamp_or_expires is greater than 0, it is handled as timestamp
+
and will be sent as date of last modification. If it is 0 or omitted,
the current time will be sent as Last-Modified date. If it's negative,
it is handled as expiration time in seconds, which means that if the
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.log.cache is set and the cache attempt was successful.bool http_cache_etag([string etag])
-This function attempts to cache the HTTP body based on an ETag,
-either supplied or generated through calculation of the MD5
-checksum of the output (uses output buffering).
-
-If clients "If-None-Match" header matches the supplied/calculated
+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".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.log.cache" is set and the cache attempt was successful.string ob_etaghandler(string data, int mode)
-For use with ob_start().
-void http_throttle(double sec[, long bytes = 2097152])
-Use with http_send() API.
-
-Example:++
+For use with ob_start(). Output buffer handler generating an ETag with
+
+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
+resp. thread until the entity has been completely sent, though.Expects a double parameter specifying the seconds too sleep() after
+
+each chunk sent. Additionally accepts an optional int parameter
+representing the chunk size in bytes.Example:
-
<?php
// ~ 20 kbyte/s
# http_throttle(1, 20000);
# http_throttle(0.5, 10000);
# http_throttle(0.1, 2000);
http_send_file('document.pdf');
?>
-
-
-
-void http_redirect([string url[, array params[, bool session,[ bool permanent]]]])
-Redirect to a given url.
-The supplied url will be expanded with http_absolute_uri(), the params array will
+void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
+Redirect to the given url.
+if session is true. +
+
+The supplied url will be expanded with http_build_url(), the params array will
be treated with http_build_query() and the session identification will be appended
-if session is true.
-
-Depending on permanent the redirection will be issued with a permanent
-("301 Moved Permanently") or a temporary ("302 Found") redirection
-status code.
-
-To be RFC compliant, "Redirecting to URI." will be displayed,
-if the client doesn't redirect immediatly.The HTTP response code will be set according to status.
+
+You can use one of the following constants for convenience:
+ - HTTP_REDIRECT 302 Found for GET/HEAD, else 303 See Other
+ - HTTP_REDIRECT_PERM 301 Moved Permanently
+ - HTTP_REDIRECT_FOUND 302 Found
+ - HTTP_REDIRECT_POST 303 See Other
+ - HTTP_REDIRECT_PROXY 305 Use Proxy
+ - HTTP_REDIRECT_TEMP 307 Temporary RedirectPlease see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
+
+for which redirect response code to use in which situation.To be RFC compliant, "Redirecting to URL." will be displayed,
+
+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.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.
bool http_send_file(string file)
Sends a file with support for (multiple) range requests.
+Expects a string parameter referencing the file to send.
+Returns TRUE on success, or FALSE on failure.
bool http_send_stream(resource stream)
Sends an already opened stream with support for (multiple) range requests.
+Expects a resource parameter referencing the stream to read from.
+Returns TRUE on success, or FALSE on failure.
string http_chunked_decode(string encoded)
-This function decodes a string that was HTTP-chunked encoded.
+
-Returns false on failure.Decodes a string that was HTTP-chunked encoded.
+Expects a chunked encoded string as parameter.
+Returns the decoded string on success or FALSE on failure.
object http_parse_message(string message)
-Parses (a) http_message(s) into a simple recursive object structure:
+
+Parses (a) http_message(s) into a simple recursive object structure.
+Expects a string parameter containing a single HTTP message or
+
+several consecutive HTTP messages.Returns an hierarchical object structure of the parsed messages.
+Example:
+
<?php
print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
stdClass object
(
[type] => 2
[httpVersion] => 1.1
[responseCode] => 200
[headers] => Array
(
[Content-Length] => 3
[Server] => Apache
)
[body] => Hi!
[parentMessage] => stdClass object
(
[type] => 2
[httpVersion] => 1.1
[responseCode] => 302
[headers] => Array
(
[Content-Length] => 0
[Location] => ...
)
[body] =>
[parentMessage] => ...
)
)
?>
-
-
-
-array http_parse_headers(string header)
- +Parses HTTP headers into an associative array.
+Expects a string parameter containing HTTP headers.
+Returns an array on success, or FALSE on failure.
+Example:
++
+<?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
)
?>
+object http_parse_cookie(string cookie[, int flags[, array allowed_extras]])
+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 olike shown in the example on success or FALSE on failure.
+Example:
++
+<?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.
string http_get_request_body(void)
Get the raw request body (e.g. POST or PUT data).
+This function can not be used after http_get_request_body_stream()
+
+if the request method was another than POST.Returns the raw request body as string on success or NULL on failure.
+resource http_get_request_body_stream(void)
+Create a stream to read the raw request body (e.g. POST or PUT data).
+This function can only be used once if the request method was another than POST.
+Returns the raw request body as stream on success or NULL on failure.
bool http_match_request_header(string header, string value[, bool match_case = false])
Match an incoming HTTP header.
+Expects two string parameters representing the header name (case-insensitive)
+
+and the header value that should be compared. The case sensitivity of the
+header value depends on the additional optional bool parameter accepted.Returns TRUE if header value matches, else FALSE.
string http_get(string url[, array options[, array &info]])
-Performs an HTTP GET request on the supplied url.
-
-The second parameter is expected to be an associative
+Performs an HTTP GET request on the supplied url.
+The second parameter, if set, is expected to be an associative
array where the following keys will be recognized:- redirect: int, whether and how many redirects to follow
- unrestrictedauth: bool, whether to continue sending credentials on
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
- httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
- 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
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)
- cookiestore: string, path to a file where cookies are/will be stored
+ - 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,
+ 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
+ - etag: string, quoted etag for If-(None-)Match header
- timeout: int, seconds the request may take
- connecttimeout: int, seconds the connect may take
- - onprogress: mixed, progress callbackThe optional third parameter will be filled with some additional information
-in form af 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,
)
?>
-
-
-
+ - 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
+ certpasswd: string, password for certificate
+ key: string, path to key
+ keytype: string, type of key
+ keypasswd: string, pasword for key
+ engine: string, ssl engine to use
+ version: int, ssl version to use
+ verifypeer: bool, whether to verify the peer
+ verifyhost: bool whether to verify the host
+ cipher_list: string, list of allowed ciphers
+ cainfo: string
+ capath: string
+ random_file: string
+ egdsocket: string
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://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.
string http_head(string url[, array options[, array &info]])
-Performs an HTTP HEAD request on the suppied url.
+
-Returns the HTTP response as string.
-See http_get() for a full list of available options.Performs an HTTP HEAD request on the supplied url.
+See http_get() for a full list of available parameters and options.
+Returns the HTTP response as string on success, or FALSE on failure.
string http_post_data(string url, string data[, array options[, array &info]])
-Performs an HTTP POST request, posting data.
+
-Returns the HTTP response as string.
-See http_get() for a full list of available options.Performs an HTTP POST request on the supplied url.
+Expects a string as second parameter containing the pre-encoded post data.
+See http_get() for a full list of available parameters and options.
+
+Returns the HTTP response(s) as string on success, or FALSE on failure.string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
-Performs an HTTP POST request, posting www-form-urlencoded array data.
+
-Returns the HTTP response as string.
-See http_get() for a full list of available options.Performs an HTTP POST request on the supplied url.
+Expects an associative array as second parameter, which will be
+
+www-form-urlencoded. 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_put_file(string url, string file[, array options[, array &info]])
-Performs an HTTP PUT request, uploading file.
-Returns the HTTP response as string.
+Performs an HTTP PUT request on the supplied url.
+Expects the second parameter to be a string referencing the file 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_put_stream(string url, resource stream[, array options[, array &info]])
-Performs an HTTP PUT request, uploading stream.
-Returns the HTTP response as string.
+Performs an HTTP PUT request on the supplied url.
+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.
+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.long http_request_method_register(string method)
+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.
+Returns the ID of the request method on success, or FALSE on failure.
bool http_request_method_unregister(mixed method)
Unregister a previously registered custom request method.
-long http_request_method_exists(mixed method)
+Expects either the request method name or ID.
+Returns TRUE on success, or FALSE on failure.
+int http_request_method_exists(mixed method)
Check if a request method is registered (or available by default).
-string http_request_method_name(long method)
+Expects either the request method name or ID as parameter.
+Returns TRUE if the request method is known, else FALSE.
+string http_request_method_name(int method)
Get the literal string representation of a standard or registered request method.
-string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
-Generates a form-encoded query string from an associative array or object.
+Expects the request method ID as parameter.
+Returns the request method name as string on success, or FALSE on failure.
+string http_deflate(string data[, int flags = 0])
+Compress data with gzip, zlib AKA deflate or raw deflate encoding.
+Expects the first parameter to be a string containing the data that should
+
+be encoded.Returns the encoded string on success, or NULL on failure.
+string http_inflate(string data)
+Decompress data compressed with either gzip, deflate AKA zlib or raw
+
+deflate encoding.Expects a string as parameter containing the compressed data.
+Returns the decoded string on success, or NULL on failure.
+string ob_deflatehandler(string data, int mode)
+For use with ob_start(). The deflate output buffer handler can only be used once.
+
+It conflicts with ob_gzhandler and zlib.output_compression as well and should
+not be used after ext/mbstrings mb_output_handler and ext/sessions URL-Rewriter (AKA
+session.use_trans_sid).string ob_inflatehandler(string data, int mode)
+For use with ob_start(). Same restrictions as with ob_deflatehandler apply.
+int http_support([int feature = 0])
+Check for feature that require external libraries.
+Accepts 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.
Creates a new HttpDeflateStream object instance.
+Accepts an optional int parameter specifying how to initialize the deflate stream.
+Passes more data through the deflate stream.
+Expects a string parameter containing (a part of) the data to deflate.
+Returns deflated data on success or FALSE on failure.
+Flushes the deflate stream.
+Returns some deflated data as string on success or FALSE on failure.
+Finalizes the deflate stream. The deflate stream can be reused after finalizing.
+Returns the final part of deflated data.
+Creates a new HttpInflateStream object instance.
+Accepts an optional int parameter specifying how to initialize the inflate stream.
+Passes more data through the inflate stream.
+Expects a string parameter containing (a part of) the data to inflate.
+Returns inflated data on success or FALSE on failure.
+Flush the inflate stream.
+Returns some inflated data as string on success or FALSE on failure.
+Finalizes the inflate stream. The inflate stream can be reused after finalizing.
+Returns the final part of inflated data.
+Instantiate a new HttpMessage object.
-Create an HttpMessage object from a string.
+Accepts an optional string parameter containing a single or several
+consecutive HTTP messages. The constructed object will actually
+represent the *last* message of the passed string. If there were
+prior messages, those can be accessed by HttpMessage::getParentMessage().
Throws HttpMalformedHeaderException.
+Create an HttpMessage object from a string. Kind of a static constructor.
+Expects a string parameter containing a single or several consecutive
+HTTP messages. Accepts an optional string parameter specifying the class to use.
Returns an HttpMessage object on success or NULL on failure.
+Throws HttpMalformedHeadersException.
Get the body of the parsed Message.
+Get the body of the parsed HttpMessage.
+Returns the message body as string.
+Set the body of the HttpMessage.
+NOTE: Don't forget to update any headers accordingly.
Expects a string parameter containing the new body of the message.
+Get message header.
+Returns the header value on success or NULL if the header does not exist.
Get Message Headers.
+Returns an associative array containing the messages HTTP headers.
Sets new headers.
+Expects an associative array as parameter containing the new HTTP headers,
+which will replace *all* previous HTTP headers of the message.
Add headers. If append is true, headers with the same name will be separated, else overwritten.
-Expects an associative array as parameter containing the additional HTTP headers
+to add to the messages existing headers. If the optional bool parameter is true,
+and a header with the same name of one to add exists already, this respective
+header will be converted to an array containing both header values, otherwise
+it will be overwritten with the new header value.
Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
-Returns the HttpMessage::TYPE.
+Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
-Expects an int parameter, the HttpMessage::TYPE.
+Get the Response Code of the Message.
-Set the response code of an HTTP Response Message.
-Returns false if the Message is not of type HTTP_MSG_RESPONSE,
-or if the response code is out of range (100-510).
Returns the HTTP response code if the message is of type
+HttpMessage::TYPE_RESPONSE, else FALSE.
Set the response code of an HTTP Response Message.
+Expects an int parameter with the HTTP response code.
+Returns TRUE on success, or FALSE if the message is not of type
+HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510).
Get the Response Status of the message (i.e. the string following the response code).
+Returns the HTTP response status string if the message is of type
+HttpMessage::TYPE_RESPONSE, else FALSE.
Set the Response Status of the HTTP message (i.e. the string following the response code).
+Expects a string parameter containing the response status text.
+Returns TRUE on success or FALSE if the message is not of type
+HttpMessage::TYPE_RESPONSE.
Get the Request Method of the Message.
-Returns false if the Message is not of type HTTP_MSG_REQUEST.
Get the Request Method of the Message.
+Returns the request method name on success, or FALSE if the message is
+not of type HttpMessage::TYPE_REQUEST.
Set the Request Method of the HTTP Message.
-Returns false if the Message is not of type HTTP_MSG_REQUEST.
Get the Request URI of the Message.
-Set the Request URI of the HTTP Message.
-Returns false if the Message is not of type HTTP_MSG_REQUEST,
-or if paramtere URI was empty.
Set the Request Method of the HTTP Message.
+Expects a string parameter containing the request method name.
+Returns TRUE on success, or FALSE if the message is not of type
+HttpMessage::TYPE_REQUEST or an invalid request method was supplied.
Get the Request URL of the Message.
+Returns the request url as string on success, or FALSE if the message
+is not of type HttpMessage::TYPE_REQUEST.
Set the Request URL of the HTTP Message.
+Expects a string parameters containing the request url.
+Returns TRUE on success, or FALSE if the message is not of type
+HttpMessage::TYPE_REQUEST or supplied URL was empty.
Get the HTTP Protocol Version of the Message.
+Returns the HTTP protocol version as string.
Set the HTTP Protocol version of the Message.
-Returns false if version is invalid (1.0 and 1.1).
Set the HTTP Protocol version of the Message.
+Expects a string parameter containing the HTTP protocol version.
+Returns TRUE on success, or FALSE if supplied version is out of range (1.0/1.1).
+Attempts to guess the content type of supplied payload through libmagic.
+Expects a string parameter specifying the magic.mime database to use.
+Additionally accepts an optional int parameter, being flags for libmagic.
Returns the guessed content type on success, or FALSE on failure.
+Throws HttpRuntimeException, HttpInvalidParamException
+if http.only_exceptions is TRUE.
Get parent Message.
+Returns the parent HttpMessage on success, or NULL if there's none.
+Throws HttpRuntimeException.
Send the Message according to its type as Response or Request.
-Send the Message according to its type as Response or Request.
+This provides limited functionality compared to HttpRequest and HttpResponse.
Returns TRUE on success, or FALSE on failure.
+Get the string representation of the Message.
+Accepts a bool parameter which specifies whether the returned string
+should also contain any parent messages.
Returns the full message as string.
+Creates an object regarding to the type of the message.
+Returns either an HttpRequest or HttpResponse object on success, or NULL on failure.
+Throws HttpRuntimeException, HttpMessageTypeException, HttpHeaderException.
+Implements Countable.
+Returns the number of parent messages + 1.
+Implements Serializable.
+Returns the serialized representation of the HttpMessage.
+Implements Serializable.
+Re-constructs the HttpMessage based upon the serialized string.
+Returns a clone of an HttpMessage object detached from any parent messages.
+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.
+Reorders the message chain in reverse order.
+Returns the most parent HttpMessage object.
+Implements Iterator.
+Implements Iterator.
+Implements Iterator.
+Implements Iterator.
+Implements Iterator.
Creates a new HttpQueryString object instance.
+Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.
Returns the string representation.
+Returns the array representation.
+Get (part of) the query string.
+The type parameter is either one of the HttpQueryString::TYPE_* constants or a type abbreviation like
+"b" for bool, "i" for int, "f" for float, "s" for string, "a" for array and "o" for a stdClass object.
Set query string entry/entries. NULL values will unset the variable.
+Copies the query string object and sets provided params at the clone.
+This is basically shorthand for:
++
+<?php
$newQS = new HttpQueryString(false, $oldQS);
$newQS->set($other_params);
?>
+
Get a single instance (differentiates between the global setting).
+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.
+Implements Serializable.
+Implements Serializable.
+Implements ArrayAccess.
+Implements ArrayAccess.
+Implements ArrayAccess.
+Implements ArrayAccess.
+Instantiate a new HttpRequest object which can be used to issue HEAD, GET
-and POST (including posting files) HTTP requests.
Destroys the HttpRequest object.
+Instantiate a new HttpRequest object.
+Accepts a string as optional parameter containing the target request url.
+Additionally accepts an optional int parameter specifying the request method
+to use and an associative array as optional third parameter which will be
+passed to HttpRequest::setOptions().
Throws HttpException.
Set the request options to use. See http_get() for a full list of available options.
+Accepts an array as optional parameters, which values will overwrite the
+currently set request options. If the parameter is empty or omitted,
+the options of the HttpRequest object will be reset.
Returns TRUE on success, or FALSE on failure.
Get currently set options.
+Returns an associative array containing currently set options.
Set SSL options.
+Accepts an associative array as parameter containing any SSL specific options.
+If the parameter is empty or omitted, the SSL options will be reset.
Returns TRUE on success, or FALSE on failure.
Set additional SSL options.
+Expects an associative array as parameter containing additional SSL specific options.
+Returns TRUE on success, or FALSE on failure.
Get previously set SSL options.
+Returns an associative array containing any previously set SSL options.
Add request header name/value pairs.
+Expects an associative array as parameter containing additional header
+name/value pairs.
Returns TRUE on success, or FALSE on failure.
Set request header name/value pairs.
+Accepts an associative array as parameter containing header name/value pairs.
+If the parameter is empty or omitted, all previously set headers will be unset.
Returns TRUE on success, or FALSE on failure.
Get previously set request headers.
+Returns an associative array containing all currently set headers.
Set cookies.
+Accepts an associative array as parameter containing cookie name/value pairs.
+If the parameter is empty or omitted, all previously set cookies will be unset.
Returns TRUE on success, or FALSE on failure.
Add cookies.
+Expects an associative array as parameter containing any cookie name/value
+pairs to add.
Returns TRUE on success, or FALSE on failure.
Get previously set cookies.
+Returns an associative array containing any previously set cookies.
+Enable automatic sending of received cookies.
+Note that cuutomly set cookies will be sent anyway.
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.
Set the request URL.
+Expects a string as parameter specifying the request url.
+Returns TRUE on success, or FALSE on failure.
Get the previously set request URL.
-Set the request methods; one of the HTTP_HEAD, HTTP_GET or
-HTTP_POST constants.
Returns the currently set request url as string.
+Set the request method.
+Expects an int as parameter specifying the request method to use.
+In PHP 5.1+ HttpRequest::METH_*, otherwise the HTTP_METH_* constants can be used.
Returns TRUE on success, or FALSE on failure.
+Get the previously set request method.
+Returns the currently set request method.
Set the content type the post request should have.
-Use this only if you know what you're doing.
Set the content type the post request should have.
+Expects a string as parameters containing the content type of the request
+(primary/secondary).
Returns TRUE on success, or FALSE if the content type does not seem to
+contain a primary and a secondary part.
Get the previously content type.
+Returns the previously set content type as string.
Set the URL query parameters to use.
-Overwrites previously set query parameters.
+
Set the URL query parameters to use, overwriting previously set query parameters.
Affects any request types.
Accepts a string or associative array parameter containing the pre-encoded
+query string or to be encoded query fields. If the parameter is empty or
+omitted, the query data will be unset.
Returns TRUE on success, or FALSE on failure.
Get the current query data in form of an urlencoded query string.
+Returns a string containing the urlencoded query.
Add parameters to the query parameter list.
+
Add parameters to the query parameter list, leaving previously set unchanged.
Affects any request type.
Expects an associative array as parameter containing the query fields to add.
+Returns TRUE on success, or FALSE on failure.
Adds POST data entries.
-Affects only POST requests.
Adds POST data entries, leaving previously set unchanged, unless a
+post entry with the same name already exists.
+Affects only POST and custom requests.
Expects an associative array as parameter containing the post fields.
+Returns TRUE on success, or FALSE on failure.
Set the POST data entries.
-Overwrites previously set POST data.
-Affects only POST requests.
Set the POST data entries, overwriting previously set POST data.
+Affects only POST and custom requests.
Accepts an associative array as parameter containing the post fields.
+If the parameter is empty or omitted, the post data will be unset.
Returns TRUE on success, or FALSE on failure.
Get previously set POST data.
+Returns the currently set post fields as associative array.
+Set raw post data to send, overwriting previously set raw post data. Don't
+forget to specify a content type. Affects only POST and custom requests.
+Only either post fields or raw post data can be used for each request.
+Raw post data has higher precedence and will be used even if post fields
+are set.
Accepts a string as parameter containing the *raw* post data.
+Returns TRUE on success, or FALSE on failure.
+Add raw post data, leaving previously set raw post data unchanged.
+Affects only POST and custom requests.
Expects a string as parameter containing the raw post data to concatenate.
+Returns TRUE on success, or FALSE on failure.
+Get previously set raw post data.
+Returns a string containing the currently set raw post data.
Add a file to the POST request.
-Affects only POST requests.
Add a file to the POST request, leaving previously set files unchanged.
+Affects only POST and custom requests. Cannot be used with raw post data.
Expects a string parameter containing the form element name, and a string
+paremeter containing the path to the file which should be uploaded.
+Additionally accepts an optional string parameter which should contain
+the content type of the file.
Returns TRUE on success, or FALSE if the content type seems not to contain a
+primary and a secondary content type part.
Set files to post.
-Overwrites previously set post files.
-Affects only POST requests.
Set files to post, overwriting previously set post files.
+Affects only POST and requests. Cannot be used with raw post data.
Accepts an array containing the files to post. Each entry should be an
+associative array with "name", "file" and "type" keys. If the parameter
+is empty or omitted the post files will be unset.
Returns TRUE on success, or FALSE on failure.
Get all previously added POST files.
+Returns an array containing currently set post files.
Set file to put.
-Affects only PUT requests.
Set file to put. Affects only PUT requests.
+Accepts a string as parameter referencing the path to file.
+If the parameter is empty or omitted the put file will be unset.
Returns TRUE on success, or FALSE on failure.
Get previously set put file.
+Returns a string containing the path to the currently set put file.
+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.
+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.
+Get previously set PUT data.
+Returns a string containing the currently set raw post data.
Get all response data after the request has been sent.
+Returns an associative array with the key "headers" containing an associative
+array holding all response headers, as well as the key "body" containing a
+string with the response body.
If redirects were allowed and several responses were received, the data
+references the last received response.
Get response header(s) after the request has been sent.
-Accepts an string as optional parameter specifying a certain header to read.
+If the parameter is empty or omitted all response headers will be returned.
Returns either a string with the value of the header matching name if requested,
+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.
Get response cookie(s) after the request has been sent.
+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.
Get the response body after the request has been sent.
+Returns a string containing the response body.
+If redirects were allowed and several responses were received, the data
+references the last received response.
Get the response code after the request has been sent.
-Returns an int representing the response code.
+If redirects were allowed and several responses were received, the data
+references the last received response.
Get the response status (i.e. the string after the response code) after the message has been sent.
+Returns a string containing the response status text.
+Get response info after the request has been sent.
See http_get() for a full list of returned info.
Accepts a string as optional parameter specifying the info to read.
+If the parameter is empty or omitted, an associative array containing
+all available info will be returned.
Returns either a scalar containing the value of the info matching name if
+requested, FALSE on failure, or an associative array containing all
+available info.
If redirects were allowed and several responses were received, the data
+references the last received response.
Get the full response as HttpMessage object.
+Get the full response as HttpMessage object after the request has been sent.
+Returns an HttpMessage object of the response.
+If redirects were allowed and several responses were received, the data
+references the last received response. Use HttpMessage::getParentMessage()
+to access the data of previously received responses within this request
+cycle.
Throws HttpException, HttpRuntimeException.
Get sent HTTP message.
+Returns an HttpMessage object representing the sent request.
+If redirects were allowed and several responses were received, the data
+references the last received response. Use HttpMessage::getParentMessage()
+to access the data of previously sent requests within 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.
+Get sent HTTP message.
+Returns an HttpMessage in a form of a string
+Get the entire HTTP response.
+Returns the complete web server response, including the headers in a form of a string.
+Get all sent requests and received responses as an HttpMessage object.
+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.
Throws HttpRuntimeException.
+Clear the history.
Send the HTTP request.
-
-GET example:
-<?php
$r = new HttpRequest('http://example.com/feed.rss', HTTP_GET);
$r->setOptions(array('lastmodified' => filemtime('local.rss')));
$r->addQueryData(array('category' => 3));
try {
$r->send();
if ($r->getResponseCode() == 200) {
file_put_contents('local.rss', $r->getResponseBody());
}
} catch (HttpException $ex) {
echo $ex;
}
?>
-
-
POST example:
+
-<?php
$r = new HttpRequest('http://example.com/form.php', HTTP_POST);
$r->setOptions(array('cookies' => array('lang' => 'de')));
$r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
$r->addPostFile('image', 'profile.jpg', 'image/jpeg');
try {
echo $r->send()->getBody();
} catch (HttpException $ex) {
echo $ex;
}
?>
-
-
-
-
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:
++
+<?php
$r = new HttpRequest('http://example.com/feed.rss', HttpRequest::METH_GET);
$r->setOptions(array('lastmodified' => filemtime('local.rss')));
$r->addQueryData(array('category' => 3));
try {
$r->send();
if ($r->getResponseCode() == 200) {
file_put_contents('local.rss', $r->getResponseBody());
}
} catch (HttpException $ex) {
echo $ex;
}
?>
+
POST example:
+
+<?php
$r = new HttpRequest('http://example.com/form.php', HttpRequest::METH_POST);
$r->setOptions(array('cookies' => array('lang' => 'de')));
$r->addPostFields(array('user' => 'mike', 'pass' => 's3c|r3t'));
$r->addPostFile('image', 'profile.jpg', 'image/jpeg');
try {
echo $r->send()->getBody();
} catch (HttpException $ex) {
echo $ex;
}
?>
+
Instantiate a new HttpRequestPool object. An HttpRequestPool is
-able to send several HttpRequests in parallel.
-
-Example:
+able to send several HttpRequests in parallel. +
-<?php
try {
$pool = new HttpRequestPool(
new HttpRequest('http://www.google.com/', HTTP_HEAD),
new HttpRequest('http://www.php.net/', HTTP_HEAD)
);
$pool->send();
foreach($pool as $request) {
printf("%s is %s (%d)\n",
$request->getUrl(),
$request->getResponseCode() ? 'alive' : 'not alive',
$request->getResponseCode()
);
}
} catch (HttpException $e) {
echo $e;
}
?>
-
-
-
-
WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
+object while you're using the implemented Iterator interface.
Accepts virtual infinite optional parameters each referencing an
+HttpRequest object.
Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException).
+Example:
+
+<?php
try {
$pool = new HttpRequestPool(
new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
);
$pool->send();
foreach($pool as $request) {
printf("%s is %s (%d)\n",
$request->getUrl(),
$request->getResponseCode() ? 'alive' : 'not alive',
$request->getResponseCode()
);
}
} catch (HttpException $e) {
echo $e;
}
?>
+
Clean up HttpRequestPool object.
Detach all attached HttpRequest objects.
Attach an HttpRequest object to this HttpRequestPool.
-NOTE: set all options prior attaching!
Expects the parameter to be an HttpRequest object not already attached to
+antother HttpRequestPool object.
Returns TRUE on success, or FALSE on failure.
+Throws HttpInvalidParamException, HttpRequestException,
+HttpRequestPoolException, HttpEncodingException.
Detach an HttpRequest object from this HttpRequestPool.
+Expects the parameter to be an HttpRequest object attached to this
+HttpRequestPool object.
Returns TRUE on success, or FALSE on failure.
+Throws HttpInvalidParamException, HttpRequestPoolException.
Send all attached HttpRequest objects in parallel.
-Returns TRUE on success, or FALSE on failure.
+Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException).
+Returns TRUE until each request has finished its transaction.
Usage:
+<?php
-<?php
while ($pool->socketPerform()) {
do_something_else();
if (!$pool->socketSelect()) {
die('Socket error');
}
}
?>
-
-
-
-
See HttpRequestPool::socketPerform().
+Returns TRUE on success, or FALSE on failure.
Implements Iterator::valid().
Implements Iterator::current().
-Implements Iterator::key().
Implements Iterator::next().
Implements Iterator::rewind().
+Implements Countable.
+Returns the number of attached HttpRequest objects.
+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
+parameter containing the value of the header, which will be converted to
+a string. Additionally accepts an optional boolean parameter, which
+specifies whether an existing header should be replaced. If the second
+parameter is unset no header with this name will be sent.
Returns TRUE on success, or FALSE on failure.
+Throws HttpHeaderException if http.only_exceptions is TRUE.
Get header(s) about to 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.
Whether it sould be attempted to cache the entitity.
+
Whether it should be attempted to cache the entity.
This will result in necessary caching headers and checks of clients
"If-Modified-Since" and "If-None-Match" headers. If one of those headers
-matches a "304 Not Modified" status code will be issued.
-
-NOTE: If you're using sessions, be shure that you set session.cache_limiter
+matches a "304 Not Modified" status code will be issued.
NOTE: If you're using sessions, be sure that you set session.cache_limiter
to something more appropriate than "no-cache"!
Expects a boolean as parameter specifying whether caching should be attempted.
+Returns TRUE on success, or FALSE on failure.
Get current caching setting.
+Returns TRUE if caching should be attempted, else FALSE.
Enable on-thy-fly gzipping of the sent entity.
+Expects a boolean as parameter indicating if GZip compression should be enabled.
+Returns TRUE on success, or FALSE on failure.
Get current gzipping setting.
-Returns TRUE if GZip compression is enabled, else FALSE.
+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.
+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.
Get current Cache-Control header setting.
+Returns the current cache control setting as a string like sent in a header.
Set the content-type of the sent entity.
+Expects a string as parameter specifying the content type of the sent entity.
+Returns TRUE on success, or FALSE if the content type does not seem to
+contain a primary and secondary content type part.
Throws HttpInvalidParamException if http.only_exceptions is TRUE.
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.
Expects a string parameter specifying the magic.mime database to use.
+Additionally accepts an optional int parameter, being flags for libmagic.
Returns the guessed content type on success, or FALSE on failure.
+Throws HttpRuntimeException, HttpInvalidParamException
+if http.only_exceptions is TRUE.
Set the Content-Disposition of the sent entity. This setting aims to suggest
-the receiveing user agent how to handle the sent entity; usually the client
-will show the user a "Save As..." popup.
Set the Content-Disposition. The Content-Disposition header is very useful
+if the data actually sent came from a file or something similar, that should
+be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
Expects a string parameter specifying the file name the "Save as..." dialog
+should display. Optionally accepts a bool parameter, which, if set to true
+and the user agent knows how to handle the content type, will probably not
+cause the popup window to be shown.
Returns TRUE on success or FALSE on failure.
Get current Content-Disposition setting.
+Returns the current content disposition as string like sent in a header.
Set a custom ETag. Use this only if you know what you're doing.
+Expects an unquoted string as parameter containing the ETag.
+Returns TRUE on success, or FALSE on failure.
Get calculated or previously set custom ETag.
-Returns the calculated or previously set ETag as unquoted string.
+Set a custom Last-Modified date.
-Expects an unix timestamp as parameter representing the last modification
+time of the sent entity.
Returns TRUE on success, or FALSE on failure.
+Get calculated or previously set custom Last-Modified date.
+Returns the calculated or previously set unix timestamp.
Sets the throttle delay for use with HttpResponse::setBufferSize().
+Provides a basic throttling mechanism, which will yield the current process
+resp. thread until the entity has been completely sent, though.
Note: This doesn't really work with the FastCGI SAPI.
+Expects a double parameter specifying the seconds too sleep() after
+each chunk sent.
Returns TRUE on success, or FALSE on failure.
Get the current throttle delay.
+Returns a double representing the throttle delay in seconds.
+Sets the send buffer size for use with HttpResponse::setThrottleDelay().
+Provides a basic throttling mechanism, which will yield the current process
+resp. thread until the entity has been completely sent, though.
Note: This doesn't really work with the FastCGI SAPI.
+Expects an int parameter representing the chunk size in bytes.
+Returns TRUE on success, or FALSE on failure.
+Get current buffer size.
+Returns an int representing the current buffer size in bytes.
+Set the data to be sent.
+Expects one parameter, which will be converted to a string and contains
+the data to send.
Returns TRUE on success, or FALSE on failure.
Get the previously set data to be sent.
+Returns a string containing the previously set data to send.
Set the resource to be sent.
+Expects a resource parameter referencing an already opened stream from
+which the data to send will be read.
Returns TRUE on success, or FALSE on failure.
Get the previously set resource to be sent.
+Returns the previously set resource.
Set the file to be sent.
+Expects a string as parameter, specifying the path to the file to send.
+Returns TRUE on success, or FALSE on failure.
Get the previously set file to be sent.
+Returns the previously set path to the file to send as string.
Finally send the entity.
-
-Example:
+
+Finally send the entity.
+Accepts an optional boolean parameter, specifying whether the output
+
+buffers should be discarded prior sending. A successful caching attempt
+will cause a script termination, and write a log entry if the INI setting
+http.cache_log is set.Returns TRUE on success, or FALSE on failure.
+Throws HttpHeaderException, HttpResponseException if http.only_exceptions is TRUE.
+Example:
+
<?php
HttpResponse::setCache(true);
HttpResponse::setContentType('application/pdf');
HttpResponse::setContentDisposition("$user.pdf", false);
HttpResponse::setFile('sheet.pdf');
HttpResponse::send();
?>
-
-
-
-
Capture script output.
-
-Example:
+
-<?php
HttpResponse::setCache(true);
HttpResponse::capture();
// script follows
// note that you need to call
HttpResponse::send();
// at the end of the script unless
// you use PHP-5.1 or greater
?>
-
-
-
-
Capture script output.
+Example:
+
+<?php
HttpResponse::setCache(true);
HttpResponse::capture();
// script follows
?>
+
Generated at: Fri, 26 Aug 2005 11:08:03 +0000
+Generated at: Fri, 07 Jul 2006 21:23:59 +0200