mike Thu Apr 5 18:18:07 2007 UTC
Modified files:
/phpdoc/en/reference/http HttpResponse.xml
Log:
- avoid newline at the end of <synopsis/>
- remove private properties
- document remaining properties and constants
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpResponse.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/http/HttpResponse.xml
diff -u phpdoc/en/reference/http/HttpResponse.xml:1.1
phpdoc/en/reference/http/HttpResponse.xml:1.2
--- phpdoc/en/reference/http/HttpResponse.xml:1.1 Mon Jul 24 11:01:54 2006
+++ phpdoc/en/reference/http/HttpResponse.xml Thu Apr 5 18:18:07 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="http.HttpResponse">
<refnamediv>
@@ -7,9 +7,7 @@
<refpurpose>HTTP Response Class</refpurpose>
</refnamediv>
<refsynopsisdiv>
- <synopsis>
- static class HttpResponse
- </synopsis>
+ <synopsis>static class HttpResponse</synopsis>
</refsynopsisdiv>
<refsect1 role="members" id="http.HttpResponse.members">
<title>Class Members</title>
@@ -28,79 +26,58 @@
</thead>
<tbody>
<row>
- <entry>private</entry>
- <entry>boolean</entry>
- <entry>sent</entry>
- </row>
- <row>
- <entry>private</entry>
- <entry>boolean</entry>
- <entry>catch</entry>
- </row>
- <row>
- <entry>private</entry>
- <entry>integer</entry>
- <entry>mode</entry>
- </row>
- <row>
- <entry>private</entry>
- <entry>resource</entry>
- <entry>stream</entry>
- </row>
- <row>
- <entry>private</entry>
- <entry>string</entry>
- <entry>file</entry>
- </row>
- <row>
- <entry>private</entry>
- <entry>string</entry>
- <entry>data</entry>
- </row>
- <row>
<entry>protected</entry>
<entry>boolean</entry>
<entry>cache</entry>
+ <entry>whether the caching the response should be attempted</entry>
</row>
<row>
<entry>protected</entry>
<entry>boolean</entry>
<entry>gzip</entry>
+ <entry>whether the sent entity should be gzip'ed on the fly</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>eTag</entry>
+ <entry>the generated or custom ETag</entry>
</row>
<row>
<entry>protected</entry>
<entry>integer</entry>
<entry>lastModified</entry>
+ <entry>the generated or custom timestamp of last modification</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>cacheControl</entry>
+ <entry><literal>Cache-Control</literal> setting</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>contentType</entry>
+ <entry>the <literal>Content-Type</literal> of the sent entity</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>contentDisposition</entry>
+ <entry>the <literal>Content-Disposition</literal> of the sent
entity</entry>
</row>
<row>
<entry>protected</entry>
<entry>integer</entry>
<entry>bufferSize</entry>
+ <entry>the chunk buffer size used for throttling</entry>
</row>
<row>
<entry>protected</entry>
<entry>double</entry>
<entry>throttleDelay</entry>
+ <entry>the seconds to delay when throttling</entry>
</row>
</tbody>
</tgroup>
@@ -122,32 +99,32 @@
<row>
<entry>integer</entry>
<entry>REDIRECT</entry>
- <entry></entry>
+ <entry>guess applicable redirect method</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_PERM</entry>
- <entry></entry>
+ <entry>permanent redirect (<literal>301 Moved
permanently</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_FOUND</entry>
- <entry></entry>
+ <entry>standard redirect (<literal>302 Found</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_POST</entry>
- <entry></entry>
+ <entry>redirect applicable to POST requests (<literal>303 See
other</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_PROXY</entry>
- <entry></entry>
+ <entry>proxy redirect (<literal>305 Use proxy</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_TEMP</entry>
- <entry></entry>
+ <entry>temporary redirect (<literal>307 Temporary
Redirect</literal>)</entry>
</row>
</tbody>
</tgroup>
