deflate_add.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.deflate-add" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>deflate_add</refname>
  <refpurpose>Incrementally deflate data</refpurpose>
 </refnamediv>

 <refsect1 role="description"><!-- {{{ -->
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>deflate_add</methodname>
   <methodparam><type>DeflateContext</type><parameter>context</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>flush_mode</parameter><initializer><constant>ZLIB_SYNC_FLUSH</constant></initializer></methodparam>
  </methodsynopsis>
  <para>
   Incrementally deflates data in the specified context.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="parameters"><!-- {{{ -->
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>context</parameter></term>
    <listitem>
     <para>
      A context created with <function>deflate_init</function>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <para>
      A chunk of data to compress.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flush_mode</parameter></term>
    <listitem>
     <para>
      One of <constant>ZLIB_BLOCK</constant>,
      <constant>ZLIB_NO_FLUSH</constant>,
      <constant>ZLIB_PARTIAL_FLUSH</constant>,
      <constant>ZLIB_SYNC_FLUSH</constant> (default),
      <constant>ZLIB_FULL_FLUSH</constant>, <constant>ZLIB_FINISH</constant>.
      Normally you will want to set <constant>ZLIB_NO_FLUSH</constant> to
      maximize compression, and <constant>ZLIB_FINISH</constant> to terminate
      with the last chunk of data. See the <link
      xlink:href="&url.zlib.manual;">zlib manual</link> for a
      detailed description of these constants.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1><!-- }}} -->

 <refsect1 role="returnvalues"><!-- {{{ -->
  &reftitle.returnvalues;
  <para>
   Returns a chunk of compressed data, &return.falseforfailure;.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="errors"><!-- {{{ -->
  &reftitle.errors;
  <para>
   If invalid arguments are given, an error of level
   <constant>E_WARNING</constant> is generated.
  </para>
 </refsect1><!-- }}} -->

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.0</entry>
      <entry>
       <parameter>context</parameter> expects a <classname>DeflateContext</classname>
       instance now; previously, a <type>resource</type> was expected.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="seealso"><!-- {{{ -->
  &reftitle.seealso;
  <simplelist>
   <member><function>deflate_init</function></member>
  </simplelist>
 </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:"~/.phpdoc/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
-->