📄 phar.compress.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Compresses the entire Phar archive using Gzip or Bzip2 compression</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div 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">(No version information available, might be only in CVS)</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"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">object</span> <span class="methodname"><b><b>Phar::compress</b></b></span> ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$compression</tt></span> [, <span class="methodparam"><span class="type">string</span> <tt class="parameter">$extension</tt></span> ] )</div> <blockquote><p><b class="note">Note</b>: Thismethod requires the <var class="filename">php.ini</var> setting <i>phar.readonly</i> to beset to <i>0</i> 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.<br /></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 <i>.gz</i>, <i>.bz2</i> or removing the extension if passed <i>Phar::NONE</i> to remove compression. Alternatively, a file extension may be specified with the second parameter. </p> <p class="para"> A <a href="class.Phar.html" class="classname">Phar</a> object is returned. </p> </div> <div class="refsect1 parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><i><tt class="parameter">compression</tt></i></span> <dd> <p class="para"> Compression must be one of <i>Phar::GZ</i>, <i>Phar::BZ2</i> to add compression, or <i>Phar::NONE</i> to remove compression. </p> </dd> </dt> <dt> <span class="term"><i><tt class="parameter">extension</tt></i></span> <dd> <p class="para"> By default, the extension is <i>.phar.gz</i> or <i>.phar.bz2</i> for compressing phar archives, and <i>.phar.tar.gz</i> or <i>.phar.tar.bz2</i> for compressing tar archives. For decompressing, the default file extensions are <i>.phar</i> and <i>.phar.tar</i>. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Throws <b class="classname">BadMethodCallException</b> 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"> <h3 class="title">Examples</h3> <p class="para"> <div class="example"> <p><b>Example #1 A <b>Phar::compress()</b> example</b></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"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"><a href="pharfileinfo.getcompressedsize.html" class="function" rel="rdfs-seeAlso">PharFileInfo::getCompressedSize()</a></li> <li class="member"><a href="pharfileinfo.iscompressed.html" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressed()</a></li> <li class="member"><a href="pharfileinfo.compress.html" class="function" rel="rdfs-seeAlso">PharFileInfo::compress()</a></li> <li class="member"><a href="pharfileinfo.decompress.html" class="function" rel="rdfs-seeAlso">PharFileInfo::decompress()</a></li> <li class="member"><a href="phardata.compress.html" class="function" rel="rdfs-seeAlso">PharData::compress()</a></li> <li class="member"><a href="phar.cancompress.html" class="function" rel="rdfs-seeAlso">Phar::canCompress()</a></li> <li class="member"><a href="phar.iscompressed.html" class="function" rel="rdfs-seeAlso">Phar::isCompressed()</a></li> <li class="member"><a href="phar.decompress.html" class="function" rel="rdfs-seeAlso">Phar::decompress()</a></li> <li class="member"><a href="phar.getsupportedcompression.html" class="function" rel="rdfs-seeAlso">Phar::getSupportedCompression()</a></li> <li class="member"><a href="phar.compressfiles.html" class="function" rel="rdfs-seeAlso">Phar::compressFiles()</a></li> <li class="member"><a href="phar.decompressfiles.html" class="function" rel="rdfs-seeAlso">Phar::decompressFiles()</a></li> </ul> </p> </div></div><hr /><div 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>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -