<!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 tar/zip 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="phardata.buildfromiterator.html">PharData::buildFromIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phardata.compressfiles.html">PharData::compressFiles</a></div>
<div class="up"><a href="class.phardata.html">PharData</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phardata.compress" class="refentry">
<div class="refnamediv">
<h1 class="refname">PharData::compress</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::compress</span> — <span class="dc-title">Compresses the entire tar/zip archive using Gzip or Bzip2 compression</span></p>
</div>
<div class="refsect1 description" id="refsect1-phardata.compress-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>PharData::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>
<p class="para rdfs-comment">
For tar 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 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.
</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-phardata.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>.tar.gz</em> or <em>.tar.bz2</em>
for compressing a tar, and <em>.tar</em> for decompressing.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phardata.compress-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
A <a href="class.phardata.html" class="classname">PharData</a> object is returned.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phardata.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="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-phardata.compress-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-711">
<p><strong>Example #1 A <span class="function"><strong>PharData::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">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.tar'</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-phardata.compress-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.compress.html" class="function" rel="rdfs-seeAlso">Phar::compress()</a> - Compresses the entire Phar archive using Gzip or Bzip2 compression</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="phardata.buildfromiterator.html">PharData::buildFromIterator</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phardata.compressfiles.html">PharData::compressFiles</a></div>
<div class="up"><a href="class.phardata.html">PharData</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
