Edit Report a Bug

    PharFileInfo::compress

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

    PharFileInfo::compress — 現在の Phar エントリを zlib あるいは bzip2 のいずれかで圧縮する

    説明

    public PharFileInfo::compress(int $compression): bool

    このメソッドは、Phar アーカイブ内のファイルを bzip あるいは zlib で圧縮します。 この機能を使用するには bzip2 拡張モジュールあるいは zlib 拡張モジュールが有効になっていなければなりません。 さらに、ファイルがすでに圧縮されている場合には、 その圧縮をいったん解除するために対応する拡張モジュールが必要となります。 この関数は phar の内容を変更するので、Phar アーカイブ内のファイルを扱うには INI 設定 phar.readonly が off になっていなければなりません。 PharData アーカイブ内のファイルについてはこの制約はありません。

    パラメータ

    compression

    Phar::GZ または Phar::BZ2 を指定しなければいけません。

    戻り値

    成功した場合に true を、失敗した場合に false を返します。

    エラー / 例外

    INI 設定 phar.readonly が on の場合、あるいは zlib/zlib 拡張モジュールが使用できない場合に BadMethodCallException をスローします。

    例

    例1 PharFileInfo::compress() の例

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

    上の例の出力は以下となります。

    bool(false)
bool(true)

    参考

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top