mike Fri Apr 20 16:44:21 2007 UTC
Added files:
/phpdoc/en/reference/http/HttpDeflateStream factory.xml
/phpdoc/en/reference/http/HttpInflateStream factory.xml
Modified files:
/phpdoc/en/reference/http HttpDeflateStream.xml
HttpInflateStream.xml install.xml
/phpdoc/en/reference/http/HttpDeflateStream construct.xml
finish.xml flush.xml
update.xml
/phpdoc/en/reference/http/HttpInflateStream construct.xml
finish.xml flush.xml
update.xml
Log:
- reviewed Http[In|De]flateStream
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpDeflateStream.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/http/HttpDeflateStream.xml
diff -u phpdoc/en/reference/http/HttpDeflateStream.xml:1.1
phpdoc/en/reference/http/HttpDeflateStream.xml:1.2
--- phpdoc/en/reference/http/HttpDeflateStream.xml:1.1 Mon Jul 24 11:01:54 2006
+++ phpdoc/en/reference/http/HttpDeflateStream.xml Fri Apr 20 16:44:20 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="http.HttpDeflateStream">
<refnamediv>
@@ -7,9 +7,7 @@
<refpurpose>HTTP Deflate Stream Class</refpurpose>
</refnamediv>
<refsynopsisdiv>
- <synopsis>
- class HttpDeflateStream
- </synopsis>
+ <synopsis>class HttpDeflateStream</synopsis>
</refsynopsisdiv>
<refsect1 role="members" id="http.HttpDeflateStream.members">
<title>Class Members</title>
@@ -43,13 +41,13 @@
</row>
<row>
<entry>int</entry>
- <entry>LEVEL_MIN</entry>
- <entry>minimum compression level</entry>
+ <entry>LEVEL_DEF</entry>
+ <entry>default compression level</entry>
</row>
<row>
<entry>int</entry>
- <entry>TYPE_DEF</entry>
- <entry>default compression level</entry>
+ <entry>LEVEL_MIN</entry>
+ <entry>minimum compression level</entry>
</row>
<row>
<entry>int</entry>
@@ -103,15 +101,38 @@
<refsect2 id="http.HttpDeflateStream.methods">
&reftitle.methods;
<simplelist>
- <member><link
linkend="function.HttpDeflateStream-construct"><classname>HttpDeflateStream</classname>::<function>construct</function></link></member>
+ <member><link
linkend="function.HttpDeflateStream-factory"><classname>HttpDeflateStream</classname>::<function>factory</function></link></member>
+ <member><link
linkend="function.HttpDeflateStream-construct"><classname>HttpDeflateStream</classname>::<function>__construct</function></link></member>
<member><link
linkend="function.HttpDeflateStream-update"><classname>HttpDeflateStream</classname>::<function>update</function></link></member>
<member><link
linkend="function.HttpDeflateStream-flush"><classname>HttpDeflateStream</classname>::<function>flush</function></link></member>
<member><link
linkend="function.HttpDeflateStream-finish"><classname>HttpDeflateStream</classname>::<function>finish</function></link></member>
</simplelist>
</refsect2>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>A <classname>HttpDeflateStream</classname> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$stream = new HttpDeflateStream(
+ HttpDeflateStream::TYPE_GZIP |
+ HttpDeflateStream::LEVEL_MAX |
+ HttpDeflateStream::FLUSH_SYNC);
+
+echo $stream->update($data);
+echo $stream->finish();
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
</refentry>
+&reference.http.HttpDeflateStream.factory;
&reference.http.HttpDeflateStream.construct;
&reference.http.HttpDeflateStream.update;
&reference.http.HttpDeflateStream.flush;
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpInflateStream.xml?r1=1.1&r2=1.2&diff_format=u
Index: phpdoc/en/reference/http/HttpInflateStream.xml
diff -u phpdoc/en/reference/http/HttpInflateStream.xml:1.1
phpdoc/en/reference/http/HttpInflateStream.xml:1.2
--- phpdoc/en/reference/http/HttpInflateStream.xml:1.1 Mon Jul 24 11:01:54 2006
+++ phpdoc/en/reference/http/HttpInflateStream.xml Fri Apr 20 16:44:20 2007
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc.
-->
<refentry id="http.HttpInflateStream">
<refnamediv>
@@ -53,15 +53,34 @@
<refsect2 id="http.HttpInflateStream.methods">
&reftitle.methods;
<simplelist>
- <member><link
linkend="function.HttpInflateStream-construct"><classname>HttpInflateStream</classname>::<function>construct</function></link></member>
+ <member><link
linkend="function.HttpInflateStream-factory"><classname>HttpInflateStream</classname>::<function>factory</function></link></member>
+ <member><link
linkend="function.HttpInflateStream-construct"><classname>HttpInflateStream</classname>::<function>__construct</function></link></member>
<member><link
linkend="function.HttpInflateStream-update"><classname>HttpInflateStream</classname>::<function>update</function></link></member>
<member><link
linkend="function.HttpInflateStream-flush"><classname>HttpInflateStream</classname>::<function>flush</function></link></member>
<member><link
linkend="function.HttpInflateStream-finish"><classname>HttpInflateStream</classname>::<function>finish</function></link></member>
</simplelist>
</refsect2>
</refsect1>
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title>A <classname>HttpInflateStream</classname> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$stream = new HttpInflateStream;
+echo $stream->update($data);
+echo $stream->finish();
+?>
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
</refentry>
+&reference.http.HttpInflateStream.factory;
&reference.http.HttpInflateStream.construct;
&reference.http.HttpInflateStream.update;
&reference.http.HttpInflateStream.flush;
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/install.xml?r1=1.3&r2=1.4&diff_format=u
Index: phpdoc/en/reference/http/install.xml
diff -u phpdoc/en/reference/http/install.xml:1.3
phpdoc/en/reference/http/install.xml:1.4
--- phpdoc/en/reference/http/install.xml:1.3 Fri Sep 8 08:48:15 2006
+++ phpdoc/en/reference/http/install.xml Fri Apr 20 16:44:20 2007
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="http.install">
<refnamediv>
<refname>Installation</refname>
- <refpurpose>Installing and configuring the HTTP extension</refpurpose>
+ <refpurpose>Installing the HTTP extension</refpurpose>
</refnamediv>
<refsect1 id="http.install.pecl">
@@ -15,6 +15,9 @@
&pecl.info;
<ulink
url="&url.pecl.package;pecl_http">&url.pecl.package;pecl_http</ulink>.
</para>
+ <note>
+ <simpara>The official name of this extension is
<emphasis>pecl_http</emphasis>.</simpara>
+ </note>
<para>
&pecl.windows.download;
</para>
@@ -25,27 +28,28 @@
<para>
In order to be able to load this extension on <emphasis>Windows</emphasis>,
you additionally need to load the following PHP extensions:
- <!-- TODO package links -->
- <link linkend="ref.hash">hash</link>, iconv, SPL.
+ <link linkend="ref.hash">hash</link>, <link linkend="ref.iconv">iconv</link>
+ &listendand; <link linkend="ref.spl">SPL</link>.
</para>
</refsect1>
<refsect1 id="http.requirements">
<title>Installation requirements on other platforms</title>
<para>
- The extension must be built with <emphasis>libcurl</emphasis> support
<!--TODO ext link -->
+ The extension must be built with <ulink
url="http://curl.haxx.se/libcurl";>libcurl</ulink> support
to enable <emphasis>request</emphasis> functionality
(<literal>--with-http-curl-requests</literal>).
A library version equal or greater to <emphasis>v7.12.3</emphasis> is
required.
</para>
<para>
To enable support for sending and receiving <emphasis>compressed</emphasis>
- responses, the extension must be built with <emphasis>zlib</emphasis>
support <!-- TODO ext link -->
+ responses, the extension must be built with <ulink
url="http://www.zlib.net/";>zlib</ulink> support
(<literal>--with-http-zlib-compression</literal>).
A library version equal or greater than <emphasis>v1.2.2</emphasis> is
required.
</para>
<para>
<emphasis>Content type quessing</emphasis> can be enabled by
- building this extension with libmagic support
(<literal>--with-http-magic-mime</literal>). <!-- TODO ext link -->
+ building this extension with <ulink
url="http://sf.net/projects/libmagic";>libmagic</ulink> support
+ (<literal>--with-http-magic-mime</literal>).
</para>
</refsect1>
</refentry>
\ No newline at end of file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpDeflateStream/construct.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpDeflateStream/construct.xml
diff -u phpdoc/en/reference/http/HttpDeflateStream/construct.xml:1.2
phpdoc/en/reference/http/HttpDeflateStream/construct.xml:1.3
--- phpdoc/en/reference/http/HttpDeflateStream/construct.xml:1.2 Wed Sep
6 20:40:37 2006
+++ phpdoc/en/reference/http/HttpDeflateStream/construct.xml Fri Apr 20
16:44:20 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.HttpDeflateStream-construct">
<refnamediv>
@@ -17,9 +17,8 @@
Creates a new HttpDeflateStream object instance.
</para>
<para>
- See the <link linkend="http.HttpDeflateStream.constants">deflate stream
constants table</link> for possible arguments.
+ See the <link linkend="http.HttpDeflateStream.constants">deflate stream
constants table</link> for possible <parameter>flags</parameter>.
</para>
-
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -104,17 +103,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><link
linkend="http.HttpDeflateStream-factory"><function><classname>HttpDeflateStream</classname>::factory</function></link></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpDeflateStream/finish.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpDeflateStream/finish.xml
diff -u phpdoc/en/reference/http/HttpDeflateStream/finish.xml:1.2
phpdoc/en/reference/http/HttpDeflateStream/finish.xml:1.3
--- phpdoc/en/reference/http/HttpDeflateStream/finish.xml:1.2 Wed Sep 6
20:40:37 2006
+++ phpdoc/en/reference/http/HttpDeflateStream/finish.xml Fri Apr 20
16:44:20 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.HttpDeflateStream-finish">
<refnamediv>
@@ -25,7 +25,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
- Data to deflate
+ data to deflate
</para>
</listitem>
</varlistentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpDeflateStream/flush.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpDeflateStream/flush.xml
diff -u phpdoc/en/reference/http/HttpDeflateStream/flush.xml:1.2
phpdoc/en/reference/http/HttpDeflateStream/flush.xml:1.3
--- phpdoc/en/reference/http/HttpDeflateStream/flush.xml:1.2 Wed Sep 6
20:40:37 2006
+++ phpdoc/en/reference/http/HttpDeflateStream/flush.xml Fri Apr 20
16:44:20 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.HttpDeflateStream-flush">
<refnamediv>
@@ -25,7 +25,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
- More data to deflate
+ more data to deflate
</para>
</listitem>
</varlistentry>
@@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns some deflated data as string on success or FALSE on failure.
+ Returns some deflated data as string on success or &false; on failure.
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpDeflateStream/update.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpDeflateStream/update.xml
diff -u phpdoc/en/reference/http/HttpDeflateStream/update.xml:1.2
phpdoc/en/reference/http/HttpDeflateStream/update.xml:1.3
--- phpdoc/en/reference/http/HttpDeflateStream/update.xml:1.2 Wed Sep 6
20:40:37 2006
+++ phpdoc/en/reference/http/HttpDeflateStream/update.xml Fri Apr 20
16:44:20 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.HttpDeflateStream-update">
<refnamediv>
@@ -25,7 +25,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
- Data to deflate
+ data to deflate
</para>
</listitem>
</varlistentry>
@@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns deflated data on success or FALSE on failure.
+ Returns deflated data on success or &false; on failure.
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpInflateStream/construct.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpInflateStream/construct.xml
diff -u phpdoc/en/reference/http/HttpInflateStream/construct.xml:1.2
phpdoc/en/reference/http/HttpInflateStream/construct.xml:1.3
--- phpdoc/en/reference/http/HttpInflateStream/construct.xml:1.2 Wed Sep
6 20:40:37 2006
+++ phpdoc/en/reference/http/HttpInflateStream/construct.xml Fri Apr 20
16:44:20 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.HttpInflateStream-construct">
<refnamediv>
@@ -17,9 +17,8 @@
Creates a new HttpInflateStream object instance.
</para>
<para>
- See the <link linkend="http.HttpInflateStream.constants">inflate constants
table</link> for possible arguments.
+ See the <link linkend="http.HttpInflateStream.constants">inflate constants
table</link> for possible <parameter>flags</parameter>.
</para>
-
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
@@ -104,17 +103,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><link
linkend="http.HttpInflateStream-factory"><function><classname>HttpInflateStream</classname>::factory</function></link></member>
</simplelist>
</para>
</refsect1>
- -->
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpInflateStream/finish.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpInflateStream/finish.xml
diff -u phpdoc/en/reference/http/HttpInflateStream/finish.xml:1.2
phpdoc/en/reference/http/HttpInflateStream/finish.xml:1.3
--- phpdoc/en/reference/http/HttpInflateStream/finish.xml:1.2 Wed Sep 6
20:40:37 2006
+++ phpdoc/en/reference/http/HttpInflateStream/finish.xml Fri Apr 20
16:44:20 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.HttpInflateStream-finish">
<refnamediv>
@@ -25,7 +25,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
- Data to inflate
+ data to inflate
</para>
</listitem>
</varlistentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpInflateStream/flush.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpInflateStream/flush.xml
diff -u phpdoc/en/reference/http/HttpInflateStream/flush.xml:1.2
phpdoc/en/reference/http/HttpInflateStream/flush.xml:1.3
--- phpdoc/en/reference/http/HttpInflateStream/flush.xml:1.2 Wed Sep 6
20:40:37 2006
+++ phpdoc/en/reference/http/HttpInflateStream/flush.xml Fri Apr 20
16:44:20 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.HttpInflateStream-flush">
<refnamediv>
@@ -30,7 +30,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
- More data to inflate
+ more data to inflate
</para>
</listitem>
</varlistentry>
@@ -40,7 +40,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns some inflated data as string on success or FALSE on failure.
+ Returns some inflated data as string on success or &false; on failure.
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpInflateStream/update.xml?r1=1.2&r2=1.3&diff_format=u
Index: phpdoc/en/reference/http/HttpInflateStream/update.xml
diff -u phpdoc/en/reference/http/HttpInflateStream/update.xml:1.2
phpdoc/en/reference/http/HttpInflateStream/update.xml:1.3
--- phpdoc/en/reference/http/HttpInflateStream/update.xml:1.2 Wed Sep 6
20:40:37 2006
+++ phpdoc/en/reference/http/HttpInflateStream/update.xml Fri Apr 20
16:44:20 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.HttpInflateStream-update">
<refnamediv>
@@ -25,7 +25,7 @@
<term><parameter>data</parameter></term>
<listitem>
<para>
- Data to inflate
+ data to inflate
</para>
</listitem>
</varlistentry>
@@ -35,7 +35,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns inflated data on success or FALSE on failure.
+ Returns inflated data on success or &false; on failure.
</para>
</refsect1>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpDeflateStream/factory.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/http/HttpDeflateStream/factory.xml
+++ phpdoc/en/reference/http/HttpDeflateStream/factory.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.HttpDeflateStream-factory">
<refnamediv>
<refname>HttpDeflateStream::factory</refname>
<refpurpose>HttpDeflateStream class factory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type><methodname>HttpDeflateStream::factory</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags =
0</parameter></methodparam>
<methodparam choice="opt"><type>stringt</type><parameter>class_name =
'HttpDeflateStream'</parameter></methodparam>
</methodsynopsis>
<para>
Creates a new HttpDeflateStream object instance.
</para>
<para>
See the <link linkend="http.HttpDeflateStream.constants">deflate stream
constants table</link> for possible <parameter>flags</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
initialization flags
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
name of a subclass of <classname>HttpDeflateStream</classname>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>HttpDeflateStream::__factory</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';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link
linkend="http.HttpDeflateStream-construct"><function><classname>HttpDeflateStream</classname>::__construct</function></link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/http/HttpInflateStream/factory.xml?view=markup&rev=1.1
Index: phpdoc/en/reference/http/HttpInflateStream/factory.xml
+++ phpdoc/en/reference/http/HttpInflateStream/factory.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry id="function.HttpInflateStream-factory">
<refnamediv>
<refname>HttpInflateStream::factory</refname>
<refpurpose>HttpInflateStream class factory</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier>
<type>void</type><methodname>HttpInflateStream::factory</methodname>
<methodparam choice="opt"><type>int</type><parameter>flags =
0</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>class_name =
'HttpInflateStream'</parameter></methodparam>
</methodsynopsis>
<para>
Creates a new HttpInflateStream object instance.
</para>
<para>
See the <link linkend="http.HttpInflateStream.constants">inflate constants
table</link> for possible <parameter>flags</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
initialization flags
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>class_name</parameter></term>
<listitem>
<para>
name of a subclass of <classname>HttpInflateStream</classname>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<!-- Use when ERRORS exist
<refsect1 role="errors">
&reftitle.errors;
<para>
When does this function throw E_* level errors, or exceptions?
</para>
</refsect1>
-->
<!-- Use when a CHANGELOG exists
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>Enter the PHP version of change here</entry>
<entry>Description of change</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
-->
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>HttpInflateStream::__factory</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';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><link
linkend="http.HttpInflateStream-construct"><function><classname>HttpInflateStream</classname>::__construct</function></link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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
-->
