/* {{{ proto string http_date([int timestamp])
*
- * Compose 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"
*
* Accepts an optional unix timestamp as parameter.
/* {{{ proto 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:
+ * <pre>
+ * - 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_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
+ * </pre>
+ *
+ * Example:
+ * <pre>
+ * <?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
+ * );
+ * ?>
+ * </pre>
* Returns the new URL as string on success or FALSE on failure.
*/
PHP_FUNCTION(http_build_url)
/* {{{ proto 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.
*/
PHP_FUNCTION(http_build_str)
{
* 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 cotaining the supported languages as values.
+ * 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.
*
* Accept-Charset HTTP header. The qualifier is recognized and charsets
* without qualifier are rated highest.
*
- * Expects an array as parameter cotaining the supported charsets as values.
+ * 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.
*
* 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.
+ * 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.
*
* 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..." dialogue
+ * 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.
* accepts a bool parameter, which, if set to true, will check the header
* usually used to validate HTTP ranges.
*
- * Retuns TRUE if ETag matches or the header contained the asterisk ("*"),
+ * Returns TRUE if ETag matches or the header contained the asterisk ("*"),
* else FALSE.
*/
PHP_FUNCTION(http_match_etag)
/* {{{ proto bool http_cache_etag([string etag])
*
* Attempts to cache the sent entity by its ETag, either supplied or generated
- * by the hash algorythm 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
/* {{{ proto 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".
+ * the hash algorithm specified with the INI setting "http.etag_mode".
*/
PHP_FUNCTION(ob_etaghandler)
{
return;
}
- HTTP_G(send).throttle_delay = interval;
- HTTP_G(send).buffer_size = chunk_size;
+ HTTP_G->send.throttle_delay = interval;
+ HTTP_G->send.buffer_size = chunk_size;
}
/* }}} */
* for which redirect response code to use in which situation.
*
* To be RFC compliant, "Redirecting to <a>URL</a>." will be displayed,
- * if the client doesn't redirect immediatly, and the request method was
+ * if the client doesn't redirect immediately, and the request method was
* another one than HEAD.
*
* Returns FALSE on failure, or *exits* on success.
*
* Sends raw data with support for (multiple) range requests.
*
- * Retursn TRUE on success, or FALSE on failure.
+ * Returns TRUE on success, or FALSE on failure.
*/
PHP_FUNCTION(http_send_data)
{
*
* Sends an already opened stream with support for (multiple) range requests.
*
- * Expects a resource parameter referncing the stream to read from.
+ * Expects a resource parameter referencing the stream to read from.
*
* Returns TRUE on success, or FALSE on failure.
*/
* Expects a string parameter containing a single HTTP message or
* several consecutive HTTP messages.
*
- * Returns an hierachical object structure of the parsed messages.
+ * Returns an hierarchical object structure of the parsed messages.
*
* Example:
* <pre>
* - 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 send
* - useragent: string, the user agent to send
* - 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 callback
+ * - 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
* </pre>
*
* The optional third parameter will be filled with some additional information
- * in form af an associative array, if supplied, like the following example:
+ * in form of an associative array, if supplied, like the following example:
* <pre>
* <?php
* array (
/* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
*
- * Performs an HTTP POST requeston the supplied url.
+ * 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.
*
* Performs an HTTP POST request on the supplied url.
*
- * Expecrs an associative array as second parameter, which will be
+ * 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.
*
* Performs an HTTP PUT request on the supplied url.
*
- * Expects the second parameter to be a string referncing the file to upload.
+ * 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.
/* {{{ proto string http_inflate(string data)
*
- * Uncompress data compressed with either gzip, deflate AKA zlib or raw
+ * Decompress data compressed with either gzip, deflate AKA zlib or raw
* deflate encoding.
*
* Expects a string as parameter containing the compressed data.
/* {{{ proto 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_gzhanlder and zlib.output_compression as well and should
+ * 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).
*/
*
* Check for feature that require external libraries.
*
- * Accpepts an optional in parameter specifying which feature to probe for.
+ * 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.
*
projects / m6w6 / ext-http / blobdiff