PharFileInfo->isCompressed

(no version information, might be only in CVS)

PharFileInfo->isCompressed -- Returns whether the entry is compressed

Description

bool PharFileInfo->isCompressed ( void )

This returns whether a file is compressed within a Phar archive with either Gzip or Bzip2 compression.

Return Values

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

Examples

Example 1. A PharFileInfo->isCompressed() example

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

The above example will output:

bool(false)
bool(true)

See Also

PharFileInfo->getCompressedSize()
PharFileInfo->isCompressedGZ()
PharFileInfo->isCompressedBZIP2()