PharFileInfo::isCompressed

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

説明

public bool PharFileInfo::isCompressed(intnull $compression = null)

これは、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
  • PharFileInfo::decompress
  • PharFileInfo::compress
  • Phar::decompress
  • Phar::compress
  • Phar::canCompress
  • Phar::isCompressed
  • Phar::getSupportedCompression
  • Phar::decompressFiles
  • Phar::compressFiles