<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.bzcompress" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bzcompress</refname>
  <refpurpose>Compress a string into bzip2 encoded data</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>int</type></type><methodname>bzcompress</methodname>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>block_size</parameter><initializer>4</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>work_factor</parameter><initializer>0</initializer></methodparam>
  </methodsynopsis>
  <para>
   <function>bzcompress</function> compresses the given string and returns
   it as bzip2 encoded data.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       The string to compress.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>block_size</parameter></term>
     <listitem>
      <para>
       Specifies the blocksize used during compression and should be a number 
       from 1 to 9 with 9 giving the best compression, but using more 
       resources to do so.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>work_factor</parameter></term>
     <listitem>
      <para>
       Controls how the compression phase behaves when presented with worst
       case, highly repetitive, input data.  The value can be between 0 and
       250 with 0 being a special case. 
      </para>
      <para>
       Regardless of the <parameter>work_factor</parameter>, the generated 
       output is the same.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The compressed string, or an error number if an error occurred.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Compressing data</title>
   <programlisting role="php">
<![CDATA[
<?php
$str = "sample data";
$bzstr = bzcompress($str, 9);
echo $bzstr;
?>
]]>
   </programlisting>
   </example>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>bzdecompress</function></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:"~/.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
-->
