mike Tue Mar 27 10:13:34 2007 UTC
Modified files:
/phpdoc/en/reference/http constants.xml
Log:
- some updates to constants
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/constants.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/constants.xml
diff -u phpdoc/en/reference/http/constants.xml:1.2
phpdoc/en/reference/http/constants.xml:1.3
--- phpdoc/en/reference/http/constants.xml:1.2 Mon Jul 24 16:20:12 2006
+++ phpdoc/en/reference/http/constants.xml Tue Mar 27 10:13:34 2007
@@ -1,17 +1,15 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="http.constants">
<refnamediv>
<refname>Constants</refname>
<refpurpose>predefined http module constants</refpurpose>
</refnamediv>
<refsect1>
- &reftitle.constants;
- &extension.constants;
-
- <refsect2 id="http.constants.support">
- <title>Constants usable with <link
linkend="function.http-support"><function>http_support</function></link></title>
- <variablelist>
+ &reftitle.constants;
+ &extension.constants;
+ <variablelist id="http.constants.support">
+ <title>Constants usable with <function>http_support</function></title>
<varlistentry>
<term>
<constant>HTTP_SUPPORT</constant>
@@ -19,7 +17,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ querying for this constant will always return &true;
</simpara>
</listitem>
</varlistentry>
@@ -30,7 +28,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ whether support to issue HTTP requests is given, ie. libcurl support was
compiled in
</simpara>
</listitem>
</varlistentry>
@@ -41,7 +39,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ whether support to guess the Content-Type of HTTP messages is given, ie.
libmagic support was compiled in
</simpara>
</listitem>
</varlistentry>
@@ -52,7 +50,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ whether support for zlib encodings is given, ie. libz support was
compiled in
</simpara>
</listitem>
</varlistentry>
@@ -63,16 +61,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ whether support to issue HTTP requests over SSL is givem, ie. linked
libcurl was built with SSL support
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.params">
- <title>Constants usable with <link
linkend="function.http-parse-params"><function>http_parse_params</function></link></title>
- <variablelist>
+ <variablelist id="http.constants.params">
+ <title>Constants usable with <function>http_parse_params</function></title>
<varlistentry>
<term>
<constant>HTTP_PARAMS_ALLOW_COMMA</constant>
@@ -80,7 +75,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ allow commans additionally to semicolons as separator
</simpara>
</listitem>
</varlistentry>
@@ -91,7 +86,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ continue parsing after an error occurred
</simpara>
</listitem>
</varlistentry>
@@ -102,7 +97,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ raise PHP warnings on parse errors
</simpara>
</listitem>
</varlistentry>
@@ -113,16 +108,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ all three values above, bitwise or'ed
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.cookie">
- <title>Constants usable with <function>http_parse_cookie</function> and its
return value</title>
- <variablelist>
+ <variablelist id="http.constants.cookie">
+ <title>Constants usable with <function>http_parse_cookie</function> and its
return value</title>
<varlistentry>
<term>
<constant>HTTP_COOKIE_PARSE_RAW</constant>
@@ -130,7 +122,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ don't urldecode values
</simpara>
</listitem>
</varlistentry>
@@ -141,7 +133,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ whether "secure" was found in the cookie's parameters list
</simpara>
</listitem>
</varlistentry>
@@ -152,16 +144,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ whether "httpOnly" was found in the cookie's parameter list
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.deflate">
- <title>Constants usable with <function>http_deflate</function> and
<classname>HttpDeflateStream</classname></title>
- <variablelist>
+ <variablelist id="http.constants.deflate">
+ <title>Constants usable with <function>http_deflate</function> and
<classname>HttpDeflateStream</classname></title>
<varlistentry>
<term>
<constant>HTTP_DEFLATE_LEVEL_DEF</constant>
@@ -284,11 +273,8 @@
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.encodingstream">
- <title>Constants usable with <classname>HttpDeflateStream</classname> and
<classname>HttpInflateStream</classname></title>
- <variablelist>
+ <variablelist id="http.constants.encodingstream">
+ <title>Constants usable with <classname>HttpDeflateStream</classname> and
<classname>HttpInflateStream</classname></title>
<varlistentry>
<term>
<constant>HTTP_ENCODING_STREAM_FLUSH_NONE</constant>
@@ -296,7 +282,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ don't flush
</simpara>
</listitem>
</varlistentry>
@@ -307,7 +293,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ synchronized flush only
</simpara>
</listitem>
</varlistentry>
@@ -318,16 +304,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ full data flush
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.error">
- <title>Constants used for error reporting and Exceptions</title>
- <variablelist>
+ <variablelist id="http.constants.error">
+ <title>Constants used for error reporting and Exceptions</title>
<varlistentry>
<term>
<constant>HTTP_E_RUNTIME</constant>
@@ -335,7 +318,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ runtime error
</simpara>
</listitem>
</varlistentry>
@@ -346,7 +329,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ an invalid parameter was passed
</simpara>
</listitem>
</varlistentry>
@@ -357,7 +340,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ header() or similar operation failed
</simpara>
</listitem>
</varlistentry>
@@ -368,7 +351,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ HTTP header parse error
</simpara>
</listitem>
</varlistentry>
@@ -379,7 +362,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ unknown/invalid request method
</simpara>
</listitem>
</varlistentry>
@@ -390,7 +373,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ with operation incompatible message type
</simpara>
</listitem>
</varlistentry>
@@ -401,7 +384,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ encoding/decoding error
</simpara>
</listitem>
</varlistentry>
@@ -412,7 +395,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ request failure
</simpara>
</listitem>
</varlistentry>
@@ -423,7 +406,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ request pool failure
</simpara>
</listitem>
</varlistentry>
@@ -434,7 +417,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ socket exception
</simpara>
</listitem>
</varlistentry>
@@ -445,7 +428,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ response failure
</simpara>
</listitem>
</varlistentry>
@@ -456,7 +439,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ invalid URL
</simpara>
</listitem>
</varlistentry>
@@ -467,16 +450,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ querystring operation failure
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.message">
- <title>Constants usable with <classname>HttpMessage</classname></title>
- <variablelist>
+ <variablelist id="http.constants.message">
+ <title>Constants usable with <classname>HttpMessage</classname></title>
<varlistentry>
<term>
<constant>HTTP_MSG_NONE</constant>
@@ -484,7 +464,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ the message is of no specific type
</simpara>
</listitem>
</varlistentry>
@@ -495,7 +475,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ request style message
</simpara>
</listitem>
</varlistentry>
@@ -506,16 +486,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ response style message
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.querystring">
- <title>Constants usable with <classname>HttpQueryString</classname></title>
- <variablelist>
+ <variablelist id="http.constants.querystring">
+ <title>Constants usable with <classname>HttpQueryString</classname></title>
<varlistentry>
<term>
<constant>HTTP_QUERYSTRING_TYPE_BOOL</constant>
@@ -583,11 +560,8 @@
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.request.httpauth">
- <title>Constants used for the <literal>httpauthtype</literal> request
option</title>
- <variablelist>
+ <variablelist id="http.constants.request.httpauth">
+ <title>Constants used for the <literal>httpauthtype</literal>
&link.http.request.option;</title>
<varlistentry>
<term>
<constant>HTTP_AUTH_BASIC</constant>
@@ -595,7 +569,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ use "basic" authentication
</simpara>
</listitem>
</varlistentry>
@@ -606,7 +580,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ use "digest" authentication
</simpara>
</listitem>
</varlistentry>
@@ -617,7 +591,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ use "NTLM" authentication
</simpara>
</listitem>
</varlistentry>
@@ -628,24 +602,21 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ try any authentication scheme
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.request.protocol">
- <title>Constants used for the HTTP <literal>protocol</literal> version
request option</title>
- <variablelist>
+ <variablelist id="http.constants.request.protocol">
+ <title>Constants used for the HTTP <literal>protocol</literal> version
&link.http.request.option;</title>
<varlistentry>
<term>
- <constant>HTTP_VERSION_NONE</constant>
+ <constant>HTTP_VERSION_ANY</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ no specific HTTP protocol version
</simpara>
</listitem>
</varlistentry>
@@ -656,7 +627,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ HTTP version 1.0
</simpara>
</listitem>
</varlistentry>
@@ -667,16 +638,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ HTTP version 1.1
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.request.proxy">
- <title>Constants used for the <literal>proxytype</literal> request
option</title>
- <variablelist>
+ <variablelist id="http.constants.request.proxy">
+ <title>Constants used for the <literal>proxytype</literal>
&link.http.request.option;</title>
<varlistentry>
<term>
<constant>HTTP_PROXY_SOCKS4</constant>
@@ -684,7 +652,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ the proxy is a SOCKS4 type proxy
</simpara>
</listitem>
</varlistentry>
@@ -695,7 +663,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ the proxy is a SOCKS5 type proxy
</simpara>
</listitem>
</varlistentry>
@@ -706,16 +674,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ standard HTTP proxy
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.request.methods">
- <title>Predefined HTTP request method constants</title>
- <variablelist>
+ <variablelist id="http.constants.request.methods">
+ <title>Predefined HTTP request method constants</title>
<varlistentry>
<term>
<constant>HTTP_METH_GET</constant>
@@ -1014,11 +979,8 @@
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.redirect">
- <title>Constants usable with <function>http_redirect</function></title>
- <variablelist>
+ <variablelist id="http.constants.redirect">
+ <title>Constants usable with <function>http_redirect</function></title>
<varlistentry>
<term>
<constant>HTTP_REDIRECT</constant>
@@ -1026,7 +988,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ guess applicable redirect method
</simpara>
</listitem>
</varlistentry>
@@ -1037,7 +999,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ permanent redirect (<literal>301 Moved permanently</literal>)
</simpara>
</listitem>
</varlistentry>
@@ -1048,8 +1010,19 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ standard redirect (<literal>302 Found</literal>)
</simpara>
+ <note>
+ <simpara>
+ RFC 1945 and RFC 2068 specify that the client is not allowed
+ to change the method on the redirected request. However, most
+ existing user agent implementations treat 302 as if it were a 303
+ response, performing a GET on the Location field-value regardless
+ of the original request method. The status codes 303 and 307 have
+ been added for servers that wish to make unambiguously clear which
+ kind of reaction is expected of the client.
+ </simpara>
+ </note>
</listitem>
</varlistentry>
<varlistentry>
@@ -1059,7 +1032,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ redirect applicable to POST requests (<literal>303 See other</literal>)
</simpara>
</listitem>
</varlistentry>
@@ -1070,7 +1043,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ proxy redirect (<literal>305 Use proxy</literal>)
</simpara>
</listitem>
</varlistentry>
@@ -1081,16 +1054,13 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ temporary redirect (<literal>307 Temporary Redirect</literal>)
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
-
- <refsect2 id="http.constants.url">
- <title>Constants usable with <function>http_build_url</function></title>
- <variablelist>
+ <variablelist id="http.constants.url">
+ <title>Constants usable with <function>http_build_url</function></title>
<varlistentry>
<term>
<constant>HTTP_URL_REPLACE</constant>
@@ -1098,7 +1068,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ replace every part of the first URL when there's one of the second URL
</simpara>
</listitem>
</varlistentry>
@@ -1109,7 +1079,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ join relative paths
</simpara>
</listitem>
</varlistentry>
@@ -1120,7 +1090,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ join query strings
</simpara>
</listitem>
</varlistentry>
@@ -1131,7 +1101,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip any user authentication information
</simpara>
</listitem>
</varlistentry>
@@ -1142,7 +1112,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip any password authentication information
</simpara>
</listitem>
</varlistentry>
@@ -1153,7 +1123,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip any authentication information
</simpara>
</listitem>
</varlistentry>
@@ -1164,7 +1134,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip explicit port numbers
</simpara>
</listitem>
</varlistentry>
@@ -1175,7 +1145,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip complete path
</simpara>
</listitem>
</varlistentry>
@@ -1186,7 +1156,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip query string
</simpara>
</listitem>
</varlistentry>
@@ -1197,7 +1167,7 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip any fragments (#identifier)
</simpara>
</listitem>
</varlistentry>
@@ -1208,12 +1178,11 @@
</term>
<listitem>
<simpara>
- <!-- TODO description -->
+ strip anything but scheme and host
</simpara>
</listitem>
</varlistentry>
</variablelist>
- </refsect2>
</refsect1>
</refentry>
