php-doc-en/reference/http/HttpDeflateStream.xml
Hannes Magnusson c030e2adf7 Upgrade to DocBook5:
- All id attributes are now xml:id
 - Add docbook namespace to all root elements
 - Replace <ulink /> with <link xlink:href />
 - Minor markup fixes here and there


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
2007-06-20 22:25:43 +00:00

160 lines
4.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- Generated by xml_proto.php v2.4. Found in /scripts directory of phpdoc. -->
<refentry xml:id="http.HttpDeflateStream" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HttpDeflateStream</refname>
<refpurpose>HTTP Deflate Stream Class</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>class HttpDeflateStream</synopsis>
</refsynopsisdiv>
<refsect1 role="members" xml:id="http.HttpDeflateStream.members">
<title>Class Members</title>
<refsect2 xml:id="http.HttpDeflateStream.constants">
&reftitle.constants;
<table>
<title/>
<tgroup cols="3">
<thead>
<row>
<entry>Type</entry>
<entry>Name</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>int</entry>
<entry>TYPE_GZIP</entry>
<entry>gzip encoding</entry>
</row>
<row>
<entry>int</entry>
<entry>TYPE_ZLIB</entry>
<entry>zlib AKA deflate encoding</entry>
</row>
<row>
<entry>int</entry>
<entry>TYPE_RAW</entry>
<entry>raw deflate encoding</entry>
</row>
<row>
<entry>int</entry>
<entry>LEVEL_DEF</entry>
<entry>default compression level</entry>
</row>
<row>
<entry>int</entry>
<entry>LEVEL_MIN</entry>
<entry>minimum compression level</entry>
</row>
<row>
<entry>int</entry>
<entry>LEVEL_MAX</entry>
<entry>maximum compression level</entry>
</row>
<row>
<entry>int</entry>
<entry>STRATEGY_DEF</entry>
<entry>default strategy</entry>
</row>
<row>
<entry>int</entry>
<entry>STRATEGY_FILT</entry>
<entry>filtered strategy</entry>
</row>
<row>
<entry>int</entry>
<entry>STRATEGY_HUFF</entry>
<entry>Huffman strategy</entry>
</row>
<row>
<entry>int</entry>
<entry>STRATEGY_RLE</entry>
<entry>RLE strategy</entry>
</row>
<row>
<entry>int</entry>
<entry>STRATEGY_FIXED</entry>
<entry>fixed strategy</entry>
</row>
<row>
<entry>int</entry>
<entry>FLUSH_NONE</entry>
<entry>no forced flush</entry>
</row>
<row>
<entry>int</entry>
<entry>FLUSH_SYNC</entry>
<entry>synching flush</entry>
</row>
<row>
<entry>int</entry>
<entry>FLUSH_FULL</entry>
<entry>full flush</entry>
</row>
</tbody>
</tgroup>
</table>
</refsect2>
<refsect2 xml:id="http.HttpDeflateStream.methods">
&reftitle.methods;
<simplelist>
<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;
&reference.http.HttpDeflateStream.finish;
<!-- 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
-->