php-doc-en/reference/http/HttpMessage.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

214 lines
9.4 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="http.HttpMessage" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HttpMessage</refname>
<refpurpose>HTTP Message Class</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
class HttpMessage implements Iterator, Countable, Serializable
</synopsis>
</refsynopsisdiv>
<refsect1 role="members" xml:id="http.HttpMessage.members">
<title>Class Members</title>
<refsect2 xml:id="http.HttpMessage.properties">
&reftitle.properties;
<table xml:id="http.HttpMessage.properties.instance">
<title>Instance 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>int</entry>
<entry>type</entry>
<entry>message type</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>body</entry>
<entry>message body</entry>
</row>
<row>
<entry>protected</entry>
<entry>float</entry>
<entry>httpVersion</entry>
<entry>HTTP protocol version</entry>
</row>
<row>
<entry>protected</entry>
<entry>array</entry>
<entry>headers</entry>
<entry>message headers</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>requestMethod</entry>
<entry>request method name</entry>
</row>
<row>
<entry>protected</entry>
<entry>requestUrl</entry>
<entry>string</entry>
<entry>request URL</entry>
</row>
<row>
<entry>protected</entry>
<entry>int</entry>
<entry>responseCode</entry>
<entry>response code</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>responseStatus</entry>
<entry>response status message</entry>
</row>
<row>
<entry>protected</entry>
<entry>HttpMessage</entry>
<entry>parentMessage</entry>
<entry>reference to parent message</entry>
</row>
</tbody>
</tgroup>
</table>
<note>
<para>
None of these default properties can be accessed by reference, array key/index notation nor be used
in increment or decrement operations.
</para>
</note>
</refsect2>
<refsect2 xml:id="http.HttpMessage.constants">
&reftitle.constants;
<table>
<title/>
<tgroup cols="3">
<thead>
<row>
<entry>Type</entry>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>int</entry>
<entry>TYPE_NONE</entry>
<entry>message has is of no specific type</entry>
</row>
<row>
<entry>int</entry>
<entry>TYPE_REQUEST</entry>
<entry>message is a request style HTTP message</entry>
</row>
<row>
<entry>int</entry>
<entry>TYPE_RESPONSE</entry>
<entry>message is a response style HTTP message</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect2>
<refsect2 xml:id="http.HttpMessage.methods">
&reftitle.methods;
<simplelist>
<member><link linkend="function.HttpMessage-construct"><classname>HttpMessage</classname>::<function>construct</function></link></member>
<member><link linkend="function.HttpMessage-factory"><classname>HttpMessage</classname>::<function>factory</function></link></member>
<member><link linkend="function.HttpMessage-fromEnv"><classname>HttpMessage</classname>::<function>fromEnv</function></link></member>
<member><link linkend="function.HttpMessage-fromString"><classname>HttpMessage</classname>::<function>fromString</function></link></member>
<member><link linkend="function.HttpMessage-toString"><classname>HttpMessage</classname>::<function>toString</function></link></member>
<member><link linkend="function.HttpMessage-toMessageTypeObject"><classname>HttpMessage</classname>::<function>toMessageTypeObject</function></link></member>
<member><link linkend="function.HttpMessage-guessContentType"><classname>HttpMessage</classname>::<function>guessContentType</function></link></member>
<member><link linkend="function.HttpMessage-detach"><classname>HttpMessage</classname>::<function>detach</function></link></member>
<member><link linkend="function.HttpMessage-prepend"><classname>HttpMessage</classname>::<function>prepend</function></link></member>
<member><link linkend="function.HttpMessage-reverse"><classname>HttpMessage</classname>::<function>reverse</function></link></member>
<member><link linkend="function.HttpMessage-send"><classname>HttpMessage</classname>::<function>send</function></link></member>
<member><link linkend="function.HttpMessage-getParentMessage"><classname>HttpMessage</classname>::<function>getParentMessage</function></link></member>
<member><link linkend="function.HttpMessage-getType"><classname>HttpMessage</classname>::<function>getType</function></link></member>
<member><link linkend="function.HttpMessage-setType"><classname>HttpMessage</classname>::<function>setType</function></link></member>
<member><link linkend="function.HttpMessage-getHttpVersion"><classname>HttpMessage</classname>::<function>getHttpVersion</function></link></member>
<member><link linkend="function.HttpMessage-setHttpVersion"><classname>HttpMessage</classname>::<function>setHttpVersion</function></link></member>
<member><link linkend="function.HttpMessage-getHeaders"><classname>HttpMessage</classname>::<function>getHeaders</function></link></member>
<member><link linkend="function.HttpMessage-getHeader"><classname>HttpMessage</classname>::<function>getHeader</function></link></member>
<member><link linkend="function.HttpMessage-addHeaders"><classname>HttpMessage</classname>::<function>addHeaders</function></link></member>
<member><link linkend="function.HttpMessage-setHeaders"><classname>HttpMessage</classname>::<function>setHeaders</function></link></member>
<member><link linkend="function.HttpMessage-getBody"><classname>HttpMessage</classname>::<function>getBody</function></link></member>
<member><link linkend="function.HttpMessage-setBody"><classname>HttpMessage</classname>::<function>setBody</function></link></member>
<member><link linkend="function.HttpMessage-getRequestMethod"><classname>HttpMessage</classname>::<function>getRequestMethod</function></link></member>
<member><link linkend="function.HttpMessage-setRequestMethod"><classname>HttpMessage</classname>::<function>setRequestMethod</function></link></member>
<member><link linkend="function.HttpMessage-getRequestUrl"><classname>HttpMessage</classname>::<function>getRequestUrl</function></link></member>
<member><link linkend="function.HttpMessage-setRequestUrl"><classname>HttpMessage</classname>::<function>setRequestUrl</function></link></member>
<member><link linkend="function.HttpMessage-getResponseCode"><classname>HttpMessage</classname>::<function>getResponseCode</function></link></member>
<member><link linkend="function.HttpMessage-setResponseCode"><classname>HttpMessage</classname>::<function>setResponseCode</function></link></member>
<member><link linkend="function.HttpMessage-getResponseStatus"><classname>HttpMessage</classname>::<function>getResponseStatus</function></link></member>
<member><link linkend="function.HttpMessage-setResponseStatus"><classname>HttpMessage</classname>::<function>setResponseStatus</function></link></member>
</simplelist>
</refsect2>
</refsect1>
</refentry>
&reference.http.HttpMessage.construct;
&reference.http.HttpMessage.factory;
&reference.http.HttpMessage.fromEnv;
&reference.http.HttpMessage.fromString;
&reference.http.HttpMessage.toString;
&reference.http.HttpMessage.toMessageTypeObject;
&reference.http.HttpMessage.guessContentType;
&reference.http.HttpMessage.detach;
&reference.http.HttpMessage.prepend;
&reference.http.HttpMessage.reverse;
&reference.http.HttpMessage.send;
&reference.http.HttpMessage.getParentMessage;
&reference.http.HttpMessage.getType;
&reference.http.HttpMessage.setType;
&reference.http.HttpMessage.getHttpVersion;
&reference.http.HttpMessage.setHttpVersion;
&reference.http.HttpMessage.getHeaders;
&reference.http.HttpMessage.getHeader;
&reference.http.HttpMessage.addHeaders;
&reference.http.HttpMessage.setHeaders;
&reference.http.HttpMessage.getBody;
&reference.http.HttpMessage.setBody;
&reference.http.HttpMessage.getRequestMethod;
&reference.http.HttpMessage.setRequestMethod;
&reference.http.HttpMessage.getRequestUrl;
&reference.http.HttpMessage.setRequestUrl;
&reference.http.HttpMessage.getResponseCode;
&reference.http.HttpMessage.setResponseCode;
&reference.http.HttpMessage.getResponseStatus;
&reference.http.HttpMessage.setResponseStatus;
<!-- 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
-->