Phar::unlinkArchive

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

Phar::unlinkArchive — Completely remove a phar archive from disk and from memory

Description

bool Phar::unlinkArchive ( string $archive )

Parameters

archive: The path on disk to the phar archive.

Return Values

Returns TRUE if the archive is successfully removed from disk.

Errors/Exceptions

PharException is thrown if there are any open file pointers to the phar archive, or any existing Phar, PharData, or PharFileInfo objects referring to the phar archive.

Examples

Example #1 A Phar::unlinkArchive() example


<?php
// simple usage
Phar::unlinkArchive('/path/to/my.phar');

// more common example:
$p = new Phar('my.phar');
$fp = fopen('phar://my.phar/file.txt', 'r');
// this creates 'my.phar.gz'
$gp = $p->compress(Phar::GZ);
// remove all references to the archive
unset($p);
fclose($fp);
// now remove all traces of the archive
Phar::unlinkArchive('my.phar');
?>