PharData::decompress

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

    PharData::decompress — Decompresses the entire Phar archive

    Опис

    public PharData::decompress(?string $extension = null): ?PharData

    For tar-based archives, this method decompresses the entire archive.

    For Zip-based archives, this method fails with an exception. The zlib extension must be enabled to decompress an archive compressed with gzip compression, and the bzip2 extension must be enabled in order to decompress an archive compressed with bzip2 compression.

    In addition, this method automatically renames the file extension of the archive, .tar by default. Alternatively, a file extension may be specified with the extension parameter.

    Параметри

    extension

    For decompressing, the default file extension is .tar. Use this parameter to specify another file extension. Be aware that only executable archives can contain .phar in their filename.

    Значення, що повертаються

    A PharData object is returned on success, or null on failure.

    Помилки/виключення

    Throws BadMethodCallException if the zlib extension is not available, or the bzip2 extension is not enabled.

    Журнал змін

    Версія Опис
    8.0.0 extension is now nullable.

    Приклади

    Приклад #1 A PharData::decompress() example

    <?php
    $p     = new PharData('/path/to/my.tar.gz');
    $p->decompress(); // creates /path/to/my.tar
    ?>

    Прогляньте також

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes 1 note

    up
    5
    pttlens at gmail dot com
    5 years ago
    If filename contains multiple dots(.), you can preserve other parts by following code (example1).

    Example #1 (Expected)
    <?php
    $filename     = "abc.xyz.tar.gz";
    $p = new PharData($filename);
    $exts = explode('.', $filename);
    array_shift($exts);
    array_pop($exts);
    $ext = implode('.', $exts);
    $p->decompress($ext); # result filename: abc.xyz.tar
    ?>

    Example #2 (might be unexpected)
    <?php
    $filename     = "abc.xyz.tar.gz";
    $p = new PharData($filename);
    $p->decompress($filename); # result filename: abc.tar; xyz is truncated accidentally.
    ?>
    ＋add a note
    To Top