php-doc-en/reference/http/HttpRequest.xml
Jakub Vrana 74f4612207 Prefer lowercase IDs
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@322138 c90b9560-bf6c-de11-be94-00142212c4b1
2012-01-12 15:20:59 +00:00

403 lines
11 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<phpdoc:classref xmlns:phpdoc="http://php.net/ns/phpdoc" xml:id="class.httprequest" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The <classname>HttpRequest</classname></title>
<titleabbrev>HttpRequest</titleabbrev>
<partintro>
<section xml:id="httprequest.synopsis">
&reftitle.classsynopsis;
<classsynopsis>
<ooclass><classname>HttpRequest</classname></ooclass>
<classsynopsisinfo>
<ooclass><classname>HttpRequest</classname></ooclass>
</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.httprequest')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
</classsynopsis>
</section>
<section role="members" xml:id="http.httprequest.members">
<title>Class Members</title>
<section xml:id="http.httprequest.properties">
&reftitle.properties;
<table xml: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>private</entry>
<entry>array</entry>
<entry>options</entry>
<entry>request options to configure the request; see &link.http.request.options;</entry>
</row>
<row>
<entry>private</entry>
<entry>array</entry>
<entry>postFields</entry>
<entry>form data: <literal><![CDATA[array("fieldname" => "fieldvalue")]]></literal></entry>
</row>
<row>
<entry>private</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>private</entry>
<entry>array</entry>
<entry>responseInfo</entry>
<entry>information (statistical) about the request/response; see &link.http.request.info;</entry>
</row>
<row>
<entry>private</entry>
<entry>HttpMessage</entry>
<entry>responseMessage</entry>
<entry>the response message</entry>
</row>
<row>
<entry>private</entry>
<entry>integer</entry>
<entry>responseCode</entry>
<entry>the numerical response code</entry>
</row>
<row>
<entry>private</entry>
<entry>string</entry>
<entry>responseStatus</entry>
<entry>the literal response status text</entry>
</row>
<row>
<entry>private</entry>
<entry>integer</entry>
<entry>method</entry>
<entry>the request method to use</entry>
</row>
<row>
<entry>private</entry>
<entry>string</entry>
<entry>url</entry>
<entry>the request url</entry>
</row>
<row>
<entry>private</entry>
<entry>string</entry>
<entry>contentType</entry>
<entry>the content type to use for raw post requests</entry>
</row>
<row>
<entry>private</entry>
<entry>string</entry>
<entry>rawPostData</entry>
<entry>raw post data</entry>
</row>
<row>
<entry>private</entry>
<entry>string</entry>
<entry>queryData</entry>
<entry>query parameters</entry>
</row>
<row>
<entry>private</entry>
<entry>string</entry>
<entry>putFile</entry>
<entry>the file to upload with a PUT request</entry>
</row>
<row>
<entry>private</entry>
<entry>string</entry>
<entry>putData</entry>
<entry>raw data to upload with a PUT request</entry>
</row>
<row>
<entry>private</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>
</section>
<section xml: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>
</section>
</section>
</partintro>
&reference.http.entities.HttpRequest;
</phpdoc:classref>
<!-- 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:"~/.phpdoc/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
-->