PhpRiot
Become Zend Certified

Prepare for the ZCE exam using our quizzes (web or iPad/iPhone). More info...


When you're ready get 7.5% off your exam voucher using voucher CJQNOV23 at the Zend Store

Phar::uncompressAllFiles

(PECL phar < 2.0.0)

Phar::uncompressAllFilesUncompresses all files in the current Phar archive

Description

public bool Phar::uncompressAllFiles ( void )

Note:

This method has been removed from the phar extension as of version 2.0.0. Alternative implementations are available using Phar::compress(), Phar::decompress(), Phar::compressFiles() and Phar::decompressFiles().

Note:

This method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException will be thrown.

This method decompresses all files in the Phar archive. If any files are already compressed using gzip compression, the zlib extension must be enabled in order to decompress the files, and any files compressed using bzip2 compression require the bzip2 extension to decompress the files. 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, the bzip2 extension is not enabled and any files are compressed using bzip2 compression, or if any files are compressed using gzip compression and the zlib extension is not enabled.

Examples

Example #1 A Phar::uncompressAllFiles() example

<?php
try {
    
$p = new Phar('/path/to/my.phar'0'my.phar');
    
$p['myfile.txt'] = 'hi';
    
$p['myfile2.txt'] = 'hi';
    
$p->compressAllFilesGZ();
    foreach (
$p as $file) {
        
var_dump($file->getFileName());
        
var_dump($file->isCompressed());
        
var_dump($file->isCompressedBZIP2());
        
var_dump($file->isCompressedGZ());
    }
    
$p->uncompressAllFiles();
    foreach (
$p as $file) {
        
var_dump($file->getFileName());
        
var_dump($file->isCompressed());
        
var_dump($file->isCompressedBZIP2());
        
var_dump($file->isCompressedGZ());
    }
} catch (
Exception $e) {
    echo 
'Write operations failed on my.phar: '$e;
}
?>

The above example will output:

string(10) "myfile.txt"
bool(true)
bool(false)
bool(true)
string(11) "myfile2.txt"
bool(true)
bool(false)
bool(true)
string(10) "myfile.txt"
bool(false)
bool(false)
bool(false)
string(11) "myfile2.txt"
bool(false)
bool(false)
bool(false)

See Also

PHP Manual