PharData::decompress
(PHP >= 5.3.0, PECL phar >= 2.0.0)
PharData::decompress — Decompresses the entire Phar archive
Описание
$extension
] )For tar-based archives, this method decompresses the entire archive.
For Zip-based archives, this method fails with an exception. The zlib extension must be enabled to decompress an archive compressed with gzip compression, and the bzip2 extension must be enabled in order to decompress an archive compressed with bzip2 compression.
In addition, this method automatically renames the file extension of the archive, .tar by default. Alternatively, a file extension may be specified with the second parameter.
Список параметров
-
extension -
For decompressing, the default file extension is .phar.tar. Use this parameter to specify another file extension. Be aware that no non-executable archives cannot contain .phar in their filename.
Возвращаемые значения
A PharData object is returned.
Ошибки
Throws BadMethodCallException if the zlib extension is not available, or the bzip2 extension is not enabled.
Примеры
Пример #1 A PharData::decompress() example
<?php
$p = new PharData('/path/to/my.tar', 0, 'my.tar.gz');
$p['myfile.txt'] = 'hi';
$p['myfile2.txt'] = 'hi';
$p3 = $p2->decompress(); // creates /path/to/my.tar
?>
Смотрите также
- PharFileInfo::getCompressedSize() - Returns the actual size of the file (with compression) inside the Phar archive
- PharFileInfo::isCompressed() - Returns whether the entry is compressed
- PharFileInfo::compress() - Compresses the current Phar entry with either zlib or bzip2 compression
- PharFileInfo::decompress() - Decompresses the current Phar entry within the phar
- PharData::compress() - Compresses the entire tar/zip archive using Gzip or Bzip2 compression
- Phar::canCompress() - Returns whether phar extension supports compression using either zlib or bzip2
- Phar::isCompressed() - Returns Phar::GZ or PHAR::BZ2 if the entire phar archive is compressed (.tar.gz/tar.bz and so on)
- PharData::compress() - Compresses the entire tar/zip archive using Gzip or Bzip2 compression
- Phar::getSupportedCompression() - Return array of supported compression algorithms
- PharData::compressFiles() - Compresses all files in the current tar/zip archive
- PharData::decompressFiles() - Decompresses all files in the current zip archive
- 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)
Коментарии
If filename contains multiple dots(.), you can preserve other parts by following code (example1).
Example #1 (Expected)
<?php
$filename = "abc.xyz.tar.gz";
$p = new PharData($filename);
$exts = explode('.', $filename);
array_shift($exts);
array_pop($exts);
$ext = implode('.', $exts);
$p->decompress($ext); # result filename: abc.xyz.tar
?>
Example #2 (might be unexpected)
<?php
$filename = "abc.xyz.tar.gz";
$p = new PharData($filename);
$p->decompress($filename); # result filename: abc.tar; xyz is truncated accidentally.
?>