Phar::compressAllFilesBZIP2
Phar::compressFiles
Phar
PHP Manual

# Phar::compressAllFilesGZ

Compresses all files in the current Phar archive using Gzip compression

### Description

public bool Phar::compressAllFilesGZ ( 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.

For tar-based phar archives, this method compresses the entire archive using gzip compression. The resulting file can be processed with the gunzip command, or accessed directly and transparently with the Phar extension.

For Zip-based and phar-based phar archives, this method compresses all files in the Phar archive using gzip compression. The zlib extension must be enabled to take advantage of this feature. In addition, if any files are already compressed using bzip2 compression, the bzip2 extension must be enabled in order to decompress the files prior to re-compressing with gzip compression. 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 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 Phar::compressAllFilesGZ example

`<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressedBZIP2());
var_dump($file->isCompressedGZ());
}
$p->compressAllFilesGZ();
foreach ($p as $file) {
var_dump($file->getFileName());
var_dump($file->isCompressed());
var_dump($file->isCompressedBZIP2());
var_dump($file->isCompressedGZ());
}
?>`

The above example will output:

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

### See Also

- PharFileInfo::getCompressedSize
- PharFileInfo::isCompressedBZIP2
- PharFileInfo::isCompressed
- PharFileInfo::isCompressedGZ
- PharFileInfo::setCompressedBZIP2
- PharFileInfo::setUncompressed
- PharFileInfo::setCompressedGZ
- Phar::canCompress
- Phar::isCompressed
- Phar::compressAllFilesBZIP2
- Phar::getSupportedCompression
- Phar::uncompressAllFiles