PharFileInfo::isCompressed

Returns whether the entry is compressed

&reftitle.description; public `bool` `PharFileInfo::isCompressed` ``int``null```compression`&null;

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

&reftitle.parameters;

`compression`

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

&reftitle.returnvalues;

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

&reftitle.changelog;

&Version; | &Description;
8.0.0 | `compression` is now nullable.

&reftitle.examples;

### 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;
    }
    ?>

&example.outputs;

    bool(false)
    bool(true)

&reftitle.seealso;

- `PharFileInfo::getCompressedSize`
- `PharFileInfo::decompress`
- `PharFileInfo::compress`
- `Phar::decompress`
- `Phar::compress`
- `Phar::canCompress`
- `Phar::isCompressed`
- `Phar::getSupportedCompression`
- `Phar::decompressFiles`
- `Phar::compressFiles`