Edit Report a Bug

    Phar::compress

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

    Phar::compress — Phar アーカイブ全体を Gzip あるいは Bzip2 で圧縮する

    説明

    public Phar::compress(int $compression, ?string $extension = null): ?Phar

    注意:

    このメソッドは、php.ini の phar.readonly が 0 でないと Phar オブジェクトで動作しません。それ以外の場合は PharException がスローされます。

    tar 形式あるいは phar 形式の phar アーカイブの場合は、 このメソッドはアーカイブ全体を gzip あるいは bzip2 で圧縮します。 できあがったファイルは gunzip/bunzip コマンドで処理することもできますし、 Phar 拡張モジュールで直接透過的に使用することもできます。

    zip 形式の phar アーカイブの場合は、このメソッドは失敗して例外が発生します。 gzip で圧縮するためには zlib 拡張モジュールが、そして bzip2 で圧縮するためには bzip2 拡張モジュールが有効になっていなければなりません。 この関数は phar の内容を変更するので、使用するには INI 設定 phar.readonly が off になっていなければなりません。

    さらに、このメソッドは自動的にアーカイブの名前を変更し、 .gz あるいは .bz2 を追加します。Phar::NONE を渡して圧縮を解除した場合は拡張子も削除します。 もうひとつの方法として、ファイルの拡張子を 2 番目のパラメータで指定することもできます。

    パラメータ

    compression

    圧縮を行う場合には Phar::GZ あるいは Phar::BZ2、圧縮を解除する場合には Phar::NONE を指定します。

    extension

    デフォルトでは、phar 形式のアーカイブを圧縮する際の拡張子は .phar.gz あるいは .phar.bz2 となり、tar 形式のアーカイブを圧縮する際の拡張子は .phar.tar.gz あるいは .phar.tar.bz2 となります。伸長の際は、デフォルトの拡張子は .phar および .phar.tar となります。

    戻り値

    Phar オブジェクトを返します。 失敗した場合は null を返します。

    エラー / 例外

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

    変更履歴

    バージョン 説明
    8.0.0 extension は、nullable になりました。

    例

    例1 Phar::compress() の例

    <?php
    $p     = new Phar('/path/to/my.phar', 0, 'my.phar');
    $p['myfile.txt'] = 'hi';
    $p['myfile2.txt'] = 'hi';
    $p1 = $p->compress(Phar::GZ); // /path/to/my.phar.gz にコピーします
    $p2 = $p->compress(Phar::BZ2); // /path/to/my.phar.bz2 にコピーします
    $p3 = $p2->compress(Phar::NONE); // 例外: /path/to/my.phar は既に存在します
    ?>

    参考

    add a note add a note

    User Contributed Notes 1 note

    up
    1
    mike at eyesis dot ca
    13 years ago
    For those who want the benefit of having a small compressed PHAR archive but don’t want to suffer the performance loss, use php_strip_whitespace when adding files to the archive. If your code has plenty of whitespace, docbocks, and single-line comments this function can greatly decrease archive size without the performance loss.

    <?php
    $sDir     = 'application';
    $oPhar = new Phar ('app.phar');

    $oDir = new RecursiveIteratorIterator (new RecursiveDirectoryIterator ($sDir), RecursiveIteratorIterator::SELF_FIRST);

    foreach (    $oDir as $sFile) {
        if (     preg_match ('/\\.php$/i', $sFile) ) {
                $oPhar->addFromString (substr ($sFile, strlen ($sDir) + 1), php_strip_whitespace ($sFile));
        }
    }
    ?>
    add a note add a note
    To Top