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

contributors($setup);

?>
<div id="function.gzcompress" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">gzcompress</h1>
  <p class="verinfo">(PHP 4 &gt;= 4.0.1, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">gzcompress</span> &mdash; <span class="dc-title">文字列を圧縮する</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.gzcompress-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>gzcompress</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">$level</code><span class="initializer"> = -1</span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$encoding</code><span class="initializer"> = <strong><code><a href="zlib.constants.php#constant.zlib-encoding-deflate">ZLIB_ENCODING_DEFLATE</a></code></strong></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.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   この関数は、<code class="literal">ZLIB</code> データフォーマットを用いて
   与えられた文字列を圧縮します。
  </p>
  <p class="para">
   ZLIB 圧縮アルゴリズムについての詳細は、
   &quot;<a href="https://datatracker.ietf.org/doc/html/rfc1950" class="link external">&raquo;&nbsp;ZLIB Compressed Data Format
   Specification version 3.3</a>&quot; (RFC 1950) を参照ください。
  </p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="para">
    これは、いくつかのヘッダデータを有する gzip 圧縮と同じでは
    <em>ありません</em>。
    gzip圧縮については、<span class="function"><a href="function.gzencode.php" class="function">gzencode()</a></span>を参照ください。
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.gzcompress-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">data</code></dt>
     <dd>
      <p class="para">
       圧縮するデータ
      </p>
     </dd>
    
    
     <dt><code class="parameter">level</code></dt>
     <dd>
      <p class="para">
       圧縮レベル。0 で圧縮無し、9 で最大限の圧縮を指定できます。
      </p>
      <p class="para">
       -1 を指定すると、zlib ライブラリのデフォルトを使います。デフォルトは 6 です。
      </p>
     </dd>
    
    
     <dt><code class="parameter">encoding</code></dt>
     <dd>
      <p class="para">
       定数 <strong><code><a href="zlib.constants.php#constant.zlib-encoding-raw">ZLIB_ENCODING_<span class="replaceable">*</span></a></code></strong> のいずれか。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.gzcompress-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   圧縮された文字列、もしくはエラーの場合 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> 。
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.gzcompress-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>gzcompress()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$compressed </span><span style="color: #007700">= </span><span style="color: #0000BB">gzcompress</span><span style="color: #007700">(</span><span style="color: #DD0000">'Compress me'</span><span style="color: #007700">, </span><span style="color: #0000BB">9</span><span style="color: #007700">);<br />echo </span><span style="color: #0000BB">$compressed</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.gzcompress-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.gzdeflate.php" class="function" rel="rdfs-seeAlso">gzdeflate()</a> - 文字列を deflate 圧縮する</span></li>
    <li><span class="function"><a href="function.gzinflate.php" class="function" rel="rdfs-seeAlso">gzinflate()</a> - deflate圧縮された文字列を解凍する</span></li>
    <li><span class="function"><a href="function.gzuncompress.php" class="function" rel="rdfs-seeAlso">gzuncompress()</a> - 圧縮された文字列を解凍する</span></li>
    <li><span class="function"><a href="function.gzencode.php" class="function" rel="rdfs-seeAlso">gzencode()</a> - gzip 圧縮された文字列を作成する</span></li>
   </ul>
  </p>
 </div>

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