PharData::convertToData
(PHP >= 5.3.0, PECL phar >= 2.0.0)
PharData::convertToData — Convert a phar archive to a non-executable tar or zip file
Description
This method is used to convert a non-executable tar or zip archive to another non-executable format.
If no changes are specified, this method throws a BadMethodCallException. This method should be used to convert a tar archive to zip format or vice-versa. Although it is possible to simply change the compression of a tar archive using this method, it is better to use the PharData::compress() method for logical consistency.
If successful, the method creates a new archive on disk and returns a PharData object. The old archive is not removed from disk, and should be done manually after the process has finished.
Parameters
-
format -
This should be one of Phar::TAR or Phar::ZIP. If set to
NULL, the existing file format will be preserved. -
compression -
This should be one of Phar::NONE for no whole-archive compression, Phar::GZ for zlib-based compression, and Phar::BZ2 for bzip-based compression.
-
extension -
This parameter is used to override the default file extension for a converted archive. Note that .phar cannot be used anywhere in the filename for a non-executable tar or zip archive.
If converting to a tar-based phar archive, the default extensions are .tar, .tar.gz, and .tar.bz2 depending on specified compression. For zip-based archives, the default extension is .zip.
Return Values
The method returns a PharData object on success and throws an exception on failure.
Errors/Exceptions
This method throws BadMethodCallException when unable to compress, an unknown compression method has been specified, the requested archive is buffering with Phar::startBuffering() and has not concluded with Phar::stopBuffering(), and a PharException if any problems are encountered during the phar creation process.
Examples
Example #1 A PharData::convertToData() example
Using PharData::convertToData():
<?php
try {
$tarphar = new PharData('myphar.tar');
// note that myphar.tar is *not* unlinked
// convert it to the non-executable tar file format
// creates myphar.zip
$zip = $tarphar->convertToData(Phar::ZIP);
// create myphar.tbz
$tgz = $zip->convertToData(Phar::TAR, Phar::BZ2, '.tbz');
// creates myphar.phar.tgz
$phar = $tarphar->convertToData(Phar::PHAR); // throws exception
} catch (Exception $e) {
// handle the error here
}
?>
See Also
- Phar::convertToExecutable() - Convert a phar archive to another executable phar archive file format
- Phar::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
- 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)
Коментарии
404 Not Found