<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Completely remove a phar archive from disk and from memory</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.uncompressallfiles.html">Phar::uncompressAllFiles</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.webphar.html">Phar::webPhar</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="phar.unlinkarchive" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::unlinkArchive</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::unlinkArchive</span> — <span class="dc-title">Completely remove a phar archive from disk and from memory</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.unlinkarchive-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><strong>Phar::unlinkArchive</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$archive</code></span>
)</div>
<p class="para rdfs-comment">
Removes a phar archive for disk and memory.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.unlinkarchive-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">archive</code></em></span>
<dd>
<p class="para">
The path on disk to the phar archive.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.unlinkarchive-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.unlinkarchive-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
<a href="class.pharexception.html" class="classname">PharException</a> is thrown if there are any open file pointers to
the phar archive, or any existing <a href="class.phar.html" class="classname">Phar</a>, <a href="class.phardata.html" class="classname">PharData</a>,
or <a href="class.pharfileinfo.html" class="classname">PharFileInfo</a> objects referring to the phar archive.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.unlinkarchive-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-703">
<p><strong>Example #1 A <span class="function"><strong>Phar::unlinkArchive()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// simple usage<br /></span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">unlinkArchive</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.phar'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// more common example:<br /></span><span style="color: #0000BB">$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'my.phar'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$fp </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">'phar://my.phar/file.txt'</span><span style="color: #007700">, </span><span style="color: #DD0000">'r'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// this creates 'my.phar.gz'<br /></span><span style="color: #0000BB">$gp </span><span style="color: #007700">= </span><span style="color: #0000BB">$p</span><span style="color: #007700">-></span><span style="color: #0000BB">compress</span><span style="color: #007700">(</span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">GZ</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// remove all references to the archive<br /></span><span style="color: #007700">unset(</span><span style="color: #0000BB">$p</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fp</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// now remove all traces of the archive<br /></span><span style="color: #0000BB">Phar</span><span style="color: #007700">::</span><span style="color: #0000BB">unlinkArchive</span><span style="color: #007700">(</span><span style="color: #DD0000">'my.phar'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-phar.unlinkarchive-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phar.delete.html" class="function" rel="rdfs-seeAlso">Phar::delete()</a> - Delete a file within a phar archive</span></li>
<li class="member"> <span class="function"><a href="phar.offsetunset.html" class="function" rel="rdfs-seeAlso">Phar::offsetUnset()</a> - remove a file from a phar</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.uncompressallfiles.html">Phar::uncompressAllFiles</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.webphar.html">Phar::webPhar</a></div>
<div class="up"><a href="class.phar.html">Phar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
