phar 拡張モジュールが zlib あるいは bzip2 による圧縮をサポートしているかどうかを返す

# Phar::canCompress

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

Phar::canCompress — phar 拡張モジュールが zlib あるいは bzip2 による圧縮をサポートしているかどうかを返す

### 説明

final public static function Phar::canCompress(int `$compression` = 0): bool

これは、圧縮されたファイルを含む phar を読み込む前に、 圧縮が可能かどうかを調べるために使用します。

### パラメータ

`compression`

  `Phar::GZ` あるいは `Phar::BZ2` のいずれかを指定し、指定した圧縮アルゴリズムでの圧縮が可能かどうかを調べます。

### 戻り値

圧縮/展開 が可能な場合に `true`、そうでない場合に `false` を返します。

### 例

例1 Phar::canCompress() の例

    <?php
    if (Phar::canCompress()) {
        echo file_get_contents('phar://compressedphar.phar/internal/file.txt');
    } else {
        echo '圧縮はできません';
    }
    ?>

### 参考

- PharFileInfo::getCompressedSize() - Phar アーカイブ内での実際のファイルの大きさ (圧縮された状態) を返す
- PharFileInfo::isCompressed() - エントリが圧縮されているかどうかを調べる
- PharFileInfo::compress() - 現在の Phar エントリを zlib あるいは bzip2 のいずれかで圧縮する
- PharFileInfo::decompress() - phar 内の現在の Phar エントリの圧縮を解除する
- Phar::isCompressed() - phar アーカイブ全体が (.tar.gz/tar.bz などで) 圧縮されている場合に Phar::GZ あるいは PHAR::BZ2 を返す
- Phar::compressFiles() - 現在の Phar アーカイブ内のすべてのファイルを圧縮する
- Phar::decompressFiles() - 現在の Phar アーカイブ内のすべてのファイルの圧縮を解除する
- Phar::getSupportedCompression() - サポートする圧縮アルゴリズムの配列を返す
- Phar::convertToExecutable() - phar アーカイブを実行可能な別の phar アーカイブ形式に変換する
- Phar::convertToData() - phar アーカイブを実行可能でない tar あるいは zip ファイルに変換する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open