PageRenderTime 53ms CodeModel.GetById 22ms RepoModel.GetById 1ms app.codeStats 0ms

/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
    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3.  <head>
    4. 

  4.   <meta http-equiv="content-type" content="text/html; charset=UTF-8">
    5. 

  5.   <title>Decompresses the entire Phar archive</title>
    6. 

  6. 

  7.  </head>
    8. 

  8.  <body><div class="manualnavbar" style="text-align: center;">
    9. 

  9.  <div class="prev" style="text-align: left; float: left;"><a href="phar.createdefaultstub.html">Phar::createDefaultStub</a></div>
    10. 

  10.  <div class="next" style="text-align: right; float: right;"><a href="phar.decompressfiles.html">Phar::decompressFiles</a></div>
    11. 

  11.  <div class="up"><a href="class.Phar.html">Phar</a></div>
    12. 

  12.  <div class="home"><a href="index.html">PHP Manual</a></div>
    13. 

  13. </div><hr /><div id="phar.decompress" class="refentry">
    14. 

  14.  <div class="refnamediv">
    15. 

  15.   <h1 class="refname">Phar::decompress</h1>
    16. 

  16.   <p class="verinfo">(PHP &gt;= 5.3.0, PECL phar &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::decompress</span> &mdash; <span class="dc-title">Decompresses the entire Phar archive</span></p>
    17. 

  17. 

  18.  </div>
    19. 

  19. 

  20.  <div class="refsect1 description">
    21. 

  21.   <h3 class="title">Description</h3>
    22. 

  22.   <div class="methodsynopsis dc-description">
    23. 

  23.     <span class="type">object</span>  <span class="methodname"><b>Phar::decompress</b></span>
    24. 

  24.     ([ <span class="methodparam"> <span class="type">string</span>  <tt class="parameter">$extension</tt></span>
    25. 

  25.   ] )</div>
    26. 

  26. 

  27.  <blockquote><p><b class="note">Note</b>: This
    28. 

  28. method requires the <var class="filename">php.ini</var> setting <i>phar.readonly</i> to be
    29. 

  29. set to <i>0</i> in order to work for <a href="class.Phar.html" class="classname">Phar</a>
    30. 

  30. objects.  Otherwise, a <a href="class.PharException.html" class="classname">PharException</a> will be thrown.<br /></p></blockquote>
    31. 

  31. 

  32.   <p class="para">
    33. 

  33.    For tar-based and phar-based phar archives, this method decompresses the entire archive.
    34. 

  34.   </p>
    35. 

  35.   <p class="para">
    36. 

  36.    For Zip-based phar archives, this method fails with an exception.
    37. 

  37.    The <a href="ref.zlib.html" class="link">zlib</a> extension must be enabled to decompress
    38. 

  38.    an archive compressed with with gzip compression, and the
    39. 

  39.    <a href="ref.bzip2.html" class="link">bzip2</a> extension must be
    40. 

  40.    enabled in order to decompress an archive compressed with bzip2 compression.
    41. 

  41.    As with all functionality that modifies the contents of a phar, the
    42. 

  42.    <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a> INI variable must be off
    43. 

  43.    in order to succeed.
    44. 

  44.   </p>
    45. 

  45.   <p class="para">
    46. 

  46.    In addition, this method automatically changes the file extension of the archive,
    47. 

  47.    <i>.phar</i>
    48. 

  48.    by default for phar archives, or <i>.phar.tar</i> for tar-based phar archives.
    49. 

  49.    Alternatively, a file extension may be specified with the second
    50. 

  50.    parameter.
    51. 

  51.   </p>
    52. 

  52.  </div>
    53. 

  53. 

  54. 

  55.  <div class="refsect1 parameters">
    56. 

  56.   <h3 class="title">Parameters</h3>
    57. 

  57.   <p class="para">
    58. 

  58.    <dl>
    59. 

  59. 

  60.     <dt>
    61. 

  61. 

  62.      <span class="term"><i><tt class="parameter">extension</tt></i></span>
    63. 

  63.      <dd>
    64. 

  64. 

  65.       <p class="para">
    66. 

  66.        For decompressing, the default file extensions
    67. 

  67.        are <i>.phar</i> and <i>.phar.tar</i>.
    68. 

  68.        Use this parameter to specify another file extension.  Be aware
    69. 

  69.        that all executable phar archives must contain <i>.phar</i>
    70. 

  70.        in their filename.
    71. 

  71.       </p>
    72. 

  72.      </dd>
    73. 

  73. 

  74.     </dt>
    75. 

  75. 

  76.    </dl>
    77. 

  77. 

  78.   </p>
    79. 

  79. 

  80.  </div>
    81. 

  81. 

  82. 

  83.  <div class="refsect1 returnvalues">
    84. 

  84.   <h3 class="title">Return Values</h3>
    85. 

  85.   <p class="para">
    86. 

  86.    A <a href="class.Phar.html" class="classname">Phar</a> object is returned.
    87. 

  87.   </p>
    88. 

  88.  </div>
    89. 

  89. 

  90. 

  91.  <div class="refsect1 errors">
    92. 

  92.   <h3 class="title">Errors/Exceptions</h3>
    93. 

  93.   <p class="para">
    94. 

  94.    Throws <a href="class.badmethodcallexception.html" class="classname">BadMethodCallException</a> if
    95. 

  95.    the <a href="phar.configuration.html#ini.phar.readonly" class="link">phar.readonly</a>
    96. 

  96.    INI variable is on, the <a href="ref.zlib.html" class="link">zlib</a>
    97. 

  97.    extension is not available, or the <a href="ref.bzip2.html" class="link">bzip2</a> extension
    98. 

  98.    is not enabled.
    99. 

  99.   </p>
    100. 

  100.  </div>
    101. 

  101. 

  102. 

  103.  <div class="refsect1 examples">
    104. 

  104.   <h3 class="title">Examples</h3>
    105. 

  105.   <p class="para">
    106. 

  106.    <div class="example">
    107. 

  107.     <p><b>Example #1 A <span class="function"><b>Phar::decompress()</b></span> example</b></p>
    108. 

  108.     <div class="example-contents">
    109. 

  109. <div class="phpcode"><code><span style="color: #000000">
    110. 

  110. <span style="color: #0000BB">&lt;?php<br />$p&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</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">,&nbsp;</span><span style="color: #0000BB">0</span><span style="color: #007700">,&nbsp;</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">]&nbsp;=&nbsp;</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">]&nbsp;=&nbsp;</span><span style="color: #DD0000">'hi'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$p3&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$p2</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">decompress</span><span style="color: #007700">();&nbsp;</span><span style="color: #FF8000">//&nbsp;creates&nbsp;/path/to/my.phar<br /></span><span style="color: #0000BB">?&gt;</span>
    111. 

  111. </span>
    112. 

  112. </code></div>
    113. 

  113.     </div>
    114. 

  114. 

  115.    </div>
    116. 

  116.   </p>
    117. 

  117.  </div>
    118. 

  118. 

  119. 

  120.  <div class="refsect1 seealso">
    121. 

  121.   <h3 class="title">See Also</h3>
    122. 

  122.   <p class="para">
    123. 

  123.    <ul class="simplelist">
    124. 

  124.     <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>
    125. 

  125.     <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>
    126. 

  126.     <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>
    127. 

  127.     <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>
    128. 

  128.     <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>
    129. 

  129.     <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>
    130. 

  130.     <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>
    131. 

  131.     <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>
    132. 

  132.     <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>
    133. 

  133.     <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>
    134. 

  134.     <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>
    135. 

  135.    </ul>
    136. 

  136.   </p>
    137. 

  137.  </div>
    138. 

  138. 

  139. 

  140. </div><hr /><div class="manualnavbar" style="text-align: center;">
    141. 

  141.  <div class="prev" style="text-align: left; float: left;"><a href="phar.createdefaultstub.html">Phar::createDefaultStub</a></div>
    142. 

  142.  <div class="next" style="text-align: right; float: right;"><a href="phar.decompressfiles.html">Phar::decompressFiles</a></div>
    143. 

  143.  <div class="up"><a href="class.Phar.html">Phar</a></div>
    144. 

  144.  <div class="home"><a href="index.html">PHP Manual</a></div>
    145. 

  145. </div></body></html>
    146. 

  146.