<!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 current Phar entry with either zlib or bzip2 compression</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pharfileinfo.chmod.html">PharFileInfo::chmod</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.construct.html">PharFileInfo::__construct</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="pharfileinfo.compress" class="refentry">
<div class="refnamediv">
<h1 class="refname">PharFileInfo::compress</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">PharFileInfo::compress</span> — <span class="dc-title">Compresses the current Phar entry with either zlib or bzip2 compression</span></p>
</div>
<div class="refsect1 description" id="refsect1-pharfileinfo.compress-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>PharFileInfo::compress</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span>
)</div>
<p class="para rdfs-comment">
This method compresses the file inside the Phar archive using either bzip2 compression
or zlib compression.
The <a href="ref.bzip2.html" class="link">bzip2</a> or <a href="ref.zlib.html" class="link">zlib</a>
extension must be enabled to take
advantage of this feature. In addition, if the file is already compressed,
the respective extension must be enabled in order
to decompress the file. 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 if the file is within a <a href="class.phar.html" class="classname">Phar</a>
archive. Files within <a href="class.phardata.html" class="classname">PharData</a> archives do not have
this restriction.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-pharfileinfo.compress-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-pharfileinfo.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, or if the <a href="ref.bzip2.html" class="link">bzip2</a>/<a href="ref.zlib.html" class="link">zlib</a>
extension is not available.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pharfileinfo.compress-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-726">
<p><strong>Example #1 A <span class="function"><strong>PharFileInfo::compress()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<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 /> </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">$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">-></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 /> </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: #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">-></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">'Create/modify operations on my.phar failed: '</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(false)
bool(true)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-pharfileinfo.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.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="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.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>
<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>
<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>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="pharfileinfo.chmod.html">PharFileInfo::chmod</a></div>
<div class="next" style="text-align: right; float: right;"><a href="pharfileinfo.construct.html">PharFileInfo::__construct</a></div>
<div class="up"><a href="class.pharfileinfo.html">PharFileInfo</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
