php-doc-en/reference/http/HttpResponse.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

230 lines
10 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="http.HttpResponse" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HttpResponse</refname>
<refpurpose>HTTP Response Class</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>static class HttpResponse</synopsis>
</refsynopsisdiv>
<refsect1 role="members" xml:id="http.HttpResponse.members">
<title>Class Members</title>
<refsect2 xml:id="http.HttpResponse.properties">
&reftitle.properties;
<table xml:id="http.HttpResponse.properties.static">
<title>Static Properties</title>
<tgroup cols="4">
<thead>
<row>
<entry>Modifiers</entry>
<entry>Type</entry>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>protected</entry>
<entry>boolean</entry>
<entry>cache</entry>
<entry>whether 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>
</table>
</refsect2>
<refsect2 xml:id="http.HttpResponse.constants">
&reftitle.constants;
<table>
<title/>
<tgroup cols="3">
<thead>
<row>
<entry>Type</entry>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>integer</entry>
<entry>REDIRECT</entry>
<entry>guess applicable redirect method</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_PERM</entry>
<entry>permanent redirect (<literal>301 Moved permanently</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_FOUND</entry>
<entry>standard redirect (<literal>302 Found</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_POST</entry>
<entry>redirect applicable to POST requests (<literal>303 See other</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_PROXY</entry>
<entry>proxy redirect (<literal>305 Use proxy</literal>)</entry>
</row>
<row>
<entry>integer</entry>
<entry>REDIRECT_TEMP</entry>
<entry>temporary redirect (<literal>307 Temporary Redirect</literal>)</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect2>
<refsect2 xml:id="http.HttpResponse.methods">
&reftitle.methods;
<simplelist>
<member><link linkend="function.HttpResponse-getBufferSize"><function>HttpResponse::getBufferSize</function></link></member>
<member><link linkend="function.HttpResponse-setBufferSize"><function>HttpResponse::setBufferSize</function></link></member>
<member><link linkend="function.HttpResponse-getCacheControl"><function>HttpResponse::getCacheControl</function></link></member>
<member><link linkend="function.HttpResponse-setCacheControl"><function>HttpResponse::setCacheControl</function></link></member>
<member><link linkend="function.HttpResponse-getCache"><function>HttpResponse::getCache</function></link></member>
<member><link linkend="function.HttpResponse-setCache"><function>HttpResponse::setCache</function></link></member>
<member><link linkend="function.HttpResponse-getContentDisposition"><function>HttpResponse::getContentDisposition</function></link></member>
<member><link linkend="function.HttpResponse-setContentDisposition"><function>HttpResponse::setContentDisposition</function></link></member>
<member><link linkend="function.HttpResponse-getContentType"><function>HttpResponse::getContentType</function></link></member>
<member><link linkend="function.HttpResponse-setContentType"><function>HttpResponse::setContentType</function></link></member>
<member><link linkend="function.HttpResponse-getData"><function>HttpResponse::getData</function></link></member>
<member><link linkend="function.HttpResponse-setData"><function>HttpResponse::setData</function></link></member>
<member><link linkend="function.HttpResponse-getETag"><function>HttpResponse::getETag</function></link></member>
<member><link linkend="function.HttpResponse-setETag"><function>HttpResponse::setETag</function></link></member>
<member><link linkend="function.HttpResponse-getFile"><function>HttpResponse::getFile</function></link></member>
<member><link linkend="function.HttpResponse-setFile"><function>HttpResponse::setFile</function></link></member>
<member><link linkend="function.HttpResponse-getGzip"><function>HttpResponse::getGzip</function></link></member>
<member><link linkend="function.HttpResponse-setGzip"><function>HttpResponse::setGzip</function></link></member>
<member><link linkend="function.HttpResponse-getHeader"><function>HttpResponse::getHeader</function></link></member>
<member><link linkend="function.HttpResponse-setHeader"><function>HttpResponse::setHeader</function></link></member>
<member><link linkend="function.HttpResponse-getLastModified"><function>HttpResponse::getLastModified</function></link></member>
<member><link linkend="function.HttpResponse-setLastModified"><function>HttpResponse::setLastModified</function></link></member>
<member><link linkend="function.HttpResponse-getStream"><function>HttpResponse::getStream</function></link></member>
<member><link linkend="function.HttpResponse-setStream"><function>HttpResponse::setStream</function></link></member>
<member><link linkend="function.HttpResponse-getThrottleDelay"><function>HttpResponse::getThrottleDelay</function></link></member>
<member><link linkend="function.HttpResponse-setThrottleDelay"><function>HttpResponse::setThrottleDelay</function></link></member>
<member><link linkend="function.HttpResponse-redirect"><function>HttpResponse::redirect</function></link></member>
<member><link linkend="function.HttpResponse-capture"><function>HttpResponse::capture</function></link></member>
<member><link linkend="function.HttpResponse-send"><function>HttpResponse::send</function></link></member>
<member><link linkend="function.HttpResponse-guessContentType"><function>HttpResponse::guessContentType</function></link></member>
<member><link linkend="function.HttpResponse-redirect"><function>HttpResponse::redirect</function></link></member>
<member><link linkend="function.HttpResponse-status"><function>HttpResponse::status</function></link></member>
<member><link linkend="function.HttpResponse-getRequestHeaders"><function>HttpResponse::getRequestHeaders</function></link></member>
<member><link linkend="function.HttpResponse-getRequestBody"><function>HttpResponse::getRequestBody</function></link></member>
<member><link linkend="function.HttpResponse-getRequestBodyStream"><function>HttpResponse::getRequestBodyStream</function></link></member>
</simplelist>
</refsect2>
</refsect1>
</refentry>
&reference.http.HttpResponse.capture;
&reference.http.HttpResponse.getBufferSize;
&reference.http.HttpResponse.getCacheControl;
&reference.http.HttpResponse.getCache;
&reference.http.HttpResponse.getContentDisposition;
&reference.http.HttpResponse.getContentType;
&reference.http.HttpResponse.getData;
&reference.http.HttpResponse.getETag;
&reference.http.HttpResponse.getFile;
&reference.http.HttpResponse.getGzip;
&reference.http.HttpResponse.getHeader;
&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;
&reference.http.HttpResponse.setCache;
&reference.http.HttpResponse.setContentDisposition;
&reference.http.HttpResponse.setContentType;
&reference.http.HttpResponse.setData;
&reference.http.HttpResponse.setETag;
&reference.http.HttpResponse.setFile;
&reference.http.HttpResponse.setGzip;
&reference.http.HttpResponse.setHeader;
&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:
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
-->