PharData::__construct
PharData::convertToTar
PharData
PHP Manual

# PharData::convertToPhar

(No version information available, might be only in CVS)

PharData::convertToPhar — Convert the tar/zip archive to the phar file format

### Description

bool PharData::convertToPhar ( string `$extension` )

> Note: This method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException will be thrown.

This method is used to convert a tar/zip archive to the executable phar file format.

### Parameters

`extension`

  By default, the extension is .phar for converting from uncompressed tar archives or any zip archive, .phar.gz for conversion from zlib-compressed tar archives, or .phar.bz2 for conversion from bzip2-compressed tar archives.

### Return Values

The method returns a Phar 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 PharData::startBuffering() and has not concluded with PharData::stopBuffering(), an UnexpectedValueException if write support is disabled, and a PharException if any problems are encountered during the phar creation process.

### Examples

Example#1 A PharData::convertToPhar() example

Using PharData::convertToPhar():

`<?php
try {
$tarphar = new PharData('myphar.tar');
// convert it to the phar file format
// note that myphar.tar is *not* unlinked
$phar = $tarphar->convertToPhar(); // creates myphar.phar
$phar->setStub($phar->createDefaultStub('cli.php', 'web/index.php'));
} catch (Exception $e) {
// handle the error here
}
?>`

### See Also

- Phar::convertToPhar()

PharData::__construct
PharData::convertToTar
PharData
PHP Manual