PharFileInfo::setCompressedGZ

PharFileInfo::setCompressedGZ

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

PharFileInfo::setCompressedGZ — Compresses the current Phar entry within the phar using gz compression

Description

public bool PharFileInfo::setCompressedGZ ( 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 compresses the file inside the Phar archive using gzip compression. The zlib extension must be enabled to take advantage of this feature. In addition, if the file is already compressed using bzip2 compression, the bzip2 extension must be enabled in order to decompress the file. 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 zlib extension is not available.

Examples

Example #1 A PharFileInfo::setCompressedGZ() example

<?php
try {
    $p = new Phar('/path/to/my.phar', 0, 'my.phar'
    $p['myfile.txt'] = 'hi';
    $file = $p['myfile.txt'];
    var_dump($file->isCompressedGZ()
    $p['myfile.txt']->setCompressedGZ(
    var_dump($file->isCompressedGZ()
} catch (Exception $e) {
    echo 'Create/modify operations on my.phar failed: ', $e;
}
?>

​

The above example will output:

​

​

bool(false)
bool(true)

​

See Also

• PharFileInfo::getCompressedSize() - Returns the actual size of the file (with compression) inside the Phar archive

• PharFileInfo::isCompressedBZIP2() - Returns whether the entry is compressed using bzip2

• PharFileInfo::isCompressed() - Returns whether the entry is compressed

• PharFileInfo::isCompressedGZ() - Returns whether the entry is compressed using gz

• PharFileInfo::setCompressedBZIP2() - Compresses the current Phar entry within the phar using Bzip2 compression

• PharFileInfo::setUncompressed() - Uncompresses the current Phar entry within the phar, if it is compressed

• Phar::canCompress() - Returns whether phar extension supports compression using either zlib or bzip2

• Phar::isCompressed() - Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)

• Phar::compressAllFilesBZIP2() - Compresses all files in the current Phar archive using Bzip2 compression

• Phar::compressAllFilesGZ() - Compresses all files in the current Phar archive using Gzip compression

• Phar::getSupportedCompression() - Return array of supported compression algorithms

• Phar::uncompressAllFiles() - Uncompresses all files in the current Phar archive

← PharFileInfo::setCompressedBZIP2

PharFileInfo::setMetadata →

 © 1997–2017 The PHP Documentation Group

Licensed under the Creative Commons Attribution License v3.0 or later.

https://secure.php.net/manual/en/pharfileinfo.setcompressedgz.php