<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.bzip2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.bzcompress.php',
    1 => 'bzcompress',
    2 => '文字列をbzip2形式のデータに圧縮する',
  ),
  'up' => 
  array (
    0 => 'ref.bzip2.php',
    1 => 'Bzip2 関数',
  ),
  'prev' => 
  array (
    0 => 'function.bzclose.php',
    1 => 'bzclose',
  ),
  'next' => 
  array (
    0 => 'function.bzdecompress.php',
    1 => 'bzdecompress',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/bzip2/functions/bzcompress.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.bzcompress" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">bzcompress</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">bzcompress</span> &mdash; <span class="dc-title">文字列をbzip2形式のデータに圧縮する</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.bzcompress-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>bzcompress</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$block_size</code><span class="initializer"> = 4</span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$work_factor</code><span class="initializer"> = 0</span></span>): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span></div>

  <p class="simpara">
   <span class="function"><strong>bzcompress()</strong></span> は、与えられた文字列を圧縮し、
   bzip2 形式のデータとして返します。
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.bzcompress-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">data</code></dt>
    <dd>
     <span class="simpara">
      圧縮する文字列
     </span>
    </dd>
   
   
    <dt><code class="parameter">block_size</code></dt>
    <dd>
     <span class="simpara">
      圧縮時のブロック長を指定します。
      1 から 9 の数とする必要があります。この場合、9
      の圧縮度が最大ですが、リソースの消費量も最大となります。
     </span>
    </dd>
   
   
    <dt><code class="parameter">work_factor</code></dt>
    <dd>
     <span class="simpara">
      繰り返しが多い、最悪の入力データの場合の圧縮処理の動作を制御します。
      この値は、0 から 250 までとなり、0 は特別な場合です。
     </span>
     <span class="simpara">
      <code class="parameter">work_factor</code> によらず、
      生成される出力は同じになります。
     </span>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.bzcompress-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   圧縮された文字列、もしくはエラー時はエラー数
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.bzcompress-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 データの圧縮</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?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">?&gt;</span></span></code></div>
   </div>

   </div>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.bzcompress-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.bzdecompress.php" class="function" rel="rdfs-seeAlso">bzdecompress()</a> - bzip2 形式のデータを解凍する</span></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>