<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Compresses the entire Phar archive using Gzip or Bzip2 compression</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.canwrite.html">Phar::canWrite</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.compressallfilesbzip2.html">Phar::compressAllFilesBZIP2</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.compress" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::compress</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::compress</span> — <span class="dc-title">Compresses the entire Phar archive using Gzip or Bzip2 compression</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.compress-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">object</span> <span class="methodname"><strong>Phar::compress</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension</code></span>
] )</div>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This
method requires the <var class="filename">php.ini</var> setting <em>phar.readonly</em> to be
set to <em>0</em> in order to work for <a href="class.phar.html" class="classname">Phar</a>
objects. Otherwise, a <a href="class.pharexception.html" class="classname">PharException</a> will be thrown.</p></p></blockquote>
<p class="para">
For tar-based and phar-based phar archives, this method compresses the entire archive using
gzip compression or bzip2 compression. The resulting file can be processed with the
gunzip command/bunzip command, or accessed directly and transparently with the Phar
extension.
</p>
<p class="para">
For Zip-based phar archives, this method fails with an exception.
The <a href="ref.zlib.html" class="link">zlib</a> extension must be enabled to compress
with gzip compression, the <a href="ref.bzip2.html" class="link">bzip2</a> extension must be
enabled in order to compress with bzip2 compression.
As with all functionality that modifies the contents of a phar, the
<a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> INI variable must be off
in order to succeed.
</p>
<p class="para">
In addition, this method automatically renames the archive, appending <em>.gz</em>,
<em>.bz2</em> or removing the extension if passed <em>Phar::NONE</em> to
remove compression. Alternatively, a file extension may be specified with the second
parameter.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.compress-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">compression</code></em></span>
<dd>
<p class="para">
Compression must be one of <em>Phar::GZ</em>,
<em>Phar::BZ2</em> to add compression, or <em>Phar::NONE</em>
to remove compression.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">extension</code></em></span>
<dd>
<p class="para">
By default, the extension is <em>.phar.gz</em>
or <em>.phar.bz2</em> for compressing phar archives, and
<em>.phar.tar.gz</em> or <em>.phar.tar.bz2</em> for
compressing tar archives. For decompressing, the default file extensions
are <em>.phar</em> and <em>.phar.tar</em>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.compress-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a <a href="class.phar.html" class="classname">Phar</a> object.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.compress-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if
the <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a>
INI variable is on, the <a href="ref.zlib.html" class="link">zlib</a>
extension is not available, or the <a href="ref.bzip2.html" class="link">bzip2</a> extension
is not enabled.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.compress-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-665">
<p><strong>Example #1 A <span class="function"><strong>Phar::compress()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?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">-></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">// copies to /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">-></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">// copies to /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">-></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">// exception: /path/to/my.phar already exists<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.compress-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="pharfileinfo.getcompressedsize.html" class="function" rel="rdfs-seeAlso">PharFileInfo::getCompressedSize()</a> - Returns the actual size of the file (with compression) inside the Phar archive</span></li>
<li class="member"> <span class="function"><a href="pharfileinfo.iscompressed.html" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressed()</a> - Returns whether the entry is compressed</span></li>
<li class="member"> <span class="function"><a href="pharfileinfo.compress.html" class="function" rel="rdfs-seeAlso">PharFileInfo::compress()</a> - Compresses the current Phar entry with either zlib or bzip2 compression</span></li>
<li class="member"> <span class="function"><a href="pharfileinfo.decompress.html" class="function" rel="rdfs-seeAlso">PharFileInfo::decompress()</a> - Decompresses the current Phar entry within the phar</span></li>
<li class="member"> <span class="function"><a href="phardata.compress.html" class="function" rel="rdfs-seeAlso">PharData::compress()</a> - Compresses the entire tar/zip archive using Gzip or Bzip2 compression</span></li>
<li class="member"> <span class="function"><a href="phar.cancompress.html" class="function" rel="rdfs-seeAlso">Phar::canCompress()</a> - Returns whether phar extension supports compression using either zlib or bzip2</span></li>
<li class="member"> <span class="function"><a href="phar.iscompressed.html" class="function" rel="rdfs-seeAlso">Phar::isCompressed()</a> - Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)</span></li>
<li class="member"> <span class="function"><a href="phar.decompress.html" class="function" rel="rdfs-seeAlso">Phar::decompress()</a> - Decompresses the entire Phar archive</span></li>
<li class="member"> <span class="function"><a href="phar.getsupportedcompression.html" class="function" rel="rdfs-seeAlso">Phar::getSupportedCompression()</a> - Return array of supported compression algorithms</span></li>
<li class="member"> <span class="function"><a href="phar.compressfiles.html" class="function" rel="rdfs-seeAlso">Phar::compressFiles()</a> - Compresses all files in the current Phar archive</span></li>
<li class="member"> <span class="function"><a href="phar.decompressfiles.html" class="function" rel="rdfs-seeAlso">Phar::decompressFiles()</a> - Decompresses all files in the current Phar archive</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.canwrite.html">Phar::canWrite</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.compressallfilesbzip2.html">Phar::compressAllFilesBZIP2</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
