/php-manual-en-20100611/php-chunked-xhtml/phar.decompress.html
HTML | 145 lines | 120 code | 25 blank | 0 comment | 0 complexity | edb079019f376aa1ed686665a22d4dd7 MD5 | raw file
- <!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>Decompresses the entire Phar archive</title>
- </head>
- <body><div class="manualnavbar" style="text-align: center;">
- <div class="prev" style="text-align: left; float: left;"><a href="phar.createdefaultstub.html">Phar::createDefaultStub</a></div>
- <div class="next" style="text-align: right; float: right;"><a href="phar.decompressfiles.html">Phar::decompressFiles</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.decompress" class="refentry">
- <div class="refnamediv">
- <h1 class="refname">Phar::decompress</h1>
- <p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::decompress</span> — <span class="dc-title">Decompresses the entire Phar archive</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>Phar::decompress</b></span>
- ([ <span class="methodparam"> <span class="type">string</span> <tt class="parameter">$extension</tt></span>
- ] )</div>
- <blockquote><p><b class="note">Note</b>: This
- method requires the <var class="filename">php.ini</var> setting <i>phar.readonly</i> to be
- set 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 decompresses the entire archive.
- </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 decompress
- an archive compressed with with gzip compression, and the
- <a href="ref.bzip2.html" class="link">bzip2</a> extension must be
- enabled in order to decompress an archive compressed 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 changes the file extension of the archive,
- <i>.phar</i>
- by default for phar archives, or <i>.phar.tar</i> for tar-based phar archives.
- Alternatively, a file extension may be specified with the second
- parameter.
- </p>
- </div>
- <div class="refsect1 parameters">
- <h3 class="title">Parameters</h3>
- <p class="para">
- <dl>
- <dt>
- <span class="term"><i><tt class="parameter">extension</tt></i></span>
- <dd>
- <p class="para">
- For decompressing, the default file extensions
- are <i>.phar</i> and <i>.phar.tar</i>.
- Use this parameter to specify another file extension. Be aware
- that all executable phar archives must contain <i>.phar</i>
- in their filename.
- </p>
- </dd>
- </dt>
- </dl>
- </p>
- </div>
- <div class="refsect1 returnvalues">
- <h3 class="title">Return Values</h3>
- <p class="para">
- A <a href="class.Phar.html" class="classname">Phar</a> object is returned.
- </p>
- </div>
- <div class="refsect1 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">
- <h3 class="title">Examples</h3>
- <p class="para">
- <div class="example">
- <p><b>Example #1 A <span class="function"><b>Phar::decompress()</b></span> 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.gz'</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">$p3 </span><span style="color: #007700">= </span><span style="color: #0000BB">$p2</span><span style="color: #007700">-></span><span style="color: #0000BB">decompress</span><span style="color: #007700">(); </span><span style="color: #FF8000">// creates /path/to/my.phar<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"><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.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.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.createdefaultstub.html">Phar::createDefaultStub</a></div>
- <div class="next" style="text-align: right; float: right;"><a href="phar.decompressfiles.html">Phar::decompressFiles</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>