Phar::isCompressed

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

Phar::isCompressed — Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)

Beschreibung

public mixed Phar::isCompressed ( void )

Hinweis:
Diese Methode des Phar-Objekts funktioniert nur wenn die php.ini-Einstellung phar.readonly auf 0 gesetzt ist, sonst wird eine PharException geworfen.

Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on). Zip-based phar archives cannot be compressed as a file, and so this method will always return FALSE if a zip-based phar archive is queried.

Parameter-Liste

No parameters.

Rückgabewerte

Phar::GZ, Phar::BZ2 or FALSE

Beispiele

Beispiel #1 A Phar::isCompressed() example


<?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) {
}
?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

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

Siehe auch

PharFileInfo::getCompressedSize() - Returns the actual size of the file (with compression) inside the Phar archive
PharFileInfo::isCompressed() - Returns whether the entry is compressed
PharFileInfo::decompress() - Decompresses the current Phar entry within the phar
PharFileInfo::compress() - Compresses the current Phar entry with either zlib or bzip2 compression
Phar::decompress() - Decompresses the entire Phar archive
Phar::compress() - Compresses the entire Phar archive using Gzip or Bzip2 compression
Phar::canCompress() - Returns whether phar extension supports compression using either zlib or bzip2
Phar::compressFiles() - Compresses all files in the current Phar archive
Phar::decompressFiles() - Decompresses all files in the current Phar archive
Phar::getSupportedCompression() - Return array of supported compression algorithms