Please wait while we load your page...
 

Announcements

PHP Manual :: PharFileInfo::setCompressedGZ



PharFileInfo::setCompressedBZIP2 || PharFileInfo::setMetadata || PharFileInfo || PHP Manual

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

PharFileInfo::setCompressedGZCompresses 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::setCompressedBZIP2 || PharFileInfo::setMetadata || PharFileInfo || PHP Manual
Live Chat Not Available