Source of: /manual/fa/pharfileinfo.setcompressedbzip2.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.PharFileInfo.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'fa',
),
'this' =>
array (
0 => 'pharfileinfo.setcompressedbzip2.php',
1 => 'PharFileInfo::setCompressedBZIP2',
),
'up' =>
array (
0 => 'class.PharFileInfo.php',
1 => 'PharFileInfo',
),
'prev' =>
array (
0 => 'pharfileinfo.iscompressedgz.php',
1 => 'PharFileInfo::isCompressedGZ',
),
'next' =>
array (
0 => 'pharfileinfo.setcompressedgz.php',
1 => 'PharFileInfo::setCompressedGZ',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div id="pharfileinfo.setcompressedbzip2" class="refentry">
<div class="refnamediv">
<h1 class="refname">PharFileInfo::setCompressedBZIP2</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 1.0.0)</p><p class="refpurpose"><span class="refname">PharFileInfo::setCompressedBZIP2</span> — <span class="dc-title">Compresses the current Phar entry within the phar using Bzip2 compression</span></p>
</div>
<div class="refsect1 description" id="refsect1-pharfileinfo.setcompressedbzip2-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><b>PharFileInfo::setCompressedBZIP2</b></span>
( <span class="methodparam">void</span>
)</div>
<blockquote class="note"><p><b class="note">Note</b>: <p class="para">This
method has been removed from the phar extension as of version 2.0.0. Alternative
implementations are available using <span class="function"><a href="pharfileinfo.iscompressed.php" class="function">PharFileInfo::isCompressed()</a></span>,
<span class="function"><a href="pharfileinfo.decompress.php" class="function">PharFileInfo::decompress()</a></span>, and <span class="function"><a href="pharfileinfo.compress.php" class="function">PharFileInfo::compress()</a></span>.</p></p></blockquote>
<p class="para">
This method compresses the file inside the Phar archive using bzip2 compression.
The <a href="ref.bzip2.php" class="link">bzip2</a> extension must be enabled to take
advantage of this feature. In addition, if the file is already compressed using
gzip compression, the <a href="ref.zlib.php" class="link">zlib</a> 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.php#ini.phar.readonly" class="link">phar.readonly</a> INI variable
must be off in order to succeed.
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-pharfileinfo.setcompressedbzip2-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <b><tt>TRUE</tt></b> on success or <b><tt>FALSE</tt></b> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-pharfileinfo.setcompressedbzip2-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.badmethodcallexception.php" class="classname">BadMethodCallException</a> if
the <a href="phar.configuration.php#ini.phar.readonly" class="link">phar.readonly</a>
INI variable is on, or if the <a href="ref.bzip2.php" class="link">bzip2</a>
extension is not available.
</p>
</div>
<div class="refsect1 examples" id="refsect1-pharfileinfo.setcompressedbzip2-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-749">
<p><b>Example #1 A <span class="function"><b>PharFileInfo::setCompressedBZIP2()</b></span> example</b></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">isCompressedBZIP2</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">setCompressedBZIP2</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">isCompressedBZIP2</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.setcompressedbzip2-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="pharfileinfo.getcompressedsize.php" 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.iscompressedbzip2.php" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressedBZIP2()</a> - Returns whether the entry is compressed using bzip2</span></li>
<li class="member"><span class="function"><a href="pharfileinfo.iscompressed.php" 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.iscompressedgz.php" class="function" rel="rdfs-seeAlso">PharFileInfo::isCompressedGZ()</a> - Returns whether the entry is compressed using gz</span></li>
<li class="member"><span class="function"><a href="pharfileinfo.setuncompressed.php" class="function" rel="rdfs-seeAlso">PharFileInfo::setUncompressed()</a> - Uncompresses the current Phar entry within the phar, if it is compressed</span></li>
<li class="member"><span class="function"><a href="pharfileinfo.setcompressedgz.php" class="function" rel="rdfs-seeAlso">PharFileInfo::setCompressedGZ()</a> - Compresses the current Phar entry within the phar using gz compression</span></li>
<li class="member"><span class="function"><a href="phar.cancompress.php" 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.php" 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.compressallfilesbzip2.php" class="function" rel="rdfs-seeAlso">Phar::compressAllFilesBZIP2()</a> - Compresses all files in the current Phar archive using Bzip2 compression</span></li>
<li class="member"><span class="function"><a href="phar.compressallfilesgz.php" class="function" rel="rdfs-seeAlso">Phar::compressAllFilesGZ()</a> - Compresses all files in the current Phar archive using Gzip compression</span></li>
<li class="member"><span class="function"><a href="phar.getsupportedcompression.php" 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.uncompressallfiles.php" class="function" rel="rdfs-seeAlso">Phar::uncompressAllFiles()</a> - Uncompresses all files in the current Phar archive</span></li>
</ul>
</p>
</div>
</div><?php manual_footer(); ?>
