From 848e16b5a636fba38ab051a7bbb4f7cd31d70e00 Mon Sep 17 00:00:00 2001
From: Michael Wallner <mike@php.net>
Date: Fri, 13 Apr 2007 18:11:10 +0000
Subject: [PATCH] - reviewed functions/encodings and functions/misc

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@233739 c90b9560-bf6c-de11-be94-00142212c4b1
---
 .../encodings/http-chunked-decode.xml         | 28 +++++++++----------
 .../http/functions/encodings/http-deflate.xml | 12 ++++----
 .../http/functions/encodings/http-inflate.xml | 11 ++++----
 .../http/functions/misc/http-build-cookie.xml |  7 ++---
 reference/http/functions/misc/http-date.xml   |  9 ++----
 .../misc/http-get-request-body-stream.xml     |  9 +++---
 .../functions/misc/http-get-request-body.xml  |  9 +++---
 .../misc/http-get-request-headers.xml         |  9 +++---
 .../http/functions/misc/http-match-etag.xml   | 10 +++----
 .../functions/misc/http-match-modified.xml    | 18 ++++++------
 .../misc/http-match-request-header.xml        |  8 ++----
 .../http/functions/misc/http-support.xml      | 27 +++++-------------
 reference/http/reference.xml                  |  4 +--
 13 files changed, 67 insertions(+), 94 deletions(-)

diff --git a/reference/http/functions/encodings/http-chunked-decode.xml b/reference/http/functions/encodings/http-chunked-decode.xml
index c267890d4d..ba9cd0dd7a 100644
--- a/reference/http/functions/encodings/http-chunked-decode.xml
+++ b/reference/http/functions/encodings/http-chunked-decode.xml
@@ -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
diff --git a/reference/http/functions/encodings/http-deflate.xml b/reference/http/functions/encodings/http-deflate.xml
index 6fbd01f682..28321cbdf4 100644
--- a/reference/http/functions/encodings/http-deflate.xml
+++ b/reference/http/functions/encodings/http-deflate.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/encodings/http-inflate.xml b/reference/http/functions/encodings/http-inflate.xml
index 3aa69f8c69..17a3bf5b5e 100644
--- a/reference/http/functions/encodings/http-inflate.xml
+++ b/reference/http/functions/encodings/http-inflate.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-build-cookie.xml b/reference/http/functions/misc/http-build-cookie.xml
index c8e3819323..628887cfb1 100644
--- a/reference/http/functions/misc/http-build-cookie.xml
+++ b/reference/http/functions/misc/http-build-cookie.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-date.xml b/reference/http/functions/misc/http-date.xml
index 4fc90dc0a0..3cc2983704 100644
--- a/reference/http/functions/misc/http-date.xml
+++ b/reference/http/functions/misc/http-date.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-get-request-body-stream.xml b/reference/http/functions/misc/http-get-request-body-stream.xml
index 286d7423c1..885bebe96d 100644
--- a/reference/http/functions/misc/http-get-request-body-stream.xml
+++ b/reference/http/functions/misc/http-get-request-body-stream.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-get-request-body.xml b/reference/http/functions/misc/http-get-request-body.xml
index 558e02ca9b..fb77a166a3 100644
--- a/reference/http/functions/misc/http-get-request-body.xml
+++ b/reference/http/functions/misc/http-get-request-body.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-get-request-headers.xml b/reference/http/functions/misc/http-get-request-headers.xml
index 7bac085e6e..6404744354 100644
--- a/reference/http/functions/misc/http-get-request-headers.xml
+++ b/reference/http/functions/misc/http-get-request-headers.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-match-etag.xml b/reference/http/functions/misc/http-match-etag.xml
index 5037a6df66..3e24a72371 100644
--- a/reference/http/functions/misc/http-match-etag.xml
+++ b/reference/http/functions/misc/http-match-etag.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-match-modified.xml b/reference/http/functions/misc/http-match-modified.xml
index a5eb22aa5c..f1b39d8286 100644
--- a/reference/http/functions/misc/http-match-modified.xml
+++ b/reference/http/functions/misc/http-match-modified.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-match-request-header.xml b/reference/http/functions/misc/http-match-request-header.xml
index 502ef7d883..4796bccec2 100644
--- a/reference/http/functions/misc/http-match-request-header.xml
+++ b/reference/http/functions/misc/http-match-request-header.xml
@@ -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 the PEAR Coding Standards
  -->
 
 
- <!-- 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>
diff --git a/reference/http/functions/misc/http-support.xml b/reference/http/functions/misc/http-support.xml
index 7d25261b66..9101f92ae0 100644
--- a/reference/http/functions/misc/http-support.xml
+++ b/reference/http/functions/misc/http-support.xml
@@ -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
diff --git a/reference/http/reference.xml b/reference/http/reference.xml
index 591cb01706..22e15c67dd 100644
--- a/reference/http/reference.xml
+++ b/reference/http/reference.xml
@@ -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>