mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
5b9fc29465
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
76 lines
2.4 KiB
XML
76 lines
2.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/bzip2.xml, last change in rev 1.1 -->
|
|
<refentry id="function.bzcompress">
|
|
<refnamediv>
|
|
<refname>bzcompress</refname>
|
|
<refpurpose>Compress a string into bzip2 encoded data</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>bzcompress</methodname>
|
|
<methodparam><type>string</type><parameter>source</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>blocksize</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>workfactor</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>bzcompress</function> compresses the
|
|
<parameter>source</parameter> string and returns it as bzip2
|
|
encoded data.
|
|
</para>
|
|
<para>
|
|
The optional parameter <parameter>blocksize</parameter> 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. <parameter>blocksize</parameter> defaults to
|
|
4.
|
|
</para>
|
|
<para>
|
|
The optional parameter <parameter>workfactor</parameter> 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 and 30 being the default
|
|
value. Regardless of the <parameter>workfactor</parameter>, the
|
|
generated output is the same.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>bzcompress</function> Example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$str = "sample data";
|
|
$bzstr = bzcompress($str, 9);
|
|
print( $bzstr );
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>bzdecompress</function>.
|
|
</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
|
|
-->
|