PharData::decompressFiles
(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 2.0.0)
PharData::decompressFiles — Decompresses all files in the current zip archive
Description
public function PharData::decompressFiles():
true
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.
For tar-based archives, this method throws a
BadMethodCallException, as compression of individual
files within a tar archive is not supported by the file format. Use
PharData::compress() to compress an entire tar-based archive.
For Zip-based archives, this method decompresses all files in the
archive.
The zlib or bzip2
extensions must be enabled to take advantage of this feature if any files
are compressed using bzip2/zlib compression.
Parameters
This function has no parameters.
Return Values
Always returns true.
Errors/Exceptions
Throws BadMethodCallException if
the zlib
extension is not available, or if any files are compressed using
bzip2 compression and the bzip2 extension
is not enabled.
Examples
Example #1 A PharData::decompressFiles() example
<?php
$p = new PharData('/path/to/my.zip');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p->compressFiles(Phar::GZ);
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressed(Phar::BZ2));
var_dump($file->isCompressed(Phar::GZ));
}
$p->decompressFiles();
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressed(Phar::BZ2));
var_dump($file->isCompressed(Phar::GZ));
}
?>
The above example will output:
string(10) "myfile.txt"
int(4096)
bool(false)
bool(true)
string(11) "myfile2.txt"
int(4096)
bool(false)
bool(true)
string(10) "myfile.txt"
bool(false)
bool(false)
bool(false)
string(11) "myfile2.txt"
bool(false)
bool(false)
bool(false)
PharData::decompress
PharData