<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.zlib-encode" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>zlib_encode</refname>
  <refpurpose>Compress data with the specified encoding</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>zlib_encode</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam><type>int</type><parameter>encoding</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>level</parameter><initializer>-1</initializer></methodparam>
  </methodsynopsis>
  <para>
   Compress data with the specified encoding.
  </para>

  &warn.undocumented.func;

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <para>
      The data to compress.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>encoding</parameter></term>
    <listitem>
     <para>
      The compression algorithm. Either <constant>ZLIB_ENCODING_RAW</constant>,
      <constant>ZLIB_ENCODING_DEFLATE</constant> or
      <constant>ZLIB_ENCODING_GZIP</constant>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>level</parameter></term>
    <listitem>
     <para>
      
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>

  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example xml:id="zlib-encode.example.basic">
   <title><function>zlib_encode</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$str = 'hello world';
$enc = zlib_encode($str, ZLIB_ENCODING_DEFLATE);
echo bin2hex($enc);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
<![CDATA[
789ccb48cdc9c95728cf2fca4901001a0b045d
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><function>zlib_decode</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
-->
