Home/ Manual/ phar / PharFileInfo/ PharFileInfo::isCompressed

PharFileInfo::isCompressed

PHP function Edit on GitHub ✎

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL phar >= 1.0.0)

Returns whether the entry is compressed

Description

PharFileInfo::isCompressed(int|null $compression = null): bool

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

Parameters

compression: One of Phar::GZ or Phar::BZ2, defaults to any compression.

Return Values

true if the file is compressed within the Phar archive, false if not.

Changelog

Version	Description
8.0.0	`compression` is now nullable.

Examples

A PharFileInfo::isCompressed() example

php

<?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:

output

bool(false)
bool(true)