mike Fri Apr 13 18:11:10 2007 UTC
Modified files:
/phpdoc/en/reference/http reference.xml
/phpdoc/en/reference/http/functions/encodings
http-chunked-decode.xml
http-deflate.xml
http-inflate.xml
/phpdoc/en/reference/http/functions/misc http-build-cookie.xml
http-date.xml
http-get-request-body-stream.xml
http-get-request-body.xml
http-get-request-headers.xml
http-match-etag.xml
http-match-modified.xml
http-match-request-header.xml
http-support.xml
Log:
- reviewed functions/encodings and functions/misc
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/reference.xml?r1=1.22&r2=1.23&diff_format=u
Index: phpdoc/en/reference/http/reference.xml
diff -u phpdoc/en/reference/http/reference.xml:1.22
phpdoc/en/reference/http/reference.xml:1.23
--- phpdoc/en/reference/http/reference.xml:1.22 Thu Mar 29 17:49:01 2007
+++ phpdoc/en/reference/http/reference.xml Fri Apr 13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.22 $ -->
+<!-- $Revision: 1.23 $ -->
<!-- Purpose: basic.php -->
<!-- Membership: pecl -->
@@ -46,7 +46,7 @@
</simpara>
<note>
<simpara>
- Be aware though, that some methods are not available with PHP 5.0.
+ Be aware though, that some methods are not available with PHP v5.0.
</simpara>
</note>
<simplelist>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml
diff -u
phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml:1.2
phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml:1.3
--- phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml:1.2
Wed Sep 6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/encodings/http-chunked-decode.xml
Fri Apr 13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-chunked-decode">
<refnamediv>
@@ -24,7 +24,7 @@
<term><parameter>encoded</parameter></term>
<listitem>
<para>
- Chunked encoded string
+ chunked encoded string
</para>
</listitem>
</varlistentry>
@@ -34,7 +34,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns the decoded string on success or FALSE on failure.
+ Returns the decoded string on success or &false; on failure.
</para>
</refsect1>
@@ -73,36 +73,36 @@
-->
- <!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>http_chunked_decode</function> example</title>
- <para>
- Any text that describes the purpose of the example, or
- what goes on in the example should go here (inside the
- <example> tag, not out
- </para>
<programlisting role="php">
<![CDATA[
<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
-}
+$string = "".
+ "05\r\n".
+ "this \r\n".
+ "07\r\n".
+ "string \r\n".
+ "12\r\n".
+ "is chunked encoded\r\n".
+ "01\n\r\n".
+ "00";
+echo http_chunked_decode($string);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
-Use the PEAR Coding Standards
+this string is chunked encoded
]]>
</screen>
</example>
</para>
</refsect1>
- -->
<!-- Use when adding See Also links
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/encodings/http-deflate.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/encodings/http-deflate.xml
diff -u phpdoc/en/reference/http/functions/encodings/http-deflate.xml:1.2
phpdoc/en/reference/http/functions/encodings/http-deflate.xml:1.3
--- phpdoc/en/reference/http/functions/encodings/http-deflate.xml:1.2 Wed Sep
6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/encodings/http-deflate.xml Fri Apr
13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-deflate">
<refnamediv>
@@ -10,7 +10,7 @@
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>http_deflate</methodname>
- <methodparam
choice="opt"><type>string</type><parameter>data</parameter></methodparam>
+ <methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags =
0</parameter></methodparam>
</methodsynopsis>
<para>
@@ -36,7 +36,7 @@
<term><parameter>flags</parameter></term>
<listitem>
<para>
- Deflate options
+ deflate options
</para>
</listitem>
</varlistentry>
@@ -117,17 +117,15 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_inflate</function></member>
+ <member><link
linkend="http.HttpDeflateStream"><classname>HttpDeflateStream</classname></link></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/encodings/http-inflate.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/encodings/http-inflate.xml
diff -u phpdoc/en/reference/http/functions/encodings/http-inflate.xml:1.2
phpdoc/en/reference/http/functions/encodings/http-inflate.xml:1.3
--- phpdoc/en/reference/http/functions/encodings/http-inflate.xml:1.2 Wed Sep
6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/encodings/http-inflate.xml Fri Apr
13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-inflate">
<refnamediv>
@@ -25,7 +25,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
- String containing the compressed data
+ string containing the compressed data
</para>
</listitem>
</varlistentry>
@@ -106,17 +106,16 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_deflate</function></member>
+ <member><link
linkend="http.HttpInflateStream"><classname>HttpInflateStream</classname></link></member>
+ <member></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-build-cookie.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-build-cookie.xml
diff -u phpdoc/en/reference/http/functions/misc/http-build-cookie.xml:1.2
phpdoc/en/reference/http/functions/misc/http-build-cookie.xml:1.3
--- phpdoc/en/reference/http/functions/misc/http-build-cookie.xml:1.2 Wed Sep
6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/misc/http-build-cookie.xml Fri Apr
13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-build-cookie">
<refnamediv>
@@ -107,17 +107,14 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_parse_cookie</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-date.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-date.xml
diff -u phpdoc/en/reference/http/functions/misc/http-date.xml:1.2
phpdoc/en/reference/http/functions/misc/http-date.xml:1.3
--- phpdoc/en/reference/http/functions/misc/http-date.xml:1.2 Wed Sep 6
20:40:38 2006
+++ phpdoc/en/reference/http/functions/misc/http-date.xml Fri Apr 13
18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-date">
<refnamediv>
@@ -25,7 +25,7 @@
<term><parameter>timestamp</parameter></term>
<listitem>
<para>
- Unix timestamp
+ Unix timestamp; current time if omitted
</para>
</listitem>
</varlistentry>
@@ -106,17 +106,14 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>date</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml
diff -u
phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml:1.2
phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml:1.3
---
phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml:1.2
Wed Sep 6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/misc/http-get-request-body-stream.xml
Fri Apr 13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-get-request-body-stream">
<refnamediv>
@@ -98,17 +98,16 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_get_request_body</function></member>
+ <member><function>http_get_request_headers</function></member>
+ <member>&http.response.class.php51;</member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-get-request-body.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-get-request-body.xml
diff -u phpdoc/en/reference/http/functions/misc/http-get-request-body.xml:1.3
phpdoc/en/reference/http/functions/misc/http-get-request-body.xml:1.4
--- phpdoc/en/reference/http/functions/misc/http-get-request-body.xml:1.3
Wed Mar 28 06:58:54 2007
+++ phpdoc/en/reference/http/functions/misc/http-get-request-body.xml Fri Apr
13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-get-request-body">
<refnamediv>
@@ -100,17 +100,16 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_get_request_body_stream</function></member>
+ <member><function>http_get_request_headers</function></member>
+ <member>&http.response.class.php51;</member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml
diff -u
phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml:1.2
phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml:1.3
--- phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml:1.2
Wed Sep 6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/misc/http-get-request-headers.xml
Fri Apr 13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-get-request-headers">
<refnamediv>
@@ -95,17 +95,16 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_get_request_body</function></member>
+ <member><function>http_get_request_body_stream</function></member>
+ <member>&http.response.class.php51;</member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-match-etag.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-match-etag.xml
diff -u phpdoc/en/reference/http/functions/misc/http-match-etag.xml:1.2
phpdoc/en/reference/http/functions/misc/http-match-etag.xml:1.3
--- phpdoc/en/reference/http/functions/misc/http-match-etag.xml:1.2 Wed Sep
6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/misc/http-match-etag.xml Fri Apr 13
18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-match-etag">
<refnamediv>
@@ -115,17 +115,17 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_match_last_modified</function></member>
+ <member><function>http_match_request_header</function></member>
+ <member><function>http_cache_etag</function></member>
+ <member><function>http_cache_last_modified</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-match-modified.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-match-modified.xml
diff -u phpdoc/en/reference/http/functions/misc/http-match-modified.xml:1.4
phpdoc/en/reference/http/functions/misc/http-match-modified.xml:1.5
--- phpdoc/en/reference/http/functions/misc/http-match-modified.xml:1.4 Thu Feb
15 09:24:35 2007
+++ phpdoc/en/reference/http/functions/misc/http-match-modified.xml Fri Apr
13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
+<!-- $Revision: 1.5 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-match-modified">
<refnamediv>
@@ -14,8 +14,8 @@
<methodparam choice="opt"><type>bool</type><parameter>for_range =
FALSE</parameter></methodparam>
</methodsynopsis>
<para>
- Matches the given Unix timestamp against the clients "If-Modified-Since"
- resp. "If-Unmodified-Since" HTTP headers.
+ Matches the given Unix timestamp against the clients
<literal>If-Modified-Since</literal>
+ resp. <literal>If-Unmodified-Since</literal> HTTP headers.
</para>
</refsect1>
<refsect1 role="parameters">
@@ -34,7 +34,7 @@
<term><parameter>for_range</parameter></term>
<listitem>
<para>
- If set to TRUE, the header usually used to validate HTTP ranges will be
checked
+ if set to &true;, the header usually used to validate HTTP ranges will
be checked
</para>
</listitem>
</varlistentry>
@@ -44,7 +44,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns TRUE if timestamp represents an earlier date than the header, else
FALSE.
+ Returns &true; if timestamp represents an earlier date than the header,
else &false;.
</para>
</refsect1>
@@ -115,17 +115,17 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_match_etag</function></member>
+ <member><function>http_match_request_header</function></member>
+ <member><function>http_cache_etag</function></member>
+ <member><function>http_cache_last_modified</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-match-request-header.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-match-request-header.xml
diff -u
phpdoc/en/reference/http/functions/misc/http-match-request-header.xml:1.2
phpdoc/en/reference/http/functions/misc/http-match-request-header.xml:1.3
--- phpdoc/en/reference/http/functions/misc/http-match-request-header.xml:1.2
Wed Sep 6 20:40:38 2006
+++ phpdoc/en/reference/http/functions/misc/http-match-request-header.xml
Fri Apr 13 18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-match-request-header">
<refnamediv>
@@ -123,17 +123,15 @@
-->
- <!-- Use when adding See Also links
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
- <member><function></function></member>
- <member>Or <link linkend="somethingelse">something else</link></member>
+ <member><function>http_match_etag</function></member>
+ <member><function>http_match_last_modified</function></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/functions/misc/http-support.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/http/functions/misc/http-support.xml
diff -u phpdoc/en/reference/http/functions/misc/http-support.xml:1.3
phpdoc/en/reference/http/functions/misc/http-support.xml:1.4
--- phpdoc/en/reference/http/functions/misc/http-support.xml:1.3 Thu Feb
15 09:24:35 2007
+++ phpdoc/en/reference/http/functions/misc/http-support.xml Fri Apr 13
18:11:10 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="function.http-support">
<refnamediv>
@@ -17,7 +17,7 @@
</para>
<para>
See the <link linkend="http.constants.support">feature support constants
table</link>
- for possible values for the <varname>feature</varname> argument.
+ for possible values for the <parameter>feature</parameter> argument.
</para>
</refsect1>
<refsect1 role="parameters">
@@ -28,8 +28,7 @@
<term><parameter>feature</parameter></term>
<listitem>
<para>
- Feature to probe for; if the parameter is 0 or omitted, the return
value contains a bitmask of
- all supported features that depend on external libraries
+ feature to probe for
</para>
</listitem>
</varlistentry>
@@ -39,7 +38,8 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns int, whether requested feature is supported, or a bitmask with all
supported features.
+ Returns <type>integer</type>, whether requested feature is supported,
+ or a bitmask with all supported features if <parameter>feature</parameter>
was omitted.
</para>
</refsect1>
@@ -78,36 +78,23 @@
-->
- <!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>http_support</function> example</title>
- <para>
- Any text that describes the purpose of the example, or
- what goes on in the example should go here (inside the
- <example> tag, not out
- </para>
<programlisting role="php">
<![CDATA[
<?php
-if ($anexample === true) {
- echo 'Use the PEAR Coding Standards';
+if (!http_support(HTTP_SUPPORT_REQUESTS) {
+ die("Need HTTP request support!\n");
}
?>
]]>
</programlisting>
- &example.outputs;
- <screen>
-<![CDATA[
-Use the PEAR Coding Standards
-]]>
- </screen>
</example>
</para>
</refsect1>
- -->
<!-- Use when adding See Also links
