php-doc-en/reference/http/HttpRequest.xml
TAKAGI Masahiro b0dfa7835e fixed typo.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@232921 c90b9560-bf6c-de11-be94-00142212c4b1
2007-03-29 14:51:06 +00:00

502 lines
20 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="http.HttpRequest">
<refnamediv>
<refname>HttpRequest</refname>
<refpurpose>HTTP Request Class</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
class HttpRequest
</synopsis>
</refsynopsisdiv>
<refsect1 role="members" id="http.HttpRequest.members">
<title>Class Members</title>
<refsect2 id="http.HttpRequest.properties">
&reftitle.properties;
<table id="http.HttpRequest.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>array</entry>
<entry>options</entry>
<entry>request options to configure the request; see &link.http.request.options;</entry>
</row>
<row>
<entry>protected</entry>
<entry>array</entry>
<entry>postFields</entry>
<entry>form data: <literal><![CDATA[array("fieldname" => "fieldvalue")]]></literal></entry>
</row>
<row>
<entry>protected</entry>
<entry>array</entry>
<entry>postFiles</entry>
<entry>files to upload: <literal><![CDATA[array(array("name" => "image", "file" => "/home/u/images/u.png", "type" => "image/png"))]]></literal></entry>
</row>
<row>
<entry>protected</entry>
<entry>array</entry>
<entry>responseInfo</entry>
<entry>information (statistical) about the request/response; see &link.http.request.info;</entry>
</row>
<row>
<entry>protected</entry>
<entry>HttpMessage</entry>
<entry>responseMessage</entry>
<entry>the response message</entry>
</row>
<row>
<entry>protected</entry>
<entry>integer</entry>
<entry>responseCode</entry>
<entry>the numerical response code</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>responseStatus</entry>
<entry>the literal response status text</entry>
</row>
<row>
<entry>protected</entry>
<entry>integer</entry>
<entry>method</entry>
<entry>the request method to use</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>url</entry>
<entry>the request url</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>contentType</entry>
<entry>the content type to use for raw post requests</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>rawPostData</entry>
<entry>raw post data</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>queryData</entry>
<entry>query parameters</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>putFile</entry>
<entry>the file to upload with a PUT request</entry>
</row>
<row>
<entry>protected</entry>
<entry>string</entry>
<entry>putData</entry>
<entry>raw data to upload with a PUT request</entry>
</row>
<row>
<entry>protected</entry>
<entry>HttpMessage</entry>
<entry>history</entry>
<entry>the whole request/response history if history logging is enabled</entry>
</row>
<row>
<entry>public</entry>
<entry>boolean</entry>
<entry>recordHistory</entry>
<entry>whether to enable history logging</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect2>
<refsect2 id="http.HttpRequest.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>METH_GET</entry>
<entry>GET request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_HEAD</entry>
<entry>HEAD request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_POST</entry>
<entry>POST request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_PUT</entry>
<entry>PUT request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_DELETE</entry>
<entry>DELETE request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_OPTIONS</entry>
<entry>OPTIONS request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_TRACE</entry>
<entry>TRACE request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_CONNECT</entry>
<entry>CONNECT request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_PROPFIND</entry>
<entry>PROPFIND request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_PROPPATCH</entry>
<entry>PROPPATCH request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_MKCOL</entry>
<entry>MKCOL request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_COPY</entry>
<entry>COPY request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_MOVE</entry>
<entry>MOVE request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_LOCK</entry>
<entry>LOCK request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_UNLOCK</entry>
<entry>UNLOCK request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_VERSION_CONTROL</entry>
<entry>VERSION-CONTROL request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_REPORT</entry>
<entry>REPORT request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_CHECKOUT</entry>
<entry>CHECKOUT request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_CHECKIN</entry>
<entry>CHECKIN request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_UNCHECKOUT</entry>
<entry>UNCHECKOUT request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_MKWORKSPACE</entry>
<entry>MKWORKSPACE request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_UPDATE</entry>
<entry>UPDATE request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_LABEL</entry>
<entry>LABEL request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_MERGE</entry>
<entry>MERGE request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_BASELINE_CONTROL</entry>
<entry>BASELINE-CONTROL request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_MKACTIVITY</entry>
<entry>MKACTIVITY request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>METH_ACL</entry>
<entry>ACL request method</entry>
</row>
<row>
<entry>integer</entry>
<entry>VERSION_1_0</entry>
<entry>HTTP protocol version 1.0</entry>
</row>
<row>
<entry>integer</entry>
<entry>VERSION_1_1</entry>
<entry>HTTP protocol version 1.1</entry>
</row>
<row>
<entry>integer</entry>
<entry>VERSION_ANY</entry>
<entry>any HTTP protocol version</entry>
</row>
<row>
<entry>integer</entry>
<entry>AUTH_BASIC</entry>
<entry>basic authentication</entry>
</row>
<row>
<entry>integer</entry>
<entry>AUTH_DIGEST</entry>
<entry>digest authentication</entry>
</row>
<row>
<entry>integer</entry>
<entry>AUTH_NTLM</entry>
<entry>NTLM authentication</entry>
</row>
<row>
<entry>integer</entry>
<entry>AUTH_GSSNEG</entry>
<entry>GSS negotiate authentication</entry>
</row>
<row>
<entry>integer</entry>
<entry>AUTH_ANY</entry>
<entry>any authentication</entry>
</row>
<row>
<entry>integer</entry>
<entry>PROXY_SOCKS4</entry>
<entry>SOCKS v4 proxy</entry>
</row>
<row>
<entry>integer</entry>
<entry>PROXY_SOCKS5</entry>
<entry>SOCKS v5 proxy</entry>
</row>
<row>
<entry>integer</entry>
<entry>PROXY_HTTP</entry>
<entry>HTTP proxy</entry>
</row>
<row>
<entry>integer</entry>
<entry>SSL_VERSION_TLSv1</entry>
<entry>use TLS v1</entry>
</row>
<row>
<entry>integer</entry>
<entry>SSL_VERSION_SSLv2</entry>
<entry>use SSL v2</entry>
</row>
<row>
<entry>integer</entry>
<entry>SSL_VERSION_SSLv3</entry>
<entry>use SSL v3</entry>
</row>
<row>
<entry>integer</entry>
<entry>SSL_VERSION_ANY</entry>
<entry>use any SSL/TLS method</entry>
</row>
<row>
<entry>integer</entry>
<entry>IPRESOLVE_V4</entry>
<entry>resolve via IPv4 only</entry>
</row>
<row>
<entry>integer</entry>
<entry>IPRESOLVE_V6</entry>
<entry>resolve via IPv6 only</entry>
</row>
<row>
<entry>integer</entry>
<entry>IPRESOLVE_ANY</entry>
<entry>use any resolving methods</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect2>
<refsect2 id="http.HttpRequest.methods">
&reftitle.methods;
<simplelist>
<member><link linkend="function.HttpRequest-construct"><classname>HttpRequest</classname>::<function>construct</function></link></member>
<member><link linkend="function.HttpRequest-getOptions"><classname>HttpRequest</classname>::<function>getOptions</function></link></member>
<member><link linkend="function.HttpRequest-setOptions"><classname>HttpRequest</classname>::<function>setOptions</function></link></member>
<member><link linkend="function.HttpRequest-getSslOptions"><classname>HttpRequest</classname>::<function>getSslOptions</function></link></member>
<member><link linkend="function.HttpRequest-addSslOptions"><classname>HttpRequest</classname>::<function>addSslOptions</function></link></member>
<member><link linkend="function.HttpRequest-setSslOptions"><classname>HttpRequest</classname>::<function>setSslOptions</function></link></member>
<member><link linkend="function.HttpRequest-getUrl"><classname>HttpRequest</classname>::<function>getUrl</function></link></member>
<member><link linkend="function.HttpRequest-setUrl"><classname>HttpRequest</classname>::<function>setUrl</function></link></member>
<member><link linkend="function.HttpRequest-getMethod"><classname>HttpRequest</classname>::<function>getMethod</function></link></member>
<member><link linkend="function.HttpRequest-setMethod"><classname>HttpRequest</classname>::<function>setMethod</function></link></member>
<member><link linkend="function.HttpRequest-enableCookies"><classname>HttpRequest</classname>::<function>enableCookies</function></link></member>
<member><link linkend="function.HttpRequest-resetCookies"><classname>HttpRequest</classname>::<function>resetCookies</function></link></member>
<member><link linkend="function.HttpRequest-getCookies"><classname>HttpRequest</classname>::<function>getCookies</function></link></member>
<member><link linkend="function.HttpRequest-addCookies"><classname>HttpRequest</classname>::<function>addCookies</function></link></member>
<member><link linkend="function.HttpRequest-setCookies"><classname>HttpRequest</classname>::<function>setCookies</function></link></member>
<member><link linkend="function.HttpRequest-getHeaders"><classname>HttpRequest</classname>::<function>getHeaders</function></link></member>
<member><link linkend="function.HttpRequest-addHeaders"><classname>HttpRequest</classname>::<function>addHeaders</function></link></member>
<member><link linkend="function.HttpRequest-setHeaders"><classname>HttpRequest</classname>::<function>setHeaders</function></link></member>
<member><link linkend="function.HttpRequest-getContentType"><classname>HttpRequest</classname>::<function>getContentType</function></link></member>
<member><link linkend="function.HttpRequest-setContentType"><classname>HttpRequest</classname>::<function>setContentType</function></link></member>
<member><link linkend="function.HttpRequest-getQueryData"><classname>HttpRequest</classname>::<function>getQueryData</function></link></member>
<member><link linkend="function.HttpRequest-addQueryData"><classname>HttpRequest</classname>::<function>addQueryData</function></link></member>
<member><link linkend="function.HttpRequest-setQueryData"><classname>HttpRequest</classname>::<function>setQueryData</function></link></member>
<member><link linkend="function.HttpRequest-getPostFields"><classname>HttpRequest</classname>::<function>getPostFields</function></link></member>
<member><link linkend="function.HttpRequest-addPostFields"><classname>HttpRequest</classname>::<function>addPostFields</function></link></member>
<member><link linkend="function.HttpRequest-setPostFields"><classname>HttpRequest</classname>::<function>setPostFields</function></link></member>
<member><link linkend="function.HttpRequest-getPostFiles"><classname>HttpRequest</classname>::<function>getPostFiles</function></link></member>
<member><link linkend="function.HttpRequest-addPostFile"><classname>HttpRequest</classname>::<function>addPostFile</function></link></member>
<member><link linkend="function.HttpRequest-setPostFiles"><classname>HttpRequest</classname>::<function>setPostFiles</function></link></member>
<member><link linkend="function.HttpRequest-getRawPostData"><classname>HttpRequest</classname>::<function>getRawPostData</function></link></member>
<member><link linkend="function.HttpRequest-addRawPostData"><classname>HttpRequest</classname>::<function>addRawPostData</function></link></member>
<member><link linkend="function.HttpRequest-setRawPostData"><classname>HttpRequest</classname>::<function>setRawPostData</function></link></member>
<member><link linkend="function.HttpRequest-getPutData"><classname>HttpRequest</classname>::<function>getPutData</function></link></member>
<member><link linkend="function.HttpRequest-addPutData"><classname>HttpRequest</classname>::<function>addPutData</function></link></member>
<member><link linkend="function.HttpRequest-setPutData"><classname>HttpRequest</classname>::<function>setPutData</function></link></member>
<member><link linkend="function.HttpRequest-getPutFile"><classname>HttpRequest</classname>::<function>getPutFile</function></link></member>
<member><link linkend="function.HttpRequest-setPutFile"><classname>HttpRequest</classname>::<function>setPutFile</function></link></member>
<member><link linkend="function.HttpRequest-send"><classname>HttpRequest</classname>::<function>send</function></link></member>
<member><link linkend="function.HttpRequest-getRequestMessage"><classname>HttpRequest</classname>::<function>getRequestMessage</function></link></member>
<member><link linkend="function.HttpRequest-getRawRequestMessage"><classname>HttpRequest</classname>::<function>getRawRequestMessage</function></link></member>
<member><link linkend="function.HttpRequest-getResponseMessage"><classname>HttpRequest</classname>::<function>getResponseMessage</function></link></member>
<member><link linkend="function.HttpRequest-getRawResponseMessage"><classname>HttpRequest</classname>::<function>getRawResponseMessage</function></link></member>
<member><link linkend="function.HttpRequest-getResponseCode"><classname>HttpRequest</classname>::<function>getResponseCode</function></link></member>
<member><link linkend="function.HttpRequest-getResponseStatus"><classname>HttpRequest</classname>::<function>getResponseStatus</function></link></member>
<member><link linkend="function.HttpRequest-getResponseHeader"><classname>HttpRequest</classname>::<function>getResponseHeader</function></link></member>
<member><link linkend="function.HttpRequest-getResponseCookies"><classname>HttpRequest</classname>::<function>getResponseCookies</function></link></member>
<member><link linkend="function.HttpRequest-getResponseBody"><classname>HttpRequest</classname>::<function>getResponseBody</function></link></member>
<member><link linkend="function.HttpRequest-getResponseData"><classname>HttpRequest</classname>::<function>getResponseData</function></link></member>
<member><link linkend="function.HttpRequest-getResponseInfo"><classname>HttpRequest</classname>::<function>getResponseInfo</function></link></member>
<member><link linkend="function.HttpRequest-clearHistory"><classname>HttpRequest</classname>::<function>clearHistory</function></link></member>
<member><link linkend="function.HttpRequest-getHistory"><classname>HttpRequest</classname>::<function>getHistory</function></link></member>
</simplelist>
</refsect2>
</refsect1>
</refentry>
&reference.http.HttpRequest.addCookies;
&reference.http.HttpRequest.addHeaders;
&reference.http.HttpRequest.addPostFields;
&reference.http.HttpRequest.addPostFile;
&reference.http.HttpRequest.addPutData;
&reference.http.HttpRequest.addQueryData;
&reference.http.HttpRequest.addRawPostData;
&reference.http.HttpRequest.addSslOptions;
&reference.http.HttpRequest.clearHistory;
&reference.http.HttpRequest.construct;
&reference.http.HttpRequest.enableCookies;
&reference.http.HttpRequest.getContentType;
&reference.http.HttpRequest.getCookies;
&reference.http.HttpRequest.getHeaders;
&reference.http.HttpRequest.getHistory;
&reference.http.HttpRequest.getMethod;
&reference.http.HttpRequest.getOptions;
&reference.http.HttpRequest.getPostFields;
&reference.http.HttpRequest.getPostFiles;
&reference.http.HttpRequest.getPutData;
&reference.http.HttpRequest.getPutFile;
&reference.http.HttpRequest.getQueryData;
&reference.http.HttpRequest.getRawPostData;
&reference.http.HttpRequest.getRawRequestMessage;
&reference.http.HttpRequest.getRawResponseMessage;
&reference.http.HttpRequest.getRequestMessage;
&reference.http.HttpRequest.getResponseBody;
&reference.http.HttpRequest.getResponseCode;
&reference.http.HttpRequest.getResponseCookies;
&reference.http.HttpRequest.getResponseData;
&reference.http.HttpRequest.getResponseHeader;
&reference.http.HttpRequest.getResponseInfo;
&reference.http.HttpRequest.getResponseMessage;
&reference.http.HttpRequest.getResponseStatus;
&reference.http.HttpRequest.getSslOptions;
&reference.http.HttpRequest.getUrl;
&reference.http.HttpRequest.resetCookies;
&reference.http.HttpRequest.send;
&reference.http.HttpRequest.setContentType;
&reference.http.HttpRequest.setCookies;
&reference.http.HttpRequest.setHeaders;
&reference.http.HttpRequest.setMethod;
&reference.http.HttpRequest.setOptions;
&reference.http.HttpRequest.setPostFields;
&reference.http.HttpRequest.setPostFiles;
&reference.http.HttpRequest.setPutData;
&reference.http.HttpRequest.setPutFile;
&reference.http.HttpRequest.setQueryData;
&reference.http.HttpRequest.setRawPostData;
&reference.http.HttpRequest.setSslOptions;
&reference.http.HttpRequest.setUrl;
<!-- 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
-->