Phar::isCompressed

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

Phar::isCompressedphar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を返す

説明

public Phar::isCompressed(): int|false

注意:

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

phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を返します。 zip 形式の phar アーカイブはファイル単位で圧縮することができません。 そのため、zip 形式の phar アーカイブを調べたときはこのメソッドは常に false を返します。

パラメータ

パラメータはありません。

戻り値

Phar::GZPhar::BZ2 あるいは false を返します。

例1 Phar::isCompressed() の例

<?php
try {
    
$phar1 = new Phar('myphar.zip.phar');
    
var_dump($phar1->isCompressed());
    
$phar2 = new Phar('myuncompressed.tar.phar');
    
var_dump($phar2->isCompressed());
    
$phar2->compress(Phar::GZ);
    
var_dump($phar2->isCompressed() == Phar::GZ);
} catch (
Exception $e) {
}
?>

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

bool(false)
bool(false)
bool(true)

参考

関連キーワード:  Phar, 圧縮, アーカイブ, phar, tar, isCompressed, PharFileInfo, BZ, GZ, bz