<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Compress a string into bzip2 encoded data</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.bzclose.html">bzclose</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.bzdecompress.html">bzdecompress</a></div> <div class="up"><a href="ref.bzip2.html">Bzip2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="function.bzcompress" class="refentry"> <div class="refnamediv"> <h1 class="refname">bzcompress</h1> <p class="verinfo">(PHP 4 >= 4.0.4, PHP 5)</p><p class="refpurpose"><span class="refname">bzcompress</span> — <span class="dc-title">Compress a string into bzip2 encoded data</span></p> </div> <div class="refsect1 description" id="refsect1-function.bzcompress-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>bzcompress</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$source</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$blocksize</code><span class="initializer"> = 4</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$workfactor</code><span class="initializer"> = 0</span></span> ]] )</div> <p class="para rdfs-comment"> <span class="function"><strong>bzcompress()</strong></span> compresses the given string and returns it as bzip2 encoded data. </p> </div> <div class="refsect1 parameters" id="refsect1-function.bzcompress-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">source</code></em></span> <dd> <p class="para"> The string to compress. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">blocksize</code></em></span> <dd> <p class="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. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">workfactor</code></em></span> <dd> <p class="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. </p> <p class="para"> Regardless of the <em><code class="parameter">workfactor</code></em>, the generated output is the same. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.bzcompress-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> The compressed string, or an error number if an error occurred. </p> </div> <div class="refsect1 examples" id="refsect1-function.bzcompress-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-645"> <p><strong>Example #1 Compressing data</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$str </span><span style="color: #007700">= </span><span style="color: #DD0000">"sample data"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bzstr </span><span style="color: #007700">= </span><span style="color: #0000BB">bzcompress</span><span style="color: #007700">(</span><span style="color: #0000BB">$str</span><span style="color: #007700">, </span><span style="color: #0000BB">9</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$bzstr</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </div> <div class="refsect1 seealso" id="refsect1-function.bzcompress-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.bzdecompress.html" class="function" rel="rdfs-seeAlso">bzdecompress()</a> - Decompresses bzip2 encoded data</span></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.bzclose.html">bzclose</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.bzdecompress.html">bzdecompress</a></div> <div class="up"><a href="ref.bzip2.html">Bzip2 Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>