<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.phar.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'phar.compress.php',
    1 => 'Phar::compress',
    2 => 'Phar アーカイブ全体を Gzip あるいは Bzip2 で圧縮する',
  ),
  'up' => 
  array (
    0 => 'class.phar.php',
    1 => 'Phar',
  ),
  'prev' => 
  array (
    0 => 'phar.canwrite.php',
    1 => 'Phar::canWrite',
  ),
  'next' => 
  array (
    0 => 'phar.compressfiles.php',
    1 => 'Phar::compressFiles',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/phar/Phar/compress.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="phar.compress" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Phar::compress</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.3.0, PHP 7, PHP 8, PECL phar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::compress</span> &mdash; <span class="dc-title">Phar アーカイブ全体を Gzip あるいは Bzip2 で圧縮する</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-phar.compress-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Phar::compress</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$compression</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$extension</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.phar.php" class="type Phar">Phar</a></span></span></div>

 <blockquote class="note"><p><strong class="note">注意</strong>: <p class="para">
このメソッドは、<var class="filename">php.ini</var> の <code class="literal">phar.readonly</code>
が <code class="literal">0</code> でないと <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>
オブジェクトで動作しません。それ以外の場合は
<span class="classname"><a href="class.pharexception.php" class="classname">PharException</a></span> がスローされます。</p></p></blockquote>

  <p class="para">
   tar 形式あるいは phar 形式の phar アーカイブの場合は、
   このメソッドはアーカイブ全体を gzip あるいは bzip2 で圧縮します。
   できあがったファイルは gunzip/bunzip コマンドで処理することもできますし、
   Phar 拡張モジュールで直接透過的に使用することもできます。
  </p>
  <p class="para">
   zip 形式の phar アーカイブの場合は、このメソッドは失敗して例外が発生します。
   gzip で圧縮するためには <a href="ref.zlib.php" class="link">zlib</a>
   拡張モジュールが、そして bzip2 で圧縮するためには
   <a href="ref.bzip2.php" class="link">bzip2</a> 拡張モジュールが有効になっていなければなりません。
   この関数は phar の内容を変更するので、使用するには INI 設定
   <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a>
   が off になっていなければなりません。
  </p>
  <p class="para">
   さらに、このメソッドは自動的にアーカイブの名前を変更し、
   <code class="literal">.gz</code> あるいは <code class="literal">.bz2</code>
   を追加します。<code class="literal">Phar::NONE</code>
   を渡して圧縮を解除した場合は拡張子も削除します。
   もうひとつの方法として、ファイルの拡張子を 2 番目のパラメータで指定することもできます。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-phar.compress-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">compression</code></dt>
     <dd>
      <p class="para">
       圧縮を行う場合には <code class="literal">Phar::GZ</code> あるいは
       <code class="literal">Phar::BZ2</code>、圧縮を解除する場合には
       <code class="literal">Phar::NONE</code> を指定します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">extension</code></dt>
     <dd>
      <p class="para">
       デフォルトでは、phar 形式のアーカイブを圧縮する際の拡張子は
       <code class="literal">.phar.gz</code> あるいは <code class="literal">.phar.bz2</code>
       となり、tar 形式のアーカイブを圧縮する際の拡張子は
       <code class="literal">.phar.tar.gz</code> あるいは <code class="literal">.phar.tar.bz2</code>
       となります。伸長の際は、デフォルトの拡張子は
       <code class="literal">.phar</code> および <code class="literal">.phar.tar</code> となります。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-phar.compress-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span> オブジェクトを返します。
   失敗した場合は <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-phar.compress-errors">
  <h3 class="title">エラー / 例外</h3>
  <p class="para">
   INI 設定 <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a>
   が on の場合、<a href="ref.zlib.php" class="link">zlib</a>
   拡張モジュールが使用できない場合、あるいは
   <a href="ref.bzip2.php" class="link">bzip2</a> 拡張モジュールが使用できない場合に
   <span class="classname"><a href="class.badmethodcallexception.php" class="classname">BadMethodCallException</a></span> をスローします。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-phar.compress-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">extension</code> は、nullable になりました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-phar.compress-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>Phar::compress()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.phar'</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #DD0000">'my.phar'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile2.txt'</span><span style="color: #007700">] = </span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p1 </span><span style="color: #007700">= </span><span style="color: #0000BB">$p</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">compress</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">GZ</span><span style="color: #007700">); </span><span style="color: #FF8000">// /path/to/my.phar.gz にコピーします<br /></span><span style="color: #0000BB">$p2 </span><span style="color: #007700">= </span><span style="color: #0000BB">$p</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">compress</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">BZ2</span><span style="color: #007700">); </span><span style="color: #FF8000">// /path/to/my.phar.bz2 にコピーします<br /></span><span style="color: #0000BB">$p3 </span><span style="color: #007700">= </span><span style="color: #0000BB">$p2</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">compress</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">NONE</span><span style="color: #007700">); </span><span style="color: #FF8000">// 例外: /path/to/my.phar は既に存在します<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

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


 <div class="refsect1 seealso" id="refsect1-phar.compress-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="pharfileinfo.getcompressedsize.php" class="function" rel="rdfs-seeAlso">PharFileInfo::getCompressedSize()</a> - Phar アーカイブ内での実際のファイルの大きさ (圧縮された状態) を返す</span></li>
    <li><span class="function"><a href="pharfileinfo.iscompressed.php" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressed()</a> - エントリが圧縮されているかどうかを調べる</span></li>
    <li><span class="function"><a href="pharfileinfo.compress.php" class="function" rel="rdfs-seeAlso">PharFileInfo::compress()</a> - 現在の Phar エントリを zlib あるいは bzip2 のいずれかで圧縮する</span></li>
    <li><span class="function"><a href="pharfileinfo.decompress.php" class="function" rel="rdfs-seeAlso">PharFileInfo::decompress()</a> - phar 内の現在の Phar エントリの圧縮を解除する</span></li>
    <li><span class="function"><a href="phardata.compress.php" class="function" rel="rdfs-seeAlso">PharData::compress()</a> - tar/zip アーカイブ全体を Gzip あるいは Bzip2 で圧縮する</span></li>
    <li><span class="function"><a href="phar.cancompress.php" class="function" rel="rdfs-seeAlso">Phar::canCompress()</a> - phar 拡張モジュールが zlib あるいは bzip2 による圧縮をサポートしているかどうかを返す</span></li>
    <li><span class="function"><a href="phar.iscompressed.php" class="function" rel="rdfs-seeAlso">Phar::isCompressed()</a> - phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を返す</span></li>
    <li><span class="function"><a href="phar.decompress.php" class="function" rel="rdfs-seeAlso">Phar::decompress()</a> - Phar アーカイブ全体の圧縮を解除する</span></li>
    <li><span class="function"><a href="phar.getsupportedcompression.php" class="function" rel="rdfs-seeAlso">Phar::getSupportedCompression()</a> - サポートする圧縮アルゴリズムの配列を返す</span></li>
    <li><span class="function"><a href="phar.compressfiles.php" class="function" rel="rdfs-seeAlso">Phar::compressFiles()</a> - 現在の Phar アーカイブ内のすべてのファイルを圧縮する</span></li>
    <li><span class="function"><a href="phar.decompressfiles.php" class="function" rel="rdfs-seeAlso">Phar::decompressFiles()</a> - 現在の Phar アーカイブ内のすべてのファイルの圧縮を解除する</span></li>
   </ul>
  </p>
 </div>


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