PharData::compress
(No version information available, might be only in CVS)
PharData::compress — Compresses the entire tar/zip archive using Gzip or Bzip2 compression
Description
object PharData::compress
( int $compression
, string $extension
)
For zip 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.
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.
A PharData object is returned.
Parameters
-
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 .tar.gz or .tar.bz2
for compressing a tar, and .tar for decompressing.
Errors/Exceptions
Throws BadMethodCallException if
the zlib
extension is not available, or the bzip2 extension
is not enabled.
Examples
Example #1 A PharData::compress() example
<?php
$p = new PharData('/path/to/my.tar');
$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
?>
Load balance : Server 01
