From 4508bcded15e5e120e828860bbc5e5a3cd1ef036 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Sat, 7 Apr 2007 16:37:13 +0000 Subject: [PATCH] - reviewed HttpResponse git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@233434 c90b9560-bf6c-de11-be94-00142212c4b1 --- language-snippets.ent | 8 ++ reference/http/HttpResponse.xml | 74 +++++++++++-------- reference/http/HttpResponse/capture.xml | 9 +-- reference/http/HttpResponse/getBufferSize.xml | 11 +-- reference/http/HttpResponse/getCache.xml | 13 ++-- .../http/HttpResponse/getCacheControl.xml | 13 ++-- .../HttpResponse/getContentDisposition.xml | 13 ++-- .../http/HttpResponse/getContentType.xml | 14 ++-- reference/http/HttpResponse/getData.xml | 13 ++-- reference/http/HttpResponse/getETag.xml | 13 ++-- reference/http/HttpResponse/getFile.xml | 13 ++-- reference/http/HttpResponse/getGzip.xml | 13 +--- reference/http/HttpResponse/getHeader.xml | 13 +--- .../http/HttpResponse/getLastModified.xml | 13 ++-- .../http/HttpResponse/getRequestBody.xml | 41 ++++++++++ .../HttpResponse/getRequestBodyStream.xml | 41 ++++++++++ .../http/HttpResponse/getRequestHeaders.xml | 41 ++++++++++ reference/http/HttpResponse/getStream.xml | 13 ++-- .../http/HttpResponse/getThrottleDelay.xml | 11 +-- .../http/HttpResponse/guessContentType.xml | 18 ++--- reference/http/HttpResponse/redirect.xml | 44 +++++++++++ reference/http/HttpResponse/send.xml | 17 ++--- reference/http/HttpResponse/setBufferSize.xml | 20 ++--- reference/http/HttpResponse/setCache.xml | 11 +-- .../http/HttpResponse/setCacheControl.xml | 18 ++--- .../HttpResponse/setContentDisposition.xml | 18 ++--- .../http/HttpResponse/setContentType.xml | 19 +++-- reference/http/HttpResponse/setData.xml | 14 ++-- reference/http/HttpResponse/setETag.xml | 13 ++-- reference/http/HttpResponse/setFile.xml | 14 ++-- reference/http/HttpResponse/setGzip.xml | 11 +-- reference/http/HttpResponse/setHeader.xml | 12 +-- .../http/HttpResponse/setLastModified.xml | 13 ++-- reference/http/HttpResponse/setStream.xml | 14 ++-- .../http/HttpResponse/setThrottleDelay.xml | 22 ++---- reference/http/HttpResponse/status.xml | 41 ++++++++++ .../functions/responses/http-throttle.xml | 12 +-- 37 files changed, 428 insertions(+), 283 deletions(-) create mode 100644 reference/http/HttpResponse/getRequestBody.xml create mode 100644 reference/http/HttpResponse/getRequestBodyStream.xml create mode 100644 reference/http/HttpResponse/getRequestHeaders.xml create mode 100644 reference/http/HttpResponse/redirect.xml create mode 100644 reference/http/HttpResponse/status.xml diff --git a/language-snippets.ent b/language-snippets.ent index 1f5fa712f0..b50ca0dc32 100644 --- a/language-snippets.ent +++ b/language-snippets.ent @@ -783,7 +783,15 @@ function instead.'> HttpResponse class if you are using PHP-5.1 and above'> + +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).'> +Previously calculated or defined ETag + and Last-Modified will be recalculated and redefined.'> +Provides a basic throttling mechanism, which will yield + the current process respectively thread until the entity has been completely sent.'> This function is supposed to be used in conjunction with http_send_data, http_send_file &listendand; http_send_stream.'> This function may be used in conjunction with diff --git a/reference/http/HttpResponse.xml b/reference/http/HttpResponse.xml index 4b823e5ac1..ba620d8134 100644 --- a/reference/http/HttpResponse.xml +++ b/reference/http/HttpResponse.xml @@ -1,5 +1,5 @@ - + @@ -129,38 +129,45 @@ - + + &reftitle.methods; - HttpResponse::getBufferSize - HttpResponse::setBufferSize - HttpResponse::getCacheControl - HttpResponse::setCacheControl - HttpResponse::getCache - HttpResponse::setCache - HttpResponse::getContentDisposition - HttpResponse::setContentDisposition - HttpResponse::getContentType - HttpResponse::setContentType - HttpResponse::getData - HttpResponse::setData - HttpResponse::getETag - HttpResponse::setETag - HttpResponse::getFile - HttpResponse::setFile - HttpResponse::getGzip - HttpResponse::setGzip - HttpResponse::getHeader - HttpResponse::setHeader - HttpResponse::getLastModified - HttpResponse::setLastModified - HttpResponse::getStream - HttpResponse::setStream - HttpResponse::getThrottleDelay - HttpResponse::setThrottleDelay - HttpResponse::capture - HttpResponse::send - HttpResponse::guessContentType + HttpResponse::getBufferSize + HttpResponse::setBufferSize + HttpResponse::getCacheControl + HttpResponse::setCacheControl + HttpResponse::getCache + HttpResponse::setCache + HttpResponse::getContentDisposition + HttpResponse::setContentDisposition + HttpResponse::getContentType + HttpResponse::setContentType + HttpResponse::getData + HttpResponse::setData + HttpResponse::getETag + HttpResponse::setETag + HttpResponse::getFile + HttpResponse::setFile + HttpResponse::getGzip + HttpResponse::setGzip + HttpResponse::getHeader + HttpResponse::setHeader + HttpResponse::getLastModified + HttpResponse::setLastModified + HttpResponse::getStream + HttpResponse::setStream + HttpResponse::getThrottleDelay + HttpResponse::setThrottleDelay + HttpResponse::redirect + HttpResponse::capture + HttpResponse::send + HttpResponse::guessContentType + HttpResponse::redirect + HttpResponse::status + HttpResponse::getRequestHeaders + HttpResponse::getRequestBody + HttpResponse::getRequestBodyStream @@ -180,7 +187,11 @@ &reference.http.HttpResponse.getLastModified; &reference.http.HttpResponse.getStream; &reference.http.HttpResponse.getThrottleDelay; +&reference.http.HttpResponse.getRequestBody; +&reference.http.HttpResponse.getRequestBodyStream; +&reference.http.HttpResponse.getRequestHeaders; &reference.http.HttpResponse.guessContentType; +&reference.http.HttpResponse.redirect; &reference.http.HttpResponse.send; &reference.http.HttpResponse.setBufferSize; &reference.http.HttpResponse.setCacheControl; @@ -195,6 +206,7 @@ &reference.http.HttpResponse.setLastModified; &reference.http.HttpResponse.setStream; &reference.http.HttpResponse.setThrottleDelay; +&reference.http.HttpResponse.status; + @@ -13,11 +13,9 @@ voidHttpResponse::capture - Capture script output. - diff --git a/reference/http/HttpResponse/getBufferSize.xml b/reference/http/HttpResponse/getBufferSize.xml index c4b3a2ce8e..2a716cc73b 100644 --- a/reference/http/HttpResponse/getBufferSize.xml +++ b/reference/http/HttpResponse/getBufferSize.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ intHttpResponse::getBufferSize - Get current buffer size. - &reftitle.returnvalues; @@ -93,17 +91,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getCache.xml b/reference/http/HttpResponse/getCache.xml index 9b4d98107a..f377e8c887 100644 --- a/reference/http/HttpResponse/getCache.xml +++ b/reference/http/HttpResponse/getCache.xml @@ -1,5 +1,5 @@ - + @@ -13,16 +13,14 @@ boolHttpResponse::getCache - Get current caching setting. - &reftitle.returnvalues; - Returns TRUE if caching should be attempted, else FALSE. + Returns &true; if caching should be attempted, else &false;. @@ -93,17 +91,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getCacheControl.xml b/reference/http/HttpResponse/getCacheControl.xml index c2acf8a8e6..00ccc3f054 100644 --- a/reference/http/HttpResponse/getCacheControl.xml +++ b/reference/http/HttpResponse/getCacheControl.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ stringHttpResponse::getCacheControl - - Get current Cache-Control header setting. + Get current Cache-Control header setting. - &reftitle.returnvalues; @@ -93,17 +91,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getContentDisposition.xml b/reference/http/HttpResponse/getContentDisposition.xml index a7e5ba8187..6319bfaac9 100644 --- a/reference/http/HttpResponse/getContentDisposition.xml +++ b/reference/http/HttpResponse/getContentDisposition.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ stringHttpResponse::getContentDisposition - - Get current Content-Disposition setting. + Get current Content-Disposition setting. - &reftitle.returnvalues; @@ -93,17 +91,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getContentType.xml b/reference/http/HttpResponse/getContentType.xml index bc87080977..1b02bc7329 100644 --- a/reference/http/HttpResponse/getContentType.xml +++ b/reference/http/HttpResponse/getContentType.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ stringHttpResponse::getContentType - - Get current Content-Type header setting. + Get current Content-Type header setting. - &reftitle.returnvalues; @@ -93,17 +91,17 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getData.xml b/reference/http/HttpResponse/getData.xml index 6b3b624d10..730fc81ef7 100644 --- a/reference/http/HttpResponse/getData.xml +++ b/reference/http/HttpResponse/getData.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ stringHttpResponse::getData - Get the previously set data to be sent. - &reftitle.returnvalues; @@ -93,17 +91,18 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getETag.xml b/reference/http/HttpResponse/getETag.xml index 964dcaef3b..4f127b5276 100644 --- a/reference/http/HttpResponse/getETag.xml +++ b/reference/http/HttpResponse/getETag.xml @@ -1,5 +1,5 @@ - + @@ -13,16 +13,14 @@ stringHttpResponse::getETag - Get calculated or previously set custom ETag. - &reftitle.returnvalues; - Returns the calculated or previously set ETag as unquoted string. + Returns the calculated or previously set ETag as unquoted string. @@ -93,17 +91,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getFile.xml b/reference/http/HttpResponse/getFile.xml index dad664f3f2..c584af7881 100644 --- a/reference/http/HttpResponse/getFile.xml +++ b/reference/http/HttpResponse/getFile.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ stringHttpResponse::getFile - Get the previously set file to be sent. - &reftitle.returnvalues; @@ -93,17 +91,18 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getGzip.xml b/reference/http/HttpResponse/getGzip.xml index 3da657040a..1de0d2ccbd 100644 --- a/reference/http/HttpResponse/getGzip.xml +++ b/reference/http/HttpResponse/getGzip.xml @@ -1,5 +1,5 @@ - + @@ -13,16 +13,14 @@ boolHttpResponse::getGzip - - Get current gzipping setting. + Get current gzip'ing setting. - &reftitle.returnvalues; - Returns TRUE if GZip compression is enabled, else FALSE. + Returns &true; if GZip compression is enabled, else &false;. @@ -93,17 +91,14 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getHeader.xml b/reference/http/HttpResponse/getHeader.xml index a1734ff6ad..dac7fd0149 100644 --- a/reference/http/HttpResponse/getHeader.xml +++ b/reference/http/HttpResponse/getHeader.xml @@ -1,5 +1,5 @@ - + @@ -13,16 +13,14 @@ mixedHttpResponse::getHeader stringname - Get header(s) about to be sent. - In Apache2 this only works for PHP-5.1.3 and greater. + &http.maynotwork.SAPI; Apache2 w/PHP < 5.1.3. - &reftitle.parameters; @@ -44,7 +42,7 @@ &reftitle.returnvalues; Returns either a string containing the value of the header matching name, - FALSE on failure, or an associative array with all headers. + &false; on failure, or an associative array with all headers. @@ -115,17 +113,14 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getLastModified.xml b/reference/http/HttpResponse/getLastModified.xml index 63e7b59016..3aafe38c73 100644 --- a/reference/http/HttpResponse/getLastModified.xml +++ b/reference/http/HttpResponse/getLastModified.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ intHttpResponse::getLastModified - - Get calculated or previously set custom Last-Modified date. + Get calculated or previously set custom Last-Modified date. - &reftitle.returnvalues; @@ -93,17 +91,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getRequestBody.xml b/reference/http/HttpResponse/getRequestBody.xml new file mode 100644 index 0000000000..2e23bd3aad --- /dev/null +++ b/reference/http/HttpResponse/getRequestBody.xml @@ -0,0 +1,41 @@ + + + + + + HttpResponse::getRequestBody + Get request body + + + &reftitle.description; + + static + stringHttpResponse::getRequestBody + + + + &info.function.alias; http_get_request_body. + + + + + diff --git a/reference/http/HttpResponse/getRequestBodyStream.xml b/reference/http/HttpResponse/getRequestBodyStream.xml new file mode 100644 index 0000000000..c0897c8ad0 --- /dev/null +++ b/reference/http/HttpResponse/getRequestBodyStream.xml @@ -0,0 +1,41 @@ + + + + + + HttpResponse::getRequestBodyStream + Get request body stream + + + &reftitle.description; + + static + resourceHttpResponse::getRequestBodyStream + + + + &info.function.alias; http_get_request_body_stream. + + + + + diff --git a/reference/http/HttpResponse/getRequestHeaders.xml b/reference/http/HttpResponse/getRequestHeaders.xml new file mode 100644 index 0000000000..2aa308e34a --- /dev/null +++ b/reference/http/HttpResponse/getRequestHeaders.xml @@ -0,0 +1,41 @@ + + + + + + HttpResponse::getRequestHeaders + Get request headers + + + &reftitle.description; + + static + arrayHttpResponse::getRequestHeaders + + + + &info.function.alias; http_get_request_headers. + + + + + diff --git a/reference/http/HttpResponse/getStream.xml b/reference/http/HttpResponse/getStream.xml index 56f5ab9f65..a96c2e1649 100644 --- a/reference/http/HttpResponse/getStream.xml +++ b/reference/http/HttpResponse/getStream.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ resourceHttpResponse::getStream - Get the previously set resource to be sent. - &reftitle.parameters; @@ -98,17 +96,18 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/getThrottleDelay.xml b/reference/http/HttpResponse/getThrottleDelay.xml index 010e7b016b..1dcbbc6bec 100644 --- a/reference/http/HttpResponse/getThrottleDelay.xml +++ b/reference/http/HttpResponse/getThrottleDelay.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ doubleHttpResponse::getThrottleDelay - Get the current throttle delay. - &reftitle.returnvalues; @@ -93,17 +91,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/guessContentType.xml b/reference/http/HttpResponse/guessContentType.xml index dbb18901be..2218d7fc4e 100644 --- a/reference/http/HttpResponse/guessContentType.xml +++ b/reference/http/HttpResponse/guessContentType.xml @@ -1,5 +1,5 @@ - + @@ -11,18 +11,16 @@ static stringHttpResponse::guessContentType - stringmagic_file + stringmagic_file intmagic_mode=MAGIC_MIME - 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. + If the attempt is successful, the guessed Content-Type will automatically + be set as response Content-Type. - &reftitle.parameters; @@ -50,7 +48,7 @@ &reftitle.returnvalues; - Returns the guessed content type on success, or FALSE on failure. + Returns the guessed content type on success, or &false; on failure. @@ -119,17 +117,15 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/redirect.xml b/reference/http/HttpResponse/redirect.xml new file mode 100644 index 0000000000..6e1fbb62af --- /dev/null +++ b/reference/http/HttpResponse/redirect.xml @@ -0,0 +1,44 @@ + + + + + + HttpResponse::redirect + Redirect + + + &reftitle.description; + + static + voidHttpResponse::redirect + stringurl + arrayparams + boolsession = FALSE + intstatus + + + &info.function.alias; http_redirect. + + + + + diff --git a/reference/http/HttpResponse/send.xml b/reference/http/HttpResponse/send.xml index 3e7bb22a83..217cf32ed2 100644 --- a/reference/http/HttpResponse/send.xml +++ b/reference/http/HttpResponse/send.xml @@ -1,5 +1,5 @@ - + @@ -13,15 +13,14 @@ boolHttpResponse::send boolclean_ob = TRUE - Finally send the entity. - A successful caching attempt will cause a script termination, and write a log entry - if the &link.http.configuration; http.cache_log is set. + A successful caching attempt will exit PHP, and write a log entry if the &link.http.configuration; + http.log.cache is set. + &see.http.configuration.force_exit; - &reftitle.parameters; @@ -45,13 +44,14 @@ + diff --git a/reference/http/HttpResponse/setBufferSize.xml b/reference/http/HttpResponse/setBufferSize.xml index f949194091..71af1c40bb 100644 --- a/reference/http/HttpResponse/setBufferSize.xml +++ b/reference/http/HttpResponse/setBufferSize.xml @@ -1,5 +1,5 @@ - + @@ -13,20 +13,15 @@ boolHttpResponse::setBufferSize intbytes - - 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. + Sets the send buffer size of the throttling mechanism. + ¬e.http.throttling.yields.process; - This doesn't really work with the FastCGI SAPI. + &http.maynotwork.SAPI; FastCGI. - &reftitle.parameters; @@ -117,17 +112,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setCache.xml b/reference/http/HttpResponse/setCache.xml index 79ae57afe0..75add76d5e 100644 --- a/reference/http/HttpResponse/setCache.xml +++ b/reference/http/HttpResponse/setCache.xml @@ -1,5 +1,5 @@ - + @@ -13,7 +13,6 @@ boolHttpResponse::setCache boolcache - Whether it should be attempted to cache the entity. @@ -28,7 +27,6 @@ to something more appropriate than "no-cache"! - &reftitle.parameters; @@ -119,17 +117,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setCacheControl.xml b/reference/http/HttpResponse/setCacheControl.xml index b83a47638a..72ac035c5c 100644 --- a/reference/http/HttpResponse/setCacheControl.xml +++ b/reference/http/HttpResponse/setCacheControl.xml @@ -1,5 +1,5 @@ - + @@ -15,11 +15,9 @@ intmax_age = 0 boolmust_revalidate = TRUE - - Define a custom cache-control header, usually being private or public; + Define a custom Cache-Control header, usually being private or public; - &reftitle.parameters; @@ -55,17 +53,18 @@ &reftitle.returnvalues; - Returns TRUE on success, or FALSE if control does not match one of public, private or no-cache. + Returns &true; on success, or &false; if control does not match one of public, private or no-cache. + - diff --git a/reference/http/HttpResponse/setContentDisposition.xml b/reference/http/HttpResponse/setContentDisposition.xml index cadb90fc76..5ea5a2a9d6 100644 --- a/reference/http/HttpResponse/setContentDisposition.xml +++ b/reference/http/HttpResponse/setContentDisposition.xml @@ -1,5 +1,5 @@ - + @@ -11,16 +11,13 @@ static boolHttpResponse::setContentDisposition - stringfilename + stringfilename boolinline = FALSE - - 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). + Set the Content-Disposition. + &http.content.disposition; - &reftitle.parameters; @@ -121,17 +118,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setContentType.xml b/reference/http/HttpResponse/setContentType.xml index 965c4bc6b8..831cbd0f8f 100644 --- a/reference/http/HttpResponse/setContentType.xml +++ b/reference/http/HttpResponse/setContentType.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ boolHttpResponse::setContentType stringcontent_type - - Set the content-type of the sent entity. + Set the Content-Type of the sent entity. - &reftitle.parameters; @@ -37,18 +35,19 @@ &reftitle.returnvalues; - Returns TRUE on success, or FALSE if the content type does not seem to + Returns &true; on success, or &false; if the content type does not seem to contain a primary and secondary content type part. + - diff --git a/reference/http/HttpResponse/setData.xml b/reference/http/HttpResponse/setData.xml index 4dcbc8d731..916edd2a59 100644 --- a/reference/http/HttpResponse/setData.xml +++ b/reference/http/HttpResponse/setData.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,10 @@ boolHttpResponse::setData mixeddata - Set the data to be sent. - + ¬e.http.response.recalculate.etag.lm; &reftitle.parameters; @@ -108,17 +107,18 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setETag.xml b/reference/http/HttpResponse/setETag.xml index 261a956982..33af70276d 100644 --- a/reference/http/HttpResponse/setETag.xml +++ b/reference/http/HttpResponse/setETag.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ boolHttpResponse::setETag stringetag - - Set a custom ETag. Use this only if you know what you're doing. + Set a custom ETag. Use this only if you know what you're doing. - &reftitle.parameters; @@ -108,17 +106,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setFile.xml b/reference/http/HttpResponse/setFile.xml index b725f6665d..5b95e9b5a8 100644 --- a/reference/http/HttpResponse/setFile.xml +++ b/reference/http/HttpResponse/setFile.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,10 @@ boolHttpResponse::setFile stringfile - Set the file to be sent. - + ¬e.http.response.recalculate.etag.lm; &reftitle.parameters; @@ -108,17 +107,18 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setGzip.xml b/reference/http/HttpResponse/setGzip.xml index 55dd2d94e4..0d6ee02a5e 100644 --- a/reference/http/HttpResponse/setGzip.xml +++ b/reference/http/HttpResponse/setGzip.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ boolHttpResponse::setGzip boolgzip - - Enable on-thy-fly gzipping of the sent entity. + Enable on-thy-fly gzip'ing of the sent entity. - &reftitle.parameters; @@ -108,17 +106,14 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setHeader.xml b/reference/http/HttpResponse/setHeader.xml index 7db37368d0..91c8f555ab 100644 --- a/reference/http/HttpResponse/setHeader.xml +++ b/reference/http/HttpResponse/setHeader.xml @@ -1,5 +1,5 @@ - + @@ -15,11 +15,9 @@ mixedvalue boolreplace = TRUE - Send an HTTP header. - &reftitle.parameters; @@ -60,13 +58,14 @@ + - diff --git a/reference/http/HttpResponse/setLastModified.xml b/reference/http/HttpResponse/setLastModified.xml index 9c434570c8..2d09d97b98 100644 --- a/reference/http/HttpResponse/setLastModified.xml +++ b/reference/http/HttpResponse/setLastModified.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,9 @@ boolHttpResponse::setLastModified inttimestamp - - Set a custom Last-Modified date. + Set a custom Last-Modified date. - &reftitle.parameters; @@ -108,17 +106,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setStream.xml b/reference/http/HttpResponse/setStream.xml index b12fe383b2..c1aae93dd1 100644 --- a/reference/http/HttpResponse/setStream.xml +++ b/reference/http/HttpResponse/setStream.xml @@ -1,5 +1,5 @@ - + @@ -13,11 +13,10 @@ boolHttpResponse::setStream resourcestream - Set the resource to be sent. - + ¬e.http.response.recalculate.etag.lm; &reftitle.parameters; @@ -108,17 +107,18 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/setThrottleDelay.xml b/reference/http/HttpResponse/setThrottleDelay.xml index b2ce074f16..5552fb6584 100644 --- a/reference/http/HttpResponse/setThrottleDelay.xml +++ b/reference/http/HttpResponse/setThrottleDelay.xml @@ -1,5 +1,5 @@ - + @@ -13,20 +13,15 @@ boolHttpResponse::setThrottleDelay doubleseconds - - 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. + Sets the throttle delay. + ¬e.http.throttling.yields.process; - This doesn't really work with the FastCGI SAPI. + &http.maynotwork.SAPI; FastCGI. - &reftitle.parameters; @@ -36,7 +31,7 @@ seconds - The seconds to sleep after each chunk sent + seconds to sleep after each chunk sent @@ -117,17 +112,16 @@ Use the PEAR Coding Standards --> - diff --git a/reference/http/HttpResponse/status.xml b/reference/http/HttpResponse/status.xml new file mode 100644 index 0000000000..2793ca2d76 --- /dev/null +++ b/reference/http/HttpResponse/status.xml @@ -0,0 +1,41 @@ + + + + + + HttpResponse::status + Redirect + + + &reftitle.description; + + static + boolHttpResponse::status + intstatus + + + &info.function.alias; http_send_status. + + + + + diff --git a/reference/http/functions/responses/http-throttle.xml b/reference/http/functions/responses/http-throttle.xml index 5df5ab4d84..2b3555061c 100644 --- a/reference/http/functions/responses/http-throttle.xml +++ b/reference/http/functions/responses/http-throttle.xml @@ -1,5 +1,5 @@ - + @@ -16,11 +16,13 @@ Sets the throttle delay and send buffer size. - - Provides a basic throttling mechanism, which will yield the current process - resp. thread until the entity has been completely sent. - ¬e.http.send.API; + ¬e.http.throttling.yields.process; + + + &http.maynotwork.SAPI; FastCGI. + + &reftitle.parameters;