PharFileInfo::isCompressed

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

    PharFileInfo::isCompressed — Returns whether the entry is compressed

    Description

    publicPharFileInfo::isCompressed(?int$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

    VersionDescription
    8.0.0compression is now nullable.

    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

    To Top