PHP 5.4.31 Released

PharFileInfo::decompress

(PHP >= 5.3.0, PECL phar >= 2.0.0)

PharFileInfo::decompressDecompresses the current Phar entry within the phar

Description

public bool PharFileInfo::decompress ( void )

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 if the file is within a Phar archive. Files within PharData archives do not have this restriction.

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::decompress() example

<?php
try {
    
$p = new Phar('/path/to/my.phar'0'my.phar');
    
$p['myfile.txt'] = 'hi';
    
$file $p['myfile.txt'];
    
$file->compress(Phar::GZ);
    
var_dump($file->isCompressed());
    
$p['myfile.txt']->decompress();
    
var_dump($file->isCompressed());
} catch (
Exception $e) {
    echo 
'Create/modify failed for my.phar: '$e;
}
?>

The above example will output:

int(4096)
bool(false)

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top