PharFileInfo::isCompressed

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

PharFileInfo::isCompressed — エントリが圧縮されているかどうかを調べる

説明

public PharFileInfo::isCompressed(?int $compression = null): bool

これは、Phar アーカイブ内のファイルが Gzip あるいは Bzip2 で圧縮されているかどうかを返します。

パラメータ

compression: Phar::GZ あるいは Phar::BZ2 のいずれか。デフォルトは任意の圧縮形式となります。

戻り値

Phar アーカイブ内のファイルが圧縮されている場合に true、そうでない場合に false を返します。

変更履歴

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

例

例1 PharFileInfo::isCompressed() の例

<?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 'my.phar の作成/変更に失敗しました: ', $e;
}
?>

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

bool(false)
bool(true)

参考

PharFileInfo::getCompressedSize() - Phar アーカイブ内での実際のファイルの大きさ (圧縮された状態) を返す
PharFileInfo::decompress() - phar 内の現在の Phar エントリの圧縮を解除する
PharFileInfo::compress() - 現在の Phar エントリを zlib あるいは bzip2 のいずれかで圧縮する
Phar::decompress() - Phar アーカイブ全体の圧縮を解除する
Phar::compress() - Phar アーカイブ全体を Gzip あるいは Bzip2 で圧縮する
Phar::canCompress() - phar 拡張モジュールが zlib あるいは bzip2 による圧縮をサポートしているかどうかを返す
Phar::isCompressed() - phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を返す
Phar::getSupportedCompression() - サポートする圧縮アルゴリズムの配列を返す
Phar::decompressFiles() - 現在の Phar アーカイブ内のすべてのファイルの圧縮を解除する
Phar::compressFiles() - 現在の Phar アーカイブ内のすべてのファイルを圧縮する