<!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 all files in the current tar/zip archive</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="phardata.compress.html">PharData::compress</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.construct.html">PharData::__construct</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.compressfiles" class="refentry"> <div class="refnamediv"> <h1 class="refname">PharData::compressFiles</h1> <p class="verinfo">(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::compressFiles</span> — <span class="dc-title">Compresses all files in the current tar/zip archive</span></p> </div> <div class="refsect1 description" id="refsect1-phardata.compressfiles-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>PharData::compressFiles</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$compression</code></span> )</div> <p class="para rdfs-comment"> For tar-based archives, this method throws a <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a>, as compression of individual files within a tar archive is not supported by the file format. Use <span class="function"><a href="phardata.compress.html" class="function">PharData::compress()</a></span> to compress an entire tar-based archive. </p> <p class="para"> For Zip-based archives, this method compresses all files in the archive using the specified compression. The <a href="ref.zlib.html" class="link">zlib</a> or <a href="ref.bzip2.html" class="link">bzip2</a> extensions must be enabled to take advantage of this feature. In addition, if any files are already compressed using bzip2/zlib compression, the respective extension must be enabled in order to decompress the files prior to re-compressing. </p> </div> <div class="refsect1 parameters" id="refsect1-phardata.compressfiles-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">compression</code></dt> <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> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-phardata.compressfiles-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> No value is returned. </p> </div> <div class="refsect1 errors" id="refsect1-phardata.compressfiles-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 if any files are compressed using bzip2 compression and the <a href="ref.bzip2.html" class="link">bzip2</a> extension is not enabled. </p> </div> <div class="refsect1 examples" id="refsect1-phardata.compressfiles-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-796"> <p><strong>Example #1 A <span class="function"><strong>PharData::compressFiles()</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 />foreach (</span><span style="color: #0000BB">$p </span><span style="color: #007700">as </span><span style="color: #0000BB">$file</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">getFileName</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">());<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">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">GZ</span><span style="color: #007700">));<br />}<br /></span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">compressFiles</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">);<br />foreach (</span><span style="color: #0000BB">$p </span><span style="color: #007700">as </span><span style="color: #0000BB">$file</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">getFileName</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">());<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">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">GZ</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> string(10) "myfile.txt" bool(false) bool(false) bool(false) string(11) "myfile2.txt" bool(false) bool(false) bool(false) string(10) "myfile.txt" int(4096) bool(false) bool(true) string(11) "myfile2.txt" int(4096) bool(false) bool(true) </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-phardata.compressfiles-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="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="phardata.decompressfiles.html" class="function" rel="rdfs-seeAlso">PharData::decompressFiles()</a> - Decompresses all files in the current zip 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="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="phardata.decompress.html" class="function" rel="rdfs-seeAlso">PharData::decompress()</a> - Decompresses the entire 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="phardata.compress.html">PharData::compress</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.construct.html">PharData::__construct</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>