PharFileInfo::setCompressedGZ

(PHP >= 5.3.0, PECL phar >= 1.0.0)

PharFileInfo::setCompressedGZ — Compresses the current Phar entry within the phar using gz compression

说明

public bool PharFileInfo::setCompressedGZ ( void )

Note:

此方法已经从 phar 扩展 2.0.0以上版本中删除。可使用 PharFileInfo::isCompressed()，PharFileInfo::decompress() 和 PharFileInfo::compress()替代。

This method compresses the file inside the Phar archive using gzip compression. The zlib extension must be enabled to take advantage of this feature. In addition, if the file is already compressed using bzip2 compression, the bzip2 extension must be enabled in order to decompress the file. As with all functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in order to succeed.

返回值

成功时返回 TRUE， 或者在失败时返回 FALSE。

错误／异常

Throws BadMethodCallException if the phar.readonly INI variable is on, or if the zlib extension is not available.

范例

Example #1 A PharFileInfo::setCompressedGZ() example

<?php
try {
    $p = new Phar('/path/to/my.phar', 0, 'my.phar');
    $p['myfile.txt'] = 'hi';
    $file = $p['myfile.txt'];
    var_dump($file->isCompressedGZ());
    $p['myfile.txt']->setCompressedGZ();
    var_dump($file->isCompressedGZ());
} catch (Exception $e) {
    echo 'Create/modify operations on my.phar failed: ', $e;
}
?>

以上例程会输出：

bool(false)
bool(true)

参见