cvs: phpdoc /en language-snippets.ent /en/reference/http HttpResponse.xml /en/reference/http/HttpResponse capture.xml getBufferSize.xml getCache.xml
getCacheControl.xml getContentDisposition.xml getContentType.xml getData.xml getETag.xml getFile.xml getGzip.xml getHeader.xml getLastModified.xml
getRequestBody.xml getRequestBodyStream.xml getRequestHeaders.xml getStream.xml getThrottleDelay.xml guessContentType.xml redirect.xml send.xml
setBufferSize.xml setCache.xml setCacheControl.xml setContentDisposition.xml setContentType.xml setData.xml setETag.xml setFile.xml setGzip.xml
setHeader.xml setLastModified.xml setStream.xml setThrottleDelay.xml status.xml /en/reference/http/functions/responses http-throttle.xml
| From: | Michael Wallner | Date: | Sat, 07 Apr 2007 16:37:14 +0000 |
| Subject: | cvs: phpdoc /en language-snippets.ent /en/reference/http HttpResponse.xml /en/reference/http/HttpResponse capture.xml getBufferSize.xml getCache.xml getCacheControl.xml getContentDisposition.xml getContentType.xml getData.xml getETag.xml getFile.xml getGzip.xml getHeader.xml getLastModified.xml getRequestBody.xml getRequestBodyStream.xml getRequestHeaders.xml getStream.xml getThrottleDelay.xml guessContentType.xml redirect.xml send.xml setBufferSize.xml setCache.xml setCacheControl.xml setContentDisposition.xml setContentType.xml setData.xml setETag.xml setFile.xml setGzip.xml setHeader.xml setLastModified.xml setStream.xml setThrottleDelay.xml status.xml /en/reference/http/functions/responses http-throttle.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969376023@lists.php.net to get a copy of this message | ||
mike Sat Apr 7 16:37:14 2007 UTC
Added files:
/phpdoc/en/reference/http/HttpResponse getRequestBody.xml
getRequestBodyStream.xml
getRequestHeaders.xml
redirect.xml status.xml
Modified files:
/phpdoc/en language-snippets.ent
/phpdoc/en/reference/http HttpResponse.xml
/phpdoc/en/reference/http/HttpResponse capture.xml
getBufferSize.xml
getCache.xml
getCacheControl.xml
getContentDisposition.xml
getContentType.xml
getData.xml getETag.xml
getFile.xml getGzip.xml
getHeader.xml
getLastModified.xml
getStream.xml
getThrottleDelay.xml
guessContentType.xml
send.xml setBufferSize.xml
setCache.xml
setCacheControl.xml
setContentDisposition.xml
setContentType.xml
setData.xml setETag.xml
setFile.xml setGzip.xml
setHeader.xml
setLastModified.xml
setStream.xml
setThrottleDelay.xml
/phpdoc/en/reference/http/functions/responses http-throttle.xml
Log:
- reviewed HttpResponse
http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.197&r2=1.198&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.197 phpdoc/en/language-snippets.ent:1.198 --- phpdoc/en/language-snippets.ent:1.197 Thu Apr 5 18:16:49 2007 +++ phpdoc/en/language-snippets.ent Sat Apr 7 16:37:12 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.197 $ --> +<!-- $Revision: 1.198 $ --> <!-- Keep 'em sorted --> @@ -783,7 +783,15 @@ <!ENTITY http.request.affects.any 'Affects any request method.'> <!ENTITY http.response.class.php51 'the <link linkend="http.HttpResponse"><classname >HttpResponse</classname></link> class if you are using PHP-5.1 and above'> - +<!ENTITY http.maynotwork.SAPI 'This may not work as expected with the following SAPI(s):'> +<!ENTITY http.content.disposition 'The <literal>Content-Disposition</literal> 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).'> + +<!ENTITY note.http.response.recalculate.etag.lm '<note><simpara>Previously calculated or defined <literal>ETag</literal> + and <literal>Last-Modified</literal> will be recalculated and redefined.</simpara></note>'> +<!ENTITY note.http.throttling.yields.process '<note><simpara>Provides a basic throttling mechanism, which will yield + the current process respectively thread until the entity has been completely sent.</simpara></note>'> <!ENTITY note.http.send.API '<note><simpara>This function is supposed to be used in conjunction with <function>http_send_data</function>, <function>http_send_file</function> &listendand; <function>http_send_stream</function>.</simpara></note>'> <!ENTITY note.http.send.API.mayuse '<note><simpara>This function may be used in conjunction with http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse.xml diff -u phpdoc/en/reference/http/HttpResponse.xml:1.3 phpdoc/en/reference/http/HttpResponse.xml:1.4 --- phpdoc/en/reference/http/HttpResponse.xml:1.3 Thu Apr 5 18:23:30 2007 +++ phpdoc/en/reference/http/HttpResponse.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="http.HttpResponse"> <refnamediv> @@ -129,38 +129,45 @@ </tbody> </tgroup> </table> - </refsect2> <refsect2 id="http.HttpResponse.methods"> + </refsect2> + <refsect2 id="http.HttpResponse.methods"> &reftitle.methods; <simplelist> - <member><link linkend="function.HttpResponse-getBufferSize"><classname>HttpResponse</classname>::<function>getBufferSize</function></link></member> - <member><link linkend="function.HttpResponse-setBufferSize"><classname>HttpResponse</classname>::<function>setBufferSize</function></link></member> - <member><link linkend="function.HttpResponse-getCacheControl"><classname>HttpResponse</classname>::<function>getCacheControl</function></link></member> - <member><link linkend="function.HttpResponse-setCacheControl"><classname>HttpResponse</classname>::<function>setCacheControl</function></link></member> - <member><link linkend="function.HttpResponse-getCache"><classname>HttpResponse</classname>::<function>getCache</function></link></member> - <member><link linkend="function.HttpResponse-setCache"><classname>HttpResponse</classname>::<function>setCache</function></link></member> - <member><link linkend="function.HttpResponse-getContentDisposition"><classname>HttpResponse</classname>::<function>getContentDisposition</function></link></member> - <member><link linkend="function.HttpResponse-setContentDisposition"><classname>HttpResponse</classname>::<function>setContentDisposition</function></link></member> - <member><link linkend="function.HttpResponse-getContentType"><classname>HttpResponse</classname>::<function>getContentType</function></link></member> - <member><link linkend="function.HttpResponse-setContentType"><classname>HttpResponse</classname>::<function>setContentType</function></link></member> - <member><link linkend="function.HttpResponse-getData"><classname>HttpResponse</classname>::<function>getData</function></link></member> - <member><link linkend="function.HttpResponse-setData"><classname>HttpResponse</classname>::<function>setData</function></link></member> - <member><link linkend="function.HttpResponse-getETag"><classname>HttpResponse</classname>::<function>getETag</function></link></member> - <member><link linkend="function.HttpResponse-setETag"><classname>HttpResponse</classname>::<function>setETag</function></link></member> - <member><link linkend="function.HttpResponse-getFile"><classname>HttpResponse</classname>::<function>getFile</function></link></member> - <member><link linkend="function.HttpResponse-setFile"><classname>HttpResponse</classname>::<function>setFile</function></link></member> - <member><link linkend="function.HttpResponse-getGzip"><classname>HttpResponse</classname>::<function>getGzip</function></link></member> - <member><link linkend="function.HttpResponse-setGzip"><classname>HttpResponse</classname>::<function>setGzip</function></link></member> - <member><link linkend="function.HttpResponse-getHeader"><classname>HttpResponse</classname>::<function>getHeader</function></link></member> - <member><link linkend="function.HttpResponse-setHeader"><classname>HttpResponse</classname>::<function>setHeader</function></link></member> - <member><link linkend="function.HttpResponse-getLastModified"><classname>HttpResponse</classname>::<function>getLastModified</function></link></member> - <member><link linkend="function.HttpResponse-setLastModified"><classname>HttpResponse</classname>::<function>setLastModified</function></link></member> - <member><link linkend="function.HttpResponse-getStream"><classname>HttpResponse</classname>::<function>getStream</function></link></member> - <member><link linkend="function.HttpResponse-setStream"><classname>HttpResponse</classname>::<function>setStream</function></link></member> - <member><link linkend="function.HttpResponse-getThrottleDelay"><classname>HttpResponse</classname>::<function>getThrottleDelay</function></link></member> - <member><link linkend="function.HttpResponse-setThrottleDelay"><classname>HttpResponse</classname>::<function>setThrottleDelay</function></link></member> - <member><link linkend="function.HttpResponse-capture"><classname>HttpResponse</classname>::<function>capture</function></link></member> - <member><link linkend="function.HttpResponse-send"><classname>HttpResponse</classname>::<function>send</function></link></member> - <member><link linkend="function.HttpResponse-guessContentType"><classname>HttpResponse</classname>::<function>guessContentType</function></link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCache</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getGzip"><function><classname>HttpResponse</classname>::getGzip</function></link></member> + <member><link linkend="function.HttpResponse-setGzip"><function><classname>HttpResponse</classname>::setGzip</function></link></member> + <member><link linkend="function.HttpResponse-getHeader"><function><classname>HttpResponse</classname>::getHeader</function></link></member> + <member><link linkend="function.HttpResponse-setHeader"><function><classname>HttpResponse</classname>::setHeader</function></link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-redirect"><function><classname>HttpResponse</classname>::redirect</function></link></member> + <member><link linkend="function.HttpResponse-capture"><function><classname>HttpResponse</classname>::capture</function></link></member> + <member><link linkend="function.HttpResponse-send"><function><classname>HttpResponse</classname>::send</function></link></member> + <member><link linkend="function.HttpResponse-guessContentType"><function><classname>HttpResponse</classname>::guessContentType</function></link></member> + <member><link linkend="function.HttpResponse-redirect"><function><classname>HttpResponse</classname>::redirect</function></link></member> + <member><link linkend="function.HttpResponse-status"><function><classname>HttpResponse</classname>::status</function></link></member> + <member><link linkend="function.HttpResponse-getRequestHeaders"><function><classname>HttpResponse</classname>::getRequestHeaders</function></link></member> + <member><link linkend="function.HttpResponse-getRequestBody"><function><classname>HttpResponse</classname>::getRequestBody</function></link></member> + <member><link linkend="function.HttpResponse-getRequestBodyStream"><function><classname>HttpResponse</classname>::getRequestBodyStream</function></link></member> </simplelist> </refsect2> </refsect1> @@ -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; <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/capture.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/capture.xml diff -u phpdoc/en/reference/http/HttpResponse/capture.xml:1.2 phpdoc/en/reference/http/HttpResponse/capture.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/capture.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/capture.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-capture"> <refnamediv> @@ -13,11 +13,9 @@ <type>void</type><methodname>HttpResponse::capture</methodname> <void/> </methodsynopsis> - <para> Capture script output. </para> - </refsect1> <!-- Use when ERRORS exist @@ -74,17 +72,14 @@ </refsect1> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-capture"><function><classname>HttpResponse</classname>::capture</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getBufferSize.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getBufferSize.xml diff -u phpdoc/en/reference/http/HttpResponse/getBufferSize.xml:1.2 phpdoc/en/reference/http/HttpResponse/getBufferSize.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getBufferSize.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getBufferSize.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getBufferSize"> <refnamediv> @@ -13,11 +13,9 @@ <type>int</type><methodname>HttpResponse::getBufferSize</methodname> <void/> </methodsynopsis> - <para> Get current buffer size. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getCache.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getCache.xml diff -u phpdoc/en/reference/http/HttpResponse/getCache.xml:1.2 phpdoc/en/reference/http/HttpResponse/getCache.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getCache.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getCache.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getCache"> <refnamediv> @@ -13,16 +13,14 @@ <type>bool</type><methodname>HttpResponse::getCache</methodname> <void/> </methodsynopsis> - <para> Get current caching setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns TRUE if caching should be attempted, else FALSE. + Returns &true; if caching should be attempted, else &false;. </para> </refsect1> @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getCacheControl.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getCacheControl.xml diff -u phpdoc/en/reference/http/HttpResponse/getCacheControl.xml:1.2 phpdoc/en/reference/http/HttpResponse/getCacheControl.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getCacheControl.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getCacheControl.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getCacheControl"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getCacheControl</methodname> <void/> </methodsynopsis> - <para> - Get current Cache-Control header setting. + Get current <literal>Cache-Control</literal> header setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCachel</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml diff -u phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml:1.2 phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getContentDisposition"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getContentDisposition</methodname> <void/> </methodsynopsis> - <para> - Get current Content-Disposition setting. + Get current <literal>Content-Disposition</literal> setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getContentType.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getContentType.xml diff -u phpdoc/en/reference/http/HttpResponse/getContentType.xml:1.2 phpdoc/en/reference/http/HttpResponse/getContentType.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getContentType.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getContentType.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getContentType"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getContentType</methodname> <void/> </methodsynopsis> - <para> - Get current Content-Type header setting. + Get current <literal>Content-Type</literal> header setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,17 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> + <member><link linkend="function.HttpResponse-guessContentType"><function><classname>HttpResponse</classname>::guessContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getData.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getData.xml diff -u phpdoc/en/reference/http/HttpResponse/getData.xml:1.2 phpdoc/en/reference/http/HttpResponse/getData.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getData.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getData.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getData"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getData</methodname> <void/> </methodsynopsis> - <para> Get the previously set data to be sent. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getETag.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getETag.xml diff -u phpdoc/en/reference/http/HttpResponse/getETag.xml:1.2 phpdoc/en/reference/http/HttpResponse/getETag.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getETag.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getETag.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getETag"> <refnamediv> @@ -13,16 +13,14 @@ <type>string</type><methodname>HttpResponse::getETag</methodname> <void/> </methodsynopsis> - <para> Get calculated or previously set custom ETag. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the calculated or previously set ETag as unquoted string. + Returns the calculated or previously set <literal>ETag</literal> as unquoted string. </para> </refsect1> @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getFile.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getFile.xml diff -u phpdoc/en/reference/http/HttpResponse/getFile.xml:1.2 phpdoc/en/reference/http/HttpResponse/getFile.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getFile.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getFile.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getFile"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getFile</methodname> <void/> </methodsynopsis> - <para> Get the previously set file to be sent. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getGzip.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getGzip.xml diff -u phpdoc/en/reference/http/HttpResponse/getGzip.xml:1.2 phpdoc/en/reference/http/HttpResponse/getGzip.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getGzip.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getGzip.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getGzip"> <refnamediv> @@ -13,16 +13,14 @@ <type>bool</type><methodname>HttpResponse::getGzip</methodname> <void/> </methodsynopsis> - <para> - Get current gzipping setting. + Get current gzip'ing setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns TRUE if GZip compression is enabled, else FALSE. + Returns &true; if GZip compression is enabled, else &false;. </para> </refsect1> @@ -93,17 +91,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setGzip"><function><classname>HttpResponse</classname>::setGzip</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getHeader.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getHeader.xml diff -u phpdoc/en/reference/http/HttpResponse/getHeader.xml:1.2 phpdoc/en/reference/http/HttpResponse/getHeader.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getHeader.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getHeader.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getHeader"> <refnamediv> @@ -13,16 +13,14 @@ <type>mixed</type><methodname>HttpResponse::getHeader</methodname> <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> - <para> Get header(s) about to be sent. </para> <note> <para> - In Apache2 this only works for PHP-5.1.3 and greater. + &http.maynotwork.SAPI; Apache2 w/PHP < 5.1.3. </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -44,7 +42,7 @@ &reftitle.returnvalues; <para> 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. </para> </refsect1> @@ -115,17 +113,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setHeader"><function><classname>HttpResponse</classname>::setHeader</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getLastModified.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getLastModified.xml diff -u phpdoc/en/reference/http/HttpResponse/getLastModified.xml:1.3 phpdoc/en/reference/http/HttpResponse/getLastModified.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/getLastModified.xml:1.3 Thu Feb 15 09:24:35 2007 +++ phpdoc/en/reference/http/HttpResponse/getLastModified.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getLastModified"> <refnamediv> @@ -13,11 +13,9 @@ <type>int</type><methodname>HttpResponse::getLastModified</methodname> <void/> </methodsynopsis> - <para> - Get calculated or previously set custom Last-Modified date. + Get calculated or previously set custom <literal>Last-Modified</literal> date. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getStream.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getStream.xml diff -u phpdoc/en/reference/http/HttpResponse/getStream.xml:1.2 phpdoc/en/reference/http/HttpResponse/getStream.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getStream.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getStream.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getStream"> <refnamediv> @@ -13,11 +13,9 @@ <type>resource</type><methodname>HttpResponse::getStream</methodname> <void/> </methodsynopsis> - <para> Get the previously set resource to be sent. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -98,17 +96,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml diff -u phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml:1.2 phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getThrottleDelay"> <refnamediv> @@ -13,11 +13,9 @@ <type>double</type><methodname>HttpResponse::getThrottleDelay</methodname> <void/> </methodsynopsis> - <para> Get the current throttle delay. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/guessContentType.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/guessContentType.xml diff -u phpdoc/en/reference/http/HttpResponse/guessContentType.xml:1.2 phpdoc/en/reference/http/HttpResponse/guessContentType.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/guessContentType.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/guessContentType.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-guessContentType"> <refnamediv> @@ -11,18 +11,16 @@ <methodsynopsis> <modifier>static</modifier> <type>string</type><methodname>HttpResponse::guessContentType</methodname> - <methodparam choice="opt"><type>string</type><parameter>magic_file</parameter></methodparam> + <methodparam><type>string</type><parameter>magic_file</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>magic_mode=MAGIC_MIME</parameter></methodparam> </methodsynopsis> - <para> Attempts to guess the content type of supplied payload through libmagic. </para> <para> - If the attempt is successful, the guessed content type will automatically - be set as response content type. + If the attempt is successful, the guessed <literal>Content-Type</literal> will automatically + be set as response <literal>Content-Type</literal>. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -50,7 +48,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the guessed content type on success, or FALSE on failure. + Returns the guessed content type on success, or &false; on failure. </para> </refsect1> @@ -119,17 +117,15 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/send.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/send.xml diff -u phpdoc/en/reference/http/HttpResponse/send.xml:1.3 phpdoc/en/reference/http/HttpResponse/send.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/send.xml:1.3 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/send.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-send"> <refnamediv> @@ -13,15 +13,14 @@ <type>bool</type><methodname>HttpResponse::send</methodname> <methodparam choice="opt"><type>bool</type><parameter>clean_ob = TRUE</parameter></methodparam> </methodsynopsis> - <para> Finally send the entity. </para> <para> - 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; + <link linkend="http.configuration.log.cache">http.log.cache</link> is set. + &see.http.configuration.force_exit; </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -45,13 +44,14 @@ </para> </refsect1> + <!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpHeaderException, HttpResponseException </para> </refsect1> - + --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -99,17 +99,14 @@ </refsect1> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-capture"><function><classname>HttpResponse</classname>::capture</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setBufferSize.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setBufferSize.xml diff -u phpdoc/en/reference/http/HttpResponse/setBufferSize.xml:1.2 phpdoc/en/reference/http/HttpResponse/setBufferSize.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setBufferSize.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setBufferSize.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setBufferSize"> <refnamediv> @@ -13,20 +13,15 @@ <type>bool</type><methodname>HttpResponse::setBufferSize</methodname> <methodparam><type>int</type><parameter>bytes</parameter></methodparam> </methodsynopsis> - - <para> - Sets the send buffer size for use with HttpResponse::setThrottleDelay(). - </para> <para> - 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. </para> + ¬e.http.throttling.yields.process; <note> <para> - This doesn't really work with the FastCGI SAPI. + &http.maynotwork.SAPI; FastCGI. </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -117,17 +112,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setCache.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setCache.xml diff -u phpdoc/en/reference/http/HttpResponse/setCache.xml:1.2 phpdoc/en/reference/http/HttpResponse/setCache.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setCache.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setCache.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setCache"> <refnamediv> @@ -13,7 +13,6 @@ <type>bool</type><methodname>HttpResponse::setCache</methodname> <methodparam><type>bool</type><parameter>cache</parameter></methodparam> </methodsynopsis> - <para> Whether it should be attempted to cache the entity. </para> @@ -28,7 +27,6 @@ to something more appropriate than "no-cache"! </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -119,17 +117,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCachel</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setCacheControl.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setCacheControl.xml diff -u phpdoc/en/reference/http/HttpResponse/setCacheControl.xml:1.3 phpdoc/en/reference/http/HttpResponse/setCacheControl.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/setCacheControl.xml:1.3 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setCacheControl.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setCacheControl"> <refnamediv> @@ -15,11 +15,9 @@ <methodparam choice="opt"><type>int</type><parameter>max_age = 0</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>must_revalidate = TRUE</parameter></methodparam> </methodsynopsis> - <para> - Define a custom cache-control header, usually being <emphasis>private</emphasis> or <emphasis>public</emphasis>; + Define a custom <literal>Cache-Control</literal> header, usually being <emphasis>private</emphasis> or <emphasis>public</emphasis>; </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -55,17 +53,18 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns TRUE on success, or FALSE if control does not match one of <emphasis>public</emphasis>, <emphasis>private</emphasis> or <emphasis>no-cache</emphasis>. + Returns &true; on success, or &false; if control does not match one of <emphasis>public</emphasis>, <emphasis>private</emphasis> or <emphasis>no-cache</emphasis>. </para> </refsect1> +<!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpInvalidParamException. </para> </refsect1> - +--> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -124,17 +123,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCachel</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml diff -u phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml:1.2 phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setContentDisposition"> <refnamediv> @@ -11,16 +11,13 @@ <methodsynopsis> <modifier>static</modifier> <type>bool</type><methodname>HttpResponse::setContentDisposition</methodname> - <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>inline = FALSE</parameter></methodparam> </methodsynopsis> - <para> - 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 <literal>Content-Disposition</literal>. + &http.content.disposition; </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -121,17 +118,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setContentType.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setContentType.xml diff -u phpdoc/en/reference/http/HttpResponse/setContentType.xml:1.2 phpdoc/en/reference/http/HttpResponse/setContentType.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setContentType.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setContentType.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setContentType"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setContentType</methodname> <methodparam><type>string</type><parameter>content_type</parameter></methodparam> </methodsynopsis> - <para> - Set the content-type of the sent entity. + Set the <literal>Content-Type</literal> of the sent entity. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -37,18 +35,19 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - 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. </para> </refsect1> + <!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpInvalidParamException. </para> </refsect1> - + --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -107,17 +106,17 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-guessContentType"><function><classname>HttpResponse</classname>::guessContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setData.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setData.xml diff -u phpdoc/en/reference/http/HttpResponse/setData.xml:1.2 phpdoc/en/reference/http/HttpResponse/setData.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setData.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setData.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setData"> <refnamediv> @@ -13,11 +13,10 @@ <type>bool</type><methodname>HttpResponse::setData</methodname> <methodparam><type>mixed</type><parameter>data</parameter></methodparam> </methodsynopsis> - <para> Set the data to be sent. </para> - + ¬e.http.response.recalculate.etag.lm; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +107,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setETag.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setETag.xml diff -u phpdoc/en/reference/http/HttpResponse/setETag.xml:1.2 phpdoc/en/reference/http/HttpResponse/setETag.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setETag.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setETag.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setETag"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setETag</methodname> <methodparam><type>string</type><parameter>etag</parameter></methodparam> </methodsynopsis> - <para> - Set a custom ETag. Use this only if you know what you're doing. + Set a custom <literal>ETag</literal>. Use this only if you know what you're doing. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +106,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setFile.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setFile.xml diff -u phpdoc/en/reference/http/HttpResponse/setFile.xml:1.2 phpdoc/en/reference/http/HttpResponse/setFile.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setFile.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setFile.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setFile"> <refnamediv> @@ -13,11 +13,10 @@ <type>bool</type><methodname>HttpResponse::setFile</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> - <para> Set the file to be sent. </para> - + ¬e.http.response.recalculate.etag.lm; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +107,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setGzip.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setGzip.xml diff -u phpdoc/en/reference/http/HttpResponse/setGzip.xml:1.2 phpdoc/en/reference/http/HttpResponse/setGzip.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setGzip.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setGzip.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setGzip"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setGzip</methodname> <methodparam><type>bool</type><parameter>gzip</parameter></methodparam> </methodsynopsis> - <para> - Enable on-thy-fly gzipping of the sent entity. + Enable on-thy-fly gzip'ing of the sent entity. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +106,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getGzip"><function><classname>HttpResponse</classname>::getGzip</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setHeader.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setHeader.xml diff -u phpdoc/en/reference/http/HttpResponse/setHeader.xml:1.2 phpdoc/en/reference/http/HttpResponse/setHeader.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setHeader.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setHeader.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setHeader"> <refnamediv> @@ -15,11 +15,9 @@ <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>replace = TRUE</parameter></methodparam> </methodsynopsis> - <para> Send an HTTP header. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -60,13 +58,14 @@ </para> </refsect1> + <!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpHeaderException. </para> </refsect1> - + --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -125,17 +124,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getHeader"><function><classname>HttpResponse</classname>::getHeader</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setLastModified.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setLastModified.xml diff -u phpdoc/en/reference/http/HttpResponse/setLastModified.xml:1.3 phpdoc/en/reference/http/HttpResponse/setLastModified.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/setLastModified.xml:1.3 Thu Feb 15 09:24:35 2007 +++ phpdoc/en/reference/http/HttpResponse/setLastModified.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setLastModified"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setLastModified</methodname> <methodparam><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> - <para> - Set a custom Last-Modified date. + Set a custom <literal>Last-Modified</literal> date. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +106,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setStream.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setStream.xml diff -u phpdoc/en/reference/http/HttpResponse/setStream.xml:1.2 phpdoc/en/reference/http/HttpResponse/setStream.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setStream.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setStream.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setStream"> <refnamediv> @@ -13,11 +13,10 @@ <type>bool</type><methodname>HttpResponse::setStream</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> </methodsynopsis> - <para> Set the resource to be sent. </para> - + ¬e.http.response.recalculate.etag.lm; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +107,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml diff -u phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml:1.3 phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml:1.3 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setThrottleDelay"> <refnamediv> @@ -13,20 +13,15 @@ <type>bool</type><methodname>HttpResponse::setThrottleDelay</methodname> <methodparam><type>double</type><parameter>seconds</parameter></methodparam> </methodsynopsis> - - <para> - Sets the throttle delay for use with HttpResponse::setBufferSize(). - </para> <para> - 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. </para> + ¬e.http.throttling.yields.process; <note> <para> - This doesn't really work with the FastCGI SAPI. + &http.maynotwork.SAPI; FastCGI. </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -36,7 +31,7 @@ <term><parameter>seconds</parameter></term> <listitem> <para> - The seconds to sleep after each chunk sent + seconds to sleep after each chunk sent </para> </listitem> </varlistentry> @@ -117,17 +112,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-throttle.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/http/functions/responses/http-throttle.xml diff -u phpdoc/en/reference/http/functions/responses/http-throttle.xml:1.6 phpdoc/en/reference/http/functions/responses/http-throttle.xml:1.7 --- phpdoc/en/reference/http/functions/responses/http-throttle.xml:1.6 Thu Apr 5 18:16:50 2007 +++ phpdoc/en/reference/http/functions/responses/http-throttle.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-throttle"> <refnamediv> @@ -16,11 +16,13 @@ <para> Sets the throttle delay and send buffer size. </para> - <para> - Provides a basic throttling mechanism, which will yield the current process - resp. thread until the entity has been completely sent. - </para> ¬e.http.send.API; + ¬e.http.throttling.yields.process; + <note> + <para> + &http.maynotwork.SAPI; FastCGI. + </para> + </note> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getRequestBody.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/getRequestBody.xml +++ phpdoc/en/reference/http/HttpResponse/getRequestBody.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getRequestBody"> <refnamediv> <refname>HttpResponse::getRequestBody</refname> <refpurpose>Get request body</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>string</type><methodname>HttpResponse::getRequestBody</methodname> <void/> </methodsynopsis> <para> &info.function.alias; <function>http_get_request_body</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getRequestBodyStream.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/getRequestBodyStream.xml +++ phpdoc/en/reference/http/HttpResponse/getRequestBodyStream.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getRequestBodyStream"> <refnamediv> <refname>HttpResponse::getRequestBodyStream</refname> <refpurpose>Get request body stream</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>resource</type><methodname>HttpResponse::getRequestBodyStream</methodname> <void/> </methodsynopsis> <para> &info.function.alias; <function>http_get_request_body_stream</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getRequestHeaders.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/getRequestHeaders.xml +++ phpdoc/en/reference/http/HttpResponse/getRequestHeaders.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getRequestHeaders"> <refnamediv> <refname>HttpResponse::getRequestHeaders</refname> <refpurpose>Get request headers</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>array</type><methodname>HttpResponse::getRequestHeaders</methodname> <void/> </methodsynopsis> <para> &info.function.alias; <function>http_get_request_headers</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/redirect.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/redirect.xml +++ phpdoc/en/reference/http/HttpResponse/redirect.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-redirect"> <refnamediv> <refname>HttpResponse::redirect</refname> <refpurpose>Redirect</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>void</type><methodname>HttpResponse::redirect</methodname> <methodparam choice="opt"><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>session = FALSE</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>status</parameter></methodparam> </methodsynopsis> <para> &info.function.alias; <function>http_redirect</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/status.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/status.xml +++ phpdoc/en/reference/http/HttpResponse/status.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-status"> <refnamediv> <refname>HttpResponse::status</refname> <refpurpose>Redirect</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>bool</type><methodname>HttpResponse::status</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> </methodsynopsis> <para> &info.function.alias; <function>http_send_status</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->
http://cvs.php.net/viewvc.cgi/phpdoc/en/language-snippets.ent?r1=1.197&r2=1.198&diff_format=u Index: phpdoc/en/language-snippets.ent diff -u phpdoc/en/language-snippets.ent:1.197 phpdoc/en/language-snippets.ent:1.198 --- phpdoc/en/language-snippets.ent:1.197 Thu Apr 5 18:16:49 2007 +++ phpdoc/en/language-snippets.ent Sat Apr 7 16:37:12 2007 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.197 $ --> +<!-- $Revision: 1.198 $ --> <!-- Keep 'em sorted --> @@ -783,7 +783,15 @@ <!ENTITY http.request.affects.any 'Affects any request method.'> <!ENTITY http.response.class.php51 'the <link linkend="http.HttpResponse"><classname >HttpResponse</classname></link> class if you are using PHP-5.1 and above'> - +<!ENTITY http.maynotwork.SAPI 'This may not work as expected with the following SAPI(s):'> +<!ENTITY http.content.disposition 'The <literal>Content-Disposition</literal> 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).'> + +<!ENTITY note.http.response.recalculate.etag.lm '<note><simpara>Previously calculated or defined <literal>ETag</literal> + and <literal>Last-Modified</literal> will be recalculated and redefined.</simpara></note>'> +<!ENTITY note.http.throttling.yields.process '<note><simpara>Provides a basic throttling mechanism, which will yield + the current process respectively thread until the entity has been completely sent.</simpara></note>'> <!ENTITY note.http.send.API '<note><simpara>This function is supposed to be used in conjunction with <function>http_send_data</function>, <function>http_send_file</function> &listendand; <function>http_send_stream</function>.</simpara></note>'> <!ENTITY note.http.send.API.mayuse '<note><simpara>This function may be used in conjunction with http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse.xml diff -u phpdoc/en/reference/http/HttpResponse.xml:1.3 phpdoc/en/reference/http/HttpResponse.xml:1.4 --- phpdoc/en/reference/http/HttpResponse.xml:1.3 Thu Apr 5 18:23:30 2007 +++ phpdoc/en/reference/http/HttpResponse.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="http.HttpResponse"> <refnamediv> @@ -129,38 +129,45 @@ </tbody> </tgroup> </table> - </refsect2> <refsect2 id="http.HttpResponse.methods"> + </refsect2> + <refsect2 id="http.HttpResponse.methods"> &reftitle.methods; <simplelist> - <member><link linkend="function.HttpResponse-getBufferSize"><classname>HttpResponse</classname>::<function>getBufferSize</function></link></member> - <member><link linkend="function.HttpResponse-setBufferSize"><classname>HttpResponse</classname>::<function>setBufferSize</function></link></member> - <member><link linkend="function.HttpResponse-getCacheControl"><classname>HttpResponse</classname>::<function>getCacheControl</function></link></member> - <member><link linkend="function.HttpResponse-setCacheControl"><classname>HttpResponse</classname>::<function>setCacheControl</function></link></member> - <member><link linkend="function.HttpResponse-getCache"><classname>HttpResponse</classname>::<function>getCache</function></link></member> - <member><link linkend="function.HttpResponse-setCache"><classname>HttpResponse</classname>::<function>setCache</function></link></member> - <member><link linkend="function.HttpResponse-getContentDisposition"><classname>HttpResponse</classname>::<function>getContentDisposition</function></link></member> - <member><link linkend="function.HttpResponse-setContentDisposition"><classname>HttpResponse</classname>::<function>setContentDisposition</function></link></member> - <member><link linkend="function.HttpResponse-getContentType"><classname>HttpResponse</classname>::<function>getContentType</function></link></member> - <member><link linkend="function.HttpResponse-setContentType"><classname>HttpResponse</classname>::<function>setContentType</function></link></member> - <member><link linkend="function.HttpResponse-getData"><classname>HttpResponse</classname>::<function>getData</function></link></member> - <member><link linkend="function.HttpResponse-setData"><classname>HttpResponse</classname>::<function>setData</function></link></member> - <member><link linkend="function.HttpResponse-getETag"><classname>HttpResponse</classname>::<function>getETag</function></link></member> - <member><link linkend="function.HttpResponse-setETag"><classname>HttpResponse</classname>::<function>setETag</function></link></member> - <member><link linkend="function.HttpResponse-getFile"><classname>HttpResponse</classname>::<function>getFile</function></link></member> - <member><link linkend="function.HttpResponse-setFile"><classname>HttpResponse</classname>::<function>setFile</function></link></member> - <member><link linkend="function.HttpResponse-getGzip"><classname>HttpResponse</classname>::<function>getGzip</function></link></member> - <member><link linkend="function.HttpResponse-setGzip"><classname>HttpResponse</classname>::<function>setGzip</function></link></member> - <member><link linkend="function.HttpResponse-getHeader"><classname>HttpResponse</classname>::<function>getHeader</function></link></member> - <member><link linkend="function.HttpResponse-setHeader"><classname>HttpResponse</classname>::<function>setHeader</function></link></member> - <member><link linkend="function.HttpResponse-getLastModified"><classname>HttpResponse</classname>::<function>getLastModified</function></link></member> - <member><link linkend="function.HttpResponse-setLastModified"><classname>HttpResponse</classname>::<function>setLastModified</function></link></member> - <member><link linkend="function.HttpResponse-getStream"><classname>HttpResponse</classname>::<function>getStream</function></link></member> - <member><link linkend="function.HttpResponse-setStream"><classname>HttpResponse</classname>::<function>setStream</function></link></member> - <member><link linkend="function.HttpResponse-getThrottleDelay"><classname>HttpResponse</classname>::<function>getThrottleDelay</function></link></member> - <member><link linkend="function.HttpResponse-setThrottleDelay"><classname>HttpResponse</classname>::<function>setThrottleDelay</function></link></member> - <member><link linkend="function.HttpResponse-capture"><classname>HttpResponse</classname>::<function>capture</function></link></member> - <member><link linkend="function.HttpResponse-send"><classname>HttpResponse</classname>::<function>send</function></link></member> - <member><link linkend="function.HttpResponse-guessContentType"><classname>HttpResponse</classname>::<function>guessContentType</function></link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCache</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getGzip"><function><classname>HttpResponse</classname>::getGzip</function></link></member> + <member><link linkend="function.HttpResponse-setGzip"><function><classname>HttpResponse</classname>::setGzip</function></link></member> + <member><link linkend="function.HttpResponse-getHeader"><function><classname>HttpResponse</classname>::getHeader</function></link></member> + <member><link linkend="function.HttpResponse-setHeader"><function><classname>HttpResponse</classname>::setHeader</function></link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-redirect"><function><classname>HttpResponse</classname>::redirect</function></link></member> + <member><link linkend="function.HttpResponse-capture"><function><classname>HttpResponse</classname>::capture</function></link></member> + <member><link linkend="function.HttpResponse-send"><function><classname>HttpResponse</classname>::send</function></link></member> + <member><link linkend="function.HttpResponse-guessContentType"><function><classname>HttpResponse</classname>::guessContentType</function></link></member> + <member><link linkend="function.HttpResponse-redirect"><function><classname>HttpResponse</classname>::redirect</function></link></member> + <member><link linkend="function.HttpResponse-status"><function><classname>HttpResponse</classname>::status</function></link></member> + <member><link linkend="function.HttpResponse-getRequestHeaders"><function><classname>HttpResponse</classname>::getRequestHeaders</function></link></member> + <member><link linkend="function.HttpResponse-getRequestBody"><function><classname>HttpResponse</classname>::getRequestBody</function></link></member> + <member><link linkend="function.HttpResponse-getRequestBodyStream"><function><classname>HttpResponse</classname>::getRequestBodyStream</function></link></member> </simplelist> </refsect2> </refsect1> @@ -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; <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/capture.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/capture.xml diff -u phpdoc/en/reference/http/HttpResponse/capture.xml:1.2 phpdoc/en/reference/http/HttpResponse/capture.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/capture.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/capture.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-capture"> <refnamediv> @@ -13,11 +13,9 @@ <type>void</type><methodname>HttpResponse::capture</methodname> <void/> </methodsynopsis> - <para> Capture script output. </para> - </refsect1> <!-- Use when ERRORS exist @@ -74,17 +72,14 @@ </refsect1> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-capture"><function><classname>HttpResponse</classname>::capture</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getBufferSize.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getBufferSize.xml diff -u phpdoc/en/reference/http/HttpResponse/getBufferSize.xml:1.2 phpdoc/en/reference/http/HttpResponse/getBufferSize.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getBufferSize.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getBufferSize.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getBufferSize"> <refnamediv> @@ -13,11 +13,9 @@ <type>int</type><methodname>HttpResponse::getBufferSize</methodname> <void/> </methodsynopsis> - <para> Get current buffer size. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getCache.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getCache.xml diff -u phpdoc/en/reference/http/HttpResponse/getCache.xml:1.2 phpdoc/en/reference/http/HttpResponse/getCache.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getCache.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getCache.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getCache"> <refnamediv> @@ -13,16 +13,14 @@ <type>bool</type><methodname>HttpResponse::getCache</methodname> <void/> </methodsynopsis> - <para> Get current caching setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns TRUE if caching should be attempted, else FALSE. + Returns &true; if caching should be attempted, else &false;. </para> </refsect1> @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getCacheControl.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getCacheControl.xml diff -u phpdoc/en/reference/http/HttpResponse/getCacheControl.xml:1.2 phpdoc/en/reference/http/HttpResponse/getCacheControl.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getCacheControl.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getCacheControl.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getCacheControl"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getCacheControl</methodname> <void/> </methodsynopsis> - <para> - Get current Cache-Control header setting. + Get current <literal>Cache-Control</literal> header setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCachel</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml diff -u phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml:1.2 phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getContentDisposition.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getContentDisposition"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getContentDisposition</methodname> <void/> </methodsynopsis> - <para> - Get current Content-Disposition setting. + Get current <literal>Content-Disposition</literal> setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getContentType.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getContentType.xml diff -u phpdoc/en/reference/http/HttpResponse/getContentType.xml:1.2 phpdoc/en/reference/http/HttpResponse/getContentType.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getContentType.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getContentType.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getContentType"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getContentType</methodname> <void/> </methodsynopsis> - <para> - Get current Content-Type header setting. + Get current <literal>Content-Type</literal> header setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,17 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> + <member><link linkend="function.HttpResponse-guessContentType"><function><classname>HttpResponse</classname>::guessContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getData.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getData.xml diff -u phpdoc/en/reference/http/HttpResponse/getData.xml:1.2 phpdoc/en/reference/http/HttpResponse/getData.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getData.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getData.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getData"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getData</methodname> <void/> </methodsynopsis> - <para> Get the previously set data to be sent. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getETag.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getETag.xml diff -u phpdoc/en/reference/http/HttpResponse/getETag.xml:1.2 phpdoc/en/reference/http/HttpResponse/getETag.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getETag.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getETag.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getETag"> <refnamediv> @@ -13,16 +13,14 @@ <type>string</type><methodname>HttpResponse::getETag</methodname> <void/> </methodsynopsis> - <para> Get calculated or previously set custom ETag. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the calculated or previously set ETag as unquoted string. + Returns the calculated or previously set <literal>ETag</literal> as unquoted string. </para> </refsect1> @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getFile.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getFile.xml diff -u phpdoc/en/reference/http/HttpResponse/getFile.xml:1.2 phpdoc/en/reference/http/HttpResponse/getFile.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getFile.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getFile.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getFile"> <refnamediv> @@ -13,11 +13,9 @@ <type>string</type><methodname>HttpResponse::getFile</methodname> <void/> </methodsynopsis> - <para> Get the previously set file to be sent. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getGzip.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getGzip.xml diff -u phpdoc/en/reference/http/HttpResponse/getGzip.xml:1.2 phpdoc/en/reference/http/HttpResponse/getGzip.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getGzip.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getGzip.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getGzip"> <refnamediv> @@ -13,16 +13,14 @@ <type>bool</type><methodname>HttpResponse::getGzip</methodname> <void/> </methodsynopsis> - <para> - Get current gzipping setting. + Get current gzip'ing setting. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns TRUE if GZip compression is enabled, else FALSE. + Returns &true; if GZip compression is enabled, else &false;. </para> </refsect1> @@ -93,17 +91,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setGzip"><function><classname>HttpResponse</classname>::setGzip</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getHeader.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getHeader.xml diff -u phpdoc/en/reference/http/HttpResponse/getHeader.xml:1.2 phpdoc/en/reference/http/HttpResponse/getHeader.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getHeader.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getHeader.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getHeader"> <refnamediv> @@ -13,16 +13,14 @@ <type>mixed</type><methodname>HttpResponse::getHeader</methodname> <methodparam choice="opt"><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> - <para> Get header(s) about to be sent. </para> <note> <para> - In Apache2 this only works for PHP-5.1.3 and greater. + &http.maynotwork.SAPI; Apache2 w/PHP < 5.1.3. </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -44,7 +42,7 @@ &reftitle.returnvalues; <para> 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. </para> </refsect1> @@ -115,17 +113,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setHeader"><function><classname>HttpResponse</classname>::setHeader</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getLastModified.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getLastModified.xml diff -u phpdoc/en/reference/http/HttpResponse/getLastModified.xml:1.3 phpdoc/en/reference/http/HttpResponse/getLastModified.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/getLastModified.xml:1.3 Thu Feb 15 09:24:35 2007 +++ phpdoc/en/reference/http/HttpResponse/getLastModified.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getLastModified"> <refnamediv> @@ -13,11 +13,9 @@ <type>int</type><methodname>HttpResponse::getLastModified</methodname> <void/> </methodsynopsis> - <para> - Get calculated or previously set custom Last-Modified date. + Get calculated or previously set custom <literal>Last-Modified</literal> date. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getStream.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getStream.xml diff -u phpdoc/en/reference/http/HttpResponse/getStream.xml:1.2 phpdoc/en/reference/http/HttpResponse/getStream.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getStream.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getStream.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getStream"> <refnamediv> @@ -13,11 +13,9 @@ <type>resource</type><methodname>HttpResponse::getStream</methodname> <void/> </methodsynopsis> - <para> Get the previously set resource to be sent. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -98,17 +96,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml diff -u phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml:1.2 phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/getThrottleDelay.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getThrottleDelay"> <refnamediv> @@ -13,11 +13,9 @@ <type>double</type><methodname>HttpResponse::getThrottleDelay</methodname> <void/> </methodsynopsis> - <para> Get the current throttle delay. </para> - </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -93,17 +91,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/guessContentType.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/guessContentType.xml diff -u phpdoc/en/reference/http/HttpResponse/guessContentType.xml:1.2 phpdoc/en/reference/http/HttpResponse/guessContentType.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/guessContentType.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/guessContentType.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-guessContentType"> <refnamediv> @@ -11,18 +11,16 @@ <methodsynopsis> <modifier>static</modifier> <type>string</type><methodname>HttpResponse::guessContentType</methodname> - <methodparam choice="opt"><type>string</type><parameter>magic_file</parameter></methodparam> + <methodparam><type>string</type><parameter>magic_file</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>magic_mode=MAGIC_MIME</parameter></methodparam> </methodsynopsis> - <para> Attempts to guess the content type of supplied payload through libmagic. </para> <para> - If the attempt is successful, the guessed content type will automatically - be set as response content type. + If the attempt is successful, the guessed <literal>Content-Type</literal> will automatically + be set as response <literal>Content-Type</literal>. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -50,7 +48,7 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns the guessed content type on success, or FALSE on failure. + Returns the guessed content type on success, or &false; on failure. </para> </refsect1> @@ -119,17 +117,15 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/send.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/send.xml diff -u phpdoc/en/reference/http/HttpResponse/send.xml:1.3 phpdoc/en/reference/http/HttpResponse/send.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/send.xml:1.3 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/send.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-send"> <refnamediv> @@ -13,15 +13,14 @@ <type>bool</type><methodname>HttpResponse::send</methodname> <methodparam choice="opt"><type>bool</type><parameter>clean_ob = TRUE</parameter></methodparam> </methodsynopsis> - <para> Finally send the entity. </para> <para> - 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; + <link linkend="http.configuration.log.cache">http.log.cache</link> is set. + &see.http.configuration.force_exit; </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -45,13 +44,14 @@ </para> </refsect1> + <!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpHeaderException, HttpResponseException </para> </refsect1> - + --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -99,17 +99,14 @@ </refsect1> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-capture"><function><classname>HttpResponse</classname>::capture</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setBufferSize.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setBufferSize.xml diff -u phpdoc/en/reference/http/HttpResponse/setBufferSize.xml:1.2 phpdoc/en/reference/http/HttpResponse/setBufferSize.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setBufferSize.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setBufferSize.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setBufferSize"> <refnamediv> @@ -13,20 +13,15 @@ <type>bool</type><methodname>HttpResponse::setBufferSize</methodname> <methodparam><type>int</type><parameter>bytes</parameter></methodparam> </methodsynopsis> - - <para> - Sets the send buffer size for use with HttpResponse::setThrottleDelay(). - </para> <para> - 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. </para> + ¬e.http.throttling.yields.process; <note> <para> - This doesn't really work with the FastCGI SAPI. + &http.maynotwork.SAPI; FastCGI. </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -117,17 +112,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> + <member><link linkend="function.HttpResponse-setThrottleDelay"><function><classname>HttpResponse</classname>::setThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setCache.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setCache.xml diff -u phpdoc/en/reference/http/HttpResponse/setCache.xml:1.2 phpdoc/en/reference/http/HttpResponse/setCache.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setCache.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setCache.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setCache"> <refnamediv> @@ -13,7 +13,6 @@ <type>bool</type><methodname>HttpResponse::setCache</methodname> <methodparam><type>bool</type><parameter>cache</parameter></methodparam> </methodsynopsis> - <para> Whether it should be attempted to cache the entity. </para> @@ -28,7 +27,6 @@ to something more appropriate than "no-cache"! </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -119,17 +117,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-setCacheControl"><function><classname>HttpResponse</classname>::setCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCachel</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setCacheControl.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setCacheControl.xml diff -u phpdoc/en/reference/http/HttpResponse/setCacheControl.xml:1.3 phpdoc/en/reference/http/HttpResponse/setCacheControl.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/setCacheControl.xml:1.3 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setCacheControl.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setCacheControl"> <refnamediv> @@ -15,11 +15,9 @@ <methodparam choice="opt"><type>int</type><parameter>max_age = 0</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>must_revalidate = TRUE</parameter></methodparam> </methodsynopsis> - <para> - Define a custom cache-control header, usually being <emphasis>private</emphasis> or <emphasis>public</emphasis>; + Define a custom <literal>Cache-Control</literal> header, usually being <emphasis>private</emphasis> or <emphasis>public</emphasis>; </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -55,17 +53,18 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Returns TRUE on success, or FALSE if control does not match one of <emphasis>public</emphasis>, <emphasis>private</emphasis> or <emphasis>no-cache</emphasis>. + Returns &true; on success, or &false; if control does not match one of <emphasis>public</emphasis>, <emphasis>private</emphasis> or <emphasis>no-cache</emphasis>. </para> </refsect1> +<!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpInvalidParamException. </para> </refsect1> - +--> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -124,17 +123,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getCacheControl"><function><classname>HttpResponse</classname>::getCacheControl</function></link></member> + <member><link linkend="function.HttpResponse-setCache"><function><classname>HttpResponse</classname>::setCache</function></link></member> + <member><link linkend="function.HttpResponse-getCache"><function><classname>HttpResponse</classname>::getCachel</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml diff -u phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml:1.2 phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setContentDisposition.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setContentDisposition"> <refnamediv> @@ -11,16 +11,13 @@ <methodsynopsis> <modifier>static</modifier> <type>bool</type><methodname>HttpResponse::setContentDisposition</methodname> - <methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>inline = FALSE</parameter></methodparam> </methodsynopsis> - <para> - 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 <literal>Content-Disposition</literal>. + &http.content.disposition; </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -121,17 +118,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-setContentType"><function><classname>HttpResponse</classname>::setContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setContentType.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setContentType.xml diff -u phpdoc/en/reference/http/HttpResponse/setContentType.xml:1.2 phpdoc/en/reference/http/HttpResponse/setContentType.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setContentType.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setContentType.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setContentType"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setContentType</methodname> <methodparam><type>string</type><parameter>content_type</parameter></methodparam> </methodsynopsis> - <para> - Set the content-type of the sent entity. + Set the <literal>Content-Type</literal> of the sent entity. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -37,18 +35,19 @@ <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - 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. </para> </refsect1> + <!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpInvalidParamException. </para> </refsect1> - + --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -107,17 +106,17 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getContentDisposition"><function><classname>HttpResponse</classname>::getContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-setContentDisposition"><function><classname>HttpResponse</classname>::setContentDisposition</function></link></member> + <member><link linkend="function.HttpResponse-getContentType"><function><classname>HttpResponse</classname>::getContentType</function></link></member> + <member><link linkend="function.HttpResponse-guessContentType"><function><classname>HttpResponse</classname>::guessContentType</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setData.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setData.xml diff -u phpdoc/en/reference/http/HttpResponse/setData.xml:1.2 phpdoc/en/reference/http/HttpResponse/setData.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setData.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setData.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setData"> <refnamediv> @@ -13,11 +13,10 @@ <type>bool</type><methodname>HttpResponse::setData</methodname> <methodparam><type>mixed</type><parameter>data</parameter></methodparam> </methodsynopsis> - <para> Set the data to be sent. </para> - + ¬e.http.response.recalculate.etag.lm; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +107,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setETag.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setETag.xml diff -u phpdoc/en/reference/http/HttpResponse/setETag.xml:1.2 phpdoc/en/reference/http/HttpResponse/setETag.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setETag.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setETag.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setETag"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setETag</methodname> <methodparam><type>string</type><parameter>etag</parameter></methodparam> </methodsynopsis> - <para> - Set a custom ETag. Use this only if you know what you're doing. + Set a custom <literal>ETag</literal>. Use this only if you know what you're doing. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +106,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-setLastModified"><function><classname>HttpResponse</classname>::setLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setFile.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setFile.xml diff -u phpdoc/en/reference/http/HttpResponse/setFile.xml:1.2 phpdoc/en/reference/http/HttpResponse/setFile.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setFile.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setFile.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setFile"> <refnamediv> @@ -13,11 +13,10 @@ <type>bool</type><methodname>HttpResponse::setFile</methodname> <methodparam><type>string</type><parameter>file</parameter></methodparam> </methodsynopsis> - <para> Set the file to be sent. </para> - + ¬e.http.response.recalculate.etag.lm; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +107,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> + <member><link linkend="function.HttpResponse-setStream"><function><classname>HttpResponse</classname>::setStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setGzip.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setGzip.xml diff -u phpdoc/en/reference/http/HttpResponse/setGzip.xml:1.2 phpdoc/en/reference/http/HttpResponse/setGzip.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setGzip.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setGzip.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setGzip"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setGzip</methodname> <methodparam><type>bool</type><parameter>gzip</parameter></methodparam> </methodsynopsis> - <para> - Enable on-thy-fly gzipping of the sent entity. + Enable on-thy-fly gzip'ing of the sent entity. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +106,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getGzip"><function><classname>HttpResponse</classname>::getGzip</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setHeader.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setHeader.xml diff -u phpdoc/en/reference/http/HttpResponse/setHeader.xml:1.2 phpdoc/en/reference/http/HttpResponse/setHeader.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setHeader.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setHeader.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setHeader"> <refnamediv> @@ -15,11 +15,9 @@ <methodparam choice="opt"><type>mixed</type><parameter>value</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>replace = TRUE</parameter></methodparam> </methodsynopsis> - <para> Send an HTTP header. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -60,13 +58,14 @@ </para> </refsect1> + <!-- <refsect1 role="errors"> &reftitle.errors; <para> Throws HttpHeaderException. </para> </refsect1> - + --> <!-- Use when a CHANGELOG exists <refsect1 role="changelog"> @@ -125,17 +124,14 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getHeader"><function><classname>HttpResponse</classname>::getHeader</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setLastModified.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setLastModified.xml diff -u phpdoc/en/reference/http/HttpResponse/setLastModified.xml:1.3 phpdoc/en/reference/http/HttpResponse/setLastModified.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/setLastModified.xml:1.3 Thu Feb 15 09:24:35 2007 +++ phpdoc/en/reference/http/HttpResponse/setLastModified.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setLastModified"> <refnamediv> @@ -13,11 +13,9 @@ <type>bool</type><methodname>HttpResponse::setLastModified</methodname> <methodparam><type>int</type><parameter>timestamp</parameter></methodparam> </methodsynopsis> - <para> - Set a custom Last-Modified date. + Set a custom <literal>Last-Modified</literal> date. </para> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +106,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getLastModified"><function><classname>HttpResponse</classname>::getLastModified</function></link></member> + <member><link linkend="function.HttpResponse-getETag"><function><classname>HttpResponse</classname>::getETag</function></link></member> + <member><link linkend="function.HttpResponse-setETag"><function><classname>HttpResponse</classname>::setETag</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setStream.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setStream.xml diff -u phpdoc/en/reference/http/HttpResponse/setStream.xml:1.2 phpdoc/en/reference/http/HttpResponse/setStream.xml:1.3 --- phpdoc/en/reference/http/HttpResponse/setStream.xml:1.2 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setStream.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setStream"> <refnamediv> @@ -13,11 +13,10 @@ <type>bool</type><methodname>HttpResponse::setStream</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> </methodsynopsis> - <para> Set the resource to be sent. </para> - + ¬e.http.response.recalculate.etag.lm; </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -108,17 +107,18 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getData"><function><classname>HttpResponse</classname>::getData</function></link></member> + <member><link linkend="function.HttpResponse-setData"><function><classname>HttpResponse</classname>::setData</function></link></member> + <member><link linkend="function.HttpResponse-getFile"><function><classname>HttpResponse</classname>::getFile</function></link></member> + <member><link linkend="function.HttpResponse-setFile"><function><classname>HttpResponse</classname>::setFile</function></link></member> + <member><link linkend="function.HttpResponse-getStream"><function><classname>HttpResponse</classname>::getStream</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml diff -u phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml:1.3 phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml:1.4 --- phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml:1.3 Wed Sep 6 20:40:37 2006 +++ phpdoc/en/reference/http/HttpResponse/setThrottleDelay.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-setThrottleDelay"> <refnamediv> @@ -13,20 +13,15 @@ <type>bool</type><methodname>HttpResponse::setThrottleDelay</methodname> <methodparam><type>double</type><parameter>seconds</parameter></methodparam> </methodsynopsis> - - <para> - Sets the throttle delay for use with HttpResponse::setBufferSize(). - </para> <para> - 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. </para> + ¬e.http.throttling.yields.process; <note> <para> - This doesn't really work with the FastCGI SAPI. + &http.maynotwork.SAPI; FastCGI. </para> </note> - </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -36,7 +31,7 @@ <term><parameter>seconds</parameter></term> <listitem> <para> - The seconds to sleep after each chunk sent + seconds to sleep after each chunk sent </para> </listitem> </varlistentry> @@ -117,17 +112,16 @@ --> - <!-- Use when adding See Also links <refsect1 role="seealso"> &reftitle.seealso; <para> <simplelist> - <member><function></function></member> - <member>Or <link linkend="somethingelse">something else</link></member> + <member><link linkend="function.HttpResponse-getBufferSize"><function><classname>HttpResponse</classname>::getBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-setBufferSize"><function><classname>HttpResponse</classname>::setBufferSize</function></link></member> + <member><link linkend="function.HttpResponse-getThrottleDelay"><function><classname>HttpResponse</classname>::getThrottleDelay</function></link></member> </simplelist> </para> </refsect1> - --> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/responses/http-throttle.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/http/functions/responses/http-throttle.xml diff -u phpdoc/en/reference/http/functions/responses/http-throttle.xml:1.6 phpdoc/en/reference/http/functions/responses/http-throttle.xml:1.7 --- phpdoc/en/reference/http/functions/responses/http-throttle.xml:1.6 Thu Apr 5 18:16:50 2007 +++ phpdoc/en/reference/http/functions/responses/http-throttle.xml Sat Apr 7 16:37:13 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> +<!-- $Revision: 1.7 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.http-throttle"> <refnamediv> @@ -16,11 +16,13 @@ <para> Sets the throttle delay and send buffer size. </para> - <para> - Provides a basic throttling mechanism, which will yield the current process - resp. thread until the entity has been completely sent. - </para> ¬e.http.send.API; + ¬e.http.throttling.yields.process; + <note> + <para> + &http.maynotwork.SAPI; FastCGI. + </para> + </note> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getRequestBody.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/getRequestBody.xml +++ phpdoc/en/reference/http/HttpResponse/getRequestBody.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getRequestBody"> <refnamediv> <refname>HttpResponse::getRequestBody</refname> <refpurpose>Get request body</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>string</type><methodname>HttpResponse::getRequestBody</methodname> <void/> </methodsynopsis> <para> &info.function.alias; <function>http_get_request_body</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getRequestBodyStream.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/getRequestBodyStream.xml +++ phpdoc/en/reference/http/HttpResponse/getRequestBodyStream.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getRequestBodyStream"> <refnamediv> <refname>HttpResponse::getRequestBodyStream</refname> <refpurpose>Get request body stream</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>resource</type><methodname>HttpResponse::getRequestBodyStream</methodname> <void/> </methodsynopsis> <para> &info.function.alias; <function>http_get_request_body_stream</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/getRequestHeaders.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/getRequestHeaders.xml +++ phpdoc/en/reference/http/HttpResponse/getRequestHeaders.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-getRequestHeaders"> <refnamediv> <refname>HttpResponse::getRequestHeaders</refname> <refpurpose>Get request headers</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>array</type><methodname>HttpResponse::getRequestHeaders</methodname> <void/> </methodsynopsis> <para> &info.function.alias; <function>http_get_request_headers</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/redirect.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/redirect.xml +++ phpdoc/en/reference/http/HttpResponse/redirect.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-redirect"> <refnamediv> <refname>HttpResponse::redirect</refname> <refpurpose>Redirect</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>void</type><methodname>HttpResponse::redirect</methodname> <methodparam choice="opt"><type>string</type><parameter>url</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>params</parameter></methodparam> <methodparam choice="opt"><type>bool</type><parameter>session = FALSE</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>status</parameter></methodparam> </methodsynopsis> <para> &info.function.alias; <function>http_redirect</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse/status.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/http/HttpResponse/status.xml +++ phpdoc/en/reference/http/HttpResponse/status.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. --> <refentry id="function.HttpResponse-status"> <refnamediv> <refname>HttpResponse::status</refname> <refpurpose>Redirect</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; <methodsynopsis> <modifier>static</modifier> <type>bool</type><methodname>HttpResponse::status</methodname> <methodparam><type>int</type><parameter>status</parameter></methodparam> </methodsynopsis> <para> &info.function.alias; <function>http_send_status</function>. </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t indent-tabs-mode:nil sgml-parent-document:nil sgml-default-dtd-file:"../../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->