<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pharfileinfo.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'pharfileinfo.compress.php',
    1 => 'PharFileInfo::compress',
    2 => 'Сжимает текущий файл методом zlib или bzip2',
  ),
  'up' => 
  array (
    0 => 'class.pharfileinfo.php',
    1 => 'PharFileInfo',
  ),
  'prev' => 
  array (
    0 => 'pharfileinfo.chmod.php',
    1 => 'PharFileInfo::chmod',
  ),
  'next' => 
  array (
    0 => 'pharfileinfo.construct.php',
    1 => 'PharFileInfo::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/phar/PharFileInfo/compress.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="pharfileinfo.compress" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PharFileInfo::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">PharFileInfo::compress</span> &mdash; <span class="dc-title">Сжимает текущий файл методом zlib или bzip2</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-pharfileinfo.compress-description">
  <h3 class="title">Описание</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>PharFileInfo::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="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>


  <p class="para rdfs-comment">
   Метод сжимает файл в phar-архиве методом сжатия bzip2 или zlib.
   Для работы метода потребуется включить
   модуль <a href="ref.bzip2.php" class="link">bzip2</a> или <a href="ref.zlib.php" class="link">zlib</a>.
   Для распаковки уже сжатого файла также потребуется включить модуль,
   который соответствует методу сжатия. Как и с остальными функциями, которые изменяют
   содержимое phar-архива, для сжатия файла в <span class="classname"><a href="class.phar.php" class="classname">Phar</a></span>-архиве потребуется отключить
   INI-переменную <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a>;
   директива не ограничивает обработку архивов, с которыми работает класс
   <span class="classname"><a href="class.phardata.php" class="classname">PharData</a></span>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-pharfileinfo.compress-parameters">
  <h3 class="title">Список параметров</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">compression</code></dt>
     <dd>
      <p class="para">
       Параметр принимает только два вида сжатия: <strong><code><a href="phar.constants.php#phar.constants.gz">Phar::GZ</a></code></strong> и <strong><code><a href="phar.constants.php#phar.constants.bz2">Phar::BZ2</a></code></strong>.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-pharfileinfo.compress-returnvalues">
  <h3 class="title">Возвращаемые значения</h3>
  <p class="para">
   Функция возвращает <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>, если выполнилась успешно, или <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>, если возникла ошибка.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-pharfileinfo.compress-errors">
  <h3 class="title">Ошибки</h3>
  <p class="para">
   Метод выбрасывает исключение <span class="classname"><a href="class.badmethodcallexception.php" class="classname">BadMethodCallException</a></span>,
   если INI-переменная <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a> включена,
   или если модуль <a href="ref.bzip2.php" class="link">bzip2</a> или <a href="ref.zlib.php" class="link">zlib</a> недоступен.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-pharfileinfo.compress-examples">
  <h3 class="title">Примеры</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Пример #1 Пример сжатия файла методом <span class="function"><strong>PharFileInfo::compress()</strong></span></strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">try {<br />    </span><span style="color: #0000BB">$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 /><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 /><br />    </span><span style="color: #0000BB">$file </span><span style="color: #007700">= </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile.txt'</span><span style="color: #007700">];<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressed</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">));<br /><br />    </span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'myfile.txt'</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">);<br />    </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$file</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">isCompressed</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">));<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br />    echo </span><span style="color: #DD0000">'При попытке создать или модифицировать файл my.phar возникла ошибка: '</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    
<div class="example-contents"><p>
 Результат выполнения приведённого примера:
</p></div>

    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">bool(false)
bool(true)</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-pharfileinfo.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> - Получить реальный занимаемый файлом размер на диске с учётом сжатия</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.decompress.php" class="function" rel="rdfs-seeAlso">PharFileInfo::decompress()</a> - Распаковывает Phar-файл в phar-архиве</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::GZ или PHAR::BZ2, если phar-архив сжат целиком (.tar.gz/tar.bz и так далее)</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>
    <li><span class="function"><a href="phar.compress.php" class="function" rel="rdfs-seeAlso">Phar::compress()</a> - Сжимает весь Phar-архив с помощью Gzip- или Bzip2-сжатия</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>
   </ul>
  </p>
 </div>


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