PharData::compress
(PHP >= 5.3.0, PECL phar >= 2.0.0)
PharData::compress — Compresses the entire tar/zip archive using Gzip or Bzip2 compression
Description
$compression
[, string $extension
] )For tar 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 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.
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.
Return Values
A PharData object is returned.
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
?>
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Расширения для сжатия и архивации
- Phar
- Функция PharData::addEmptyDir() - Add an empty directory to the tar/zip archive
- Функция PharData::addFile() - Add a file from the filesystem to the tar/zip archive
- Функция PharData::addFromString() - Add a file from the filesystem to the tar/zip archive
- Функция PharData::buildFromDirectory() - Construct a tar/zip archive from the files within a directory.
- Функция PharData::buildFromIterator() - Construct a tar or zip archive from an iterator.
- Функция PharData::compress() - Compresses the entire tar/zip archive using Gzip or Bzip2 compression
- Функция PharData::compressFiles() - Compresses all files in the current tar/zip archive
- Функция PharData::__construct() - Construct a non-executable tar or zip archive object
- Функция PharData::convertToData() - Convert a phar archive to a non-executable tar or zip file
- Функция PharData::convertToExecutable() - Convert a non-executable tar/zip archive to an executable phar archive
- Функция PharData::copy() - Copy a file internal to the phar archive to another new file within the phar
- Функция PharData::decompress() - Decompresses the entire Phar archive
- Функция PharData::decompressFiles() - Decompresses all files in the current zip archive
- Функция PharData::delMetadata() - Deletes the global metadata of a zip archive
- Функция PharData::delete() - Delete a file within a tar/zip archive
- Функция PharData::extractTo() - Extract the contents of a tar/zip archive to a directory
- Функция PharData::isWritable() - Returns true if the tar/zip archive can be modified
- Функция PharData::offsetSet() - set the contents of a file within the tar/zip to those of an external file or string
- Функция PharData::offsetUnset() - remove a file from a tar/zip archive
- Функция PharData::setAlias() - dummy function (Phar::setAlias is not valid for PharData)
- Функция PharData::setDefaultStub() - dummy function (Phar::setDefaultStub is not valid for PharData)
- Функция Phar::setMetadata() - Sets phar archive meta-data
- Функция Phar::setSignatureAlgorithm() - set the signature algorithm for a phar and apply it. The
- Функция PharData::setStub() - dummy function (Phar::setStub is not valid for PharData)
Коментарии
This method destroys everything after the first dot in your filename and replaces it with the zip extension (.tar.gz, etc)
Example:
<?php
$tarfile = "2.5.0.0-RC1.tar";
$pd = new \PharData($tarfile);
$pd->buildFromDirectory("/path/to/contents");
$pd->compress(\Phar::GZ);
?>
Ends up with a file named "2.tar.gz"
This is a very irritating bug. You can use this to get around it though:
$data = 'some.test.string';
$phar = new PharData('test.tar');
$phar->compress(Phar::GZ, substr($data, strpos($data, '.') + 1));