<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/filters.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'filters.compression.php',
    1 => '压缩过滤器',
    2 => '压缩过滤器',
  ),
  'up' => 
  array (
    0 => 'filters.php',
    1 => '可用过滤器列表',
  ),
  'prev' => 
  array (
    0 => 'filters.convert.php',
    1 => '转换过滤器',
  ),
  'next' => 
  array (
    0 => 'filters.encryption.php',
    1 => '加密过滤器',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'appendices/filters.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="filters.compression" class="section">
    <h2 class="title">压缩过滤器</h2>

    <p class="simpara">
     虽然 <a href="wrappers.compression.php" class="link">压缩封装协议</a> 提供了在本地文件系统中创建 gzip 和 bz2
     兼容文件的方法，但不代表可以在网络的流中提供通用压缩的意思，也不代表可以将一个非压缩的流转换成一个压缩流。对此，压缩过滤器可以在任何时候应用于任何流资源。
    </p>

    <blockquote class="note"><p><strong class="note">注意</strong>: 
      <span class="simpara">
       压缩过滤器<em>不</em>产生命令行工具如
       <code class="literal">gzip</code> 的头和尾信息。只是压缩和解压数据流中的有效载荷部分。
      </span>
    </p></blockquote>

 <div class="section" id="filters.compression.zlib">
  <h2 class="title">zlib.deflate 和 zlib.inflate</h2>
    <p class="simpara">
    <code class="literal">zlib.deflate</code>（压缩）和 
    <code class="literal">zlib.inflate</code>（解压）实现了定义与 
    <a href="https://datatracker.ietf.org/doc/html/rfc1951" class="link external">&raquo;&nbsp;RFC 1951</a> 的压缩算法。
    <code class="literal">deflate</code> 过滤器可以接受以一个关联数组传递的最多三个参数。

    <code class="parameter">level</code>定义了压缩强度（1-9）。
     数字更高通常会产生更小的载荷，但要消耗更多的处理时间。
     存在两个特殊压缩等级：0（完全不压缩）和 -1（zlib 内部默认值，目前是 6）。

    <code class="parameter">window</code>是压缩回溯窗口大小，以二的次方表示。
     更高的值（大到 15 —— 32768 字节）产生更好的压缩效果但消耗更多内存，
     低的值（低到 9 —— 512 字节）产生产生较差的压缩效果但内存消耗低。
     目前默认的 <code class="parameter">window</code> 大小是 <code class="literal">15</code>。

    <code class="parameter">memory</code>用来指示要分配多少工作内存。
     合法的数值范围是从 1（最小分配）到 9（最大分配）。
     内存分配仅影响速度，不会影响生成的载荷的大小。
    </p>

    <blockquote class="note"><p><strong class="note">注意</strong>: 
      <span class="simpara">
       因为最常用的参数是压缩等级，也可以提供一个整数值作为此参数（而不用数组）。
      </span>
    </p></blockquote>

    <p class="simpara">
     在激活 <a href="ref.zlib.php" class="link">zlib</a>
     的前提下可以使用 zlib.* 压缩过滤器。
    </p>

    <div class="example" id="example-1">
      <p><strong>示例 #1 
      <code class="literal">zlib.deflate</code> 和
      <code class="literal">zlib.inflate</code></strong></p>
      <div class="example-contents">
        <div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$params </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'level' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">6</span><span style="color: #007700">, </span><span style="color: #DD0000">'window' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">15</span><span style="color: #007700">, </span><span style="color: #DD0000">'memory' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">9</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$original_text </span><span style="color: #007700">= </span><span style="color: #DD0000">"This is a test.\nThis is only a test.\nThis is not an important string.\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"The original text is " </span><span style="color: #007700">. </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$original_text</span><span style="color: #007700">) . </span><span style="color: #DD0000">" characters long.\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.deflated'</span><span style="color: #007700">, </span><span style="color: #DD0000">'w'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">stream_filter_append</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">'zlib.deflate'</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_FILTER_WRITE</span><span style="color: #007700">, </span><span style="color: #0000BB">$params</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">$original_text</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"The compressed file is " </span><span style="color: #007700">. </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.deflated'</span><span style="color: #007700">) . </span><span style="color: #DD0000">" bytes long.\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"The original text was:\n"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">/* 使用 readfile 和 zlib.inflate 即时解压缩 */<br /></span><span style="color: #0000BB">readfile</span><span style="color: #007700">(</span><span style="color: #DD0000">'php://filter/zlib.inflate/resource=test.deflated'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* 生成的输出：<br /><br />The original text is 70 characters long.<br />The compressed file is 56 bytes long.<br />The original text was:<br />This is a test.<br />This is only a test.<br />This is not an important string.<br /><br /> */<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
</div>

    </div>

    <div class="example" id="example-2">
      <p><strong>示例 #2 
      <code class="literal">zlib.deflate</code> 简单参数用法</strong></p>
      <div class="example-contents">
        <div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$original_text </span><span style="color: #007700">= </span><span style="color: #DD0000">"This is a test.\nThis is only a test.\nThis is not an important string.\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"The original text is " </span><span style="color: #007700">. </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$original_text</span><span style="color: #007700">) . </span><span style="color: #DD0000">" characters long.\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.deflated'</span><span style="color: #007700">, </span><span style="color: #DD0000">'w'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/* 这里的 “6” 代表压缩级别为 6 */<br /></span><span style="color: #0000BB">stream_filter_append</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">'zlib.deflate'</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_FILTER_WRITE</span><span style="color: #007700">, </span><span style="color: #0000BB">6</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">$original_text</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"The compressed file is " </span><span style="color: #007700">. </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #DD0000">'test.deflated'</span><span style="color: #007700">) . </span><span style="color: #DD0000">" bytes long.\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* 生成的输出：<br /><br />The original text is 70 characters long.<br />The compressed file is 56 bytes long.<br /><br /> */<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
</div>

    </div>
 </div>

 <div class="section" id="filters.compression.bzip2">
  <h2 class="title">bzip2.compress 和 bzip2.decompress</h2>
    <p class="simpara">
    <code class="literal">bzip2.compress</code> 和 
    <code class="literal">bzip2.decompress</code> 工作的方式与上面讲的 zlib 过滤器相同。

    <code class="literal">bzip2.compress</code> 过滤器接受以一个关联数组给出的最多两个参数：

    <code class="parameter">blocks</code> 是从 1 到 9 的整数值，指定分配多少个 100K 字节的内存块作为工作区。

    <code class="parameter">work</code> 是 0 到 250 的整数值，指定在退回到一个慢一些，
     但更可靠的算法之前做多少次常规压缩算法的尝试。调整此参数仅影响到速度，
     压缩输出和内存使用都不受此设置的影响。将此参数设为 0 指示 bzip 库使用内部默认算法。

    <code class="literal">bzip2.decompress</code> 过滤器仅接受一个参数，可以用普通的布尔值传递，
     或者用一个关联数组中的 <code class="parameter">small</code> 单元传递。

     当 <code class="parameter">small</code> 设为 &amp;true; 值时，指示 bzip 库用最小的内存占用来执行解压缩，
     代价是速度会慢一些。
    </p>

    <p class="simpara">
     在激活 <a href="ref.bzip2.php" class="link">bz2</a> 支持的前提下可以使用 bzip2.* 压缩过滤器。
    </p>

    <div class="example" id="example-3">
      <p><strong>示例 #3 
       <code class="literal">bzip2.compress</code> 和
       <code class="literal">bzip2.decompress</code>
      </strong></p>
      <div class="example-contents">
        <div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$param </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'blocks' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">9</span><span style="color: #007700">, </span><span style="color: #DD0000">'work' </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"The original file is " </span><span style="color: #007700">. </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #DD0000">'LICENSE'</span><span style="color: #007700">) . </span><span style="color: #DD0000">" bytes long.\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'LICENSE.compressed'</span><span style="color: #007700">, </span><span style="color: #DD0000">'w'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">stream_filter_append</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #DD0000">'bzip2.compress'</span><span style="color: #007700">, </span><span style="color: #0000BB">STREAM_FILTER_WRITE</span><span style="color: #007700">, </span><span style="color: #0000BB">$param</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">, </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'LICENSE'</span><span style="color: #007700">));<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #DD0000">"The compressed file is " </span><span style="color: #007700">. </span><span style="color: #0000BB">filesize</span><span style="color: #007700">(</span><span style="color: #DD0000">'LICENSE.compressed'</span><span style="color: #007700">) . </span><span style="color: #DD0000">" bytes long.\n"</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">/* 生成的输出：<br /><br />The original file is 3288 bytes long.<br />The compressed file is 1488 bytes long.<br /><br /> */<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
</div>

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