PharFileInfo::isCompressedBZIP2

(PHP >= 5.3.0, PECL phar >= 1.0.0)
Returns whether the entry is compressed using bzip2
public bool PharFileInfo::isCompressedBZIP2 ( 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 returns whether a file is compressed within a Phar archive with Bzip2 compression.

Returns:

TRUE if the file is compressed within the Phar archive using Bzip2, FALSE if not.

Examples:
A PharFileInfo::isCompressedBZIP2() example
<?php
try {
    $p = new Phar('/path/to/my.phar', 0, 'my.phar');
    $p['myfile.txt'] = 'hi';
    $p['myfile2.txt'] = 'hi';
    $p['myfile3.txt'] = 'hi';
    $p['myfile2.txt']->setCompressedGZ();
    $p['myfile3.txt']->setCompressedBZIP2();
    $file = $p['myfile.txt'];
    $file2 = $p['myfile2.txt'];
    $file3 = $p['myfile3.txt'];
    var_dump($file->isCompressedBZIP2());
    var_dump($file2->isCompressedBZIP2());
    var_dump($file3->isCompressedBZIP2());
} catch (Exception $e) {
    echo 'Create/modify on phar my.phar failed: ', $e;
}
?>

The above example will output:

bool(false)
bool(false)
bool(true)
See also:

PharFileInfo::getCompressedSize() -

PharFileInfo::isCompressed() -

PharFileInfo::isCompressedGZ() -

PharFileInfo::setCompressedBZIP2() -

PharFileInfo::setUncompressed() -

PharFileInfo::setCompressedGZ() -

Phar::canCompress() -

Phar::isCompressed() -

Phar::compressAllFilesBZIP2() -

Phar::compressAllFilesGZ() -

Phar::getSupportedCompression() -

Phar::uncompressAllFiles() -

doc_php
2016-02-24 15:55:30
Comments
Leave a Comment

Please login to continue.