Phar::compress

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

Phar::compressCompresses the entire Phar archive using Gzip or Bzip2 compression

说明

public Phar::compress ( int $compression [, string $extension ] ) : object

Note:

此方法需要 将 php.ini 中的 phar.readonly 设为 0 以适合 Phar 对象. 否则, 将抛出PharException.

For tar-based and phar-based phar archives, this method compresses the entire archive using gzip compression or bzip2 compression. The resulting file can be processed with the gunzip command/bunzip command, or accessed directly and transparently with the Phar extension.

For Zip-based phar archives, this method fails with an exception. The zlib extension must be enabled to compress with gzip compression, the bzip2 extension must be enabled in order to compress with bzip2 compression. As with all functionality that modifies the contents of a phar, the phar.readonly INI variable must be off in order to succeed.

In addition, this method automatically renames the archive, appending .gz, .bz2 or removing the extension if passed Phar::NONE to remove compression. Alternatively, a file extension may be specified with the second parameter.

参数

compression

Compression must be one of Phar::GZ, Phar::BZ2 to add compression, or Phar::NONE to remove compression.

extension

By default, the extension is .phar.gz or .phar.bz2 for compressing phar archives, and .phar.tar.gz or .phar.tar.bz2 for compressing tar archives. For decompressing, the default file extensions are .phar and .phar.tar.

返回值

Returns a Phar object.

错误/异常

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

范例

Example #1 A Phar::compress() example

<?php
$p 
= new Phar('/path/to/my.phar'0'my.phar');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p1 $p->compress(Phar::GZ); // copies to /path/to/my.phar.gz
$p2 $p->compress(Phar::BZ2); // copies to /path/to/my.phar.bz2
$p3 $p2->compress(Phar::NONE); // exception: /path/to/my.phar already exists
?>

参见

相关文章
php phar returns whether phar extension supports compression using either zlib or bzip2php phar compresses the entire phar archive using gzip or bzip2 compressionphp phar compresses all files in the current phar archive using bzip2 compressionphp phar compresses all files in the current phar archive using gzip compressionphp phar compresses all files in the current phar archivephp phar copy a file internal to the phar archive to another new file within the pharphp phar returns the number of entries files in the phar archivephp phar decompresses the entire phar archivephp phar returns phar gz or phar bz2 if the entire phar archive is compressed .tar.gz/tar.bz and so on php phar returns true if the phar archive is based on the tar/phar/zip file format depending on the parameterphp phar set the alias for the phar archivephp phar used to set the php loader or bootstrap stub of a phar archive to the default loaderphp phar sets phar archive meta dataphp phardata compresses the entire tar/zip archive using gzip or bzip2 compressionphp phardata decompresses the entire phar archivephp pharfileinfo compresses the current phar entry with either zlib or bzip2 compressionphp pharfileinfo returns the actual size of the file with compression inside the phar archivephp pharfileinfo compresses the current phar entry within the phar using bzip2 compressionphp pharfileinfo compresses the current phar entry within the phar using gz compressionphp ziparchive add a file to a zip archive using its contents
关注编程学问公众号