PharFileInfo::setUncompressed
Uncompresses the current Phar entry within the phar, if it is compressed
Description
public bool PharFileInfo::setUncompressed
( void
)
Note:
This
method has been removed from the phar extension as of version 2.0.0. Alternative
implementations are available using PharFileInfo::isCompressed,
PharFileInfo::decompress, and PharFileInfo::compress.
This method decompresses the file inside the Phar archive.
Depending on how the file is compressed, the bzip2
or zlib extensions must be enabled to take
advantage of this feature. As with all functionality that modifies the contents of
a phar, the phar.readonly INI variable
must be off in order to succeed.
Return Values
Returns TRUE on success or FALSE on failure.
Errors/Exceptions
Throws BadMethodCallException if
the phar.readonly
INI variable is on, or if the bzip2/zlib
extension is not available.
Examples
Example #1 A PharFileInfo::setUncompressed example
<?php
try {
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$file = $p['myfile.txt'];
$file->setCompressedGZ();
var_dump($file->isCompressed());
$p['myfile.txt']->setUncompressed();
var_dump($file->isCompressed());
} catch (Exception $e) {
echo 'Create/modify failed for my.phar: ', $e;
}
?>
The above example will output:
See Also
- PharFileInfo::getCompressedSize
- PharFileInfo::isCompressedBZIP2
- PharFileInfo::isCompressed
- PharFileInfo::isCompressedGZ
- PharFileInfo::setCompressedBZIP2
- PharFileInfo::setCompressedGZ
- Phar::canCompress
- Phar::isCompressed
- Phar::compressAllFilesBZIP2
- Phar::compressAllFilesGZ
- Phar::getSupportedCompression
- Phar::uncompressAllFiles