<!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>Delete a file within a phar archive</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="phar.delmetadata.html">Phar::delMetadata</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.extractto.html">Phar::extractTo</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.delete" class="refentry">
<div class="refnamediv">
<h1 class="refname">Phar::delete</h1>
<p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">Phar::delete</span> — <span class="dc-title">Delete a file within a phar archive</span></p>
</div>
<div class="refsect1 description" id="refsect1-phar.delete-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Phar::delete</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$entry</code></span>
)</div>
<blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">This
method requires the <var class="filename">php.ini</var> setting <em>phar.readonly</em> to be
set to <em>0</em> in order to work for <a href="class.phar.html" class="classname">Phar</a>
objects. Otherwise, a <a href="class.pharexception.html" class="classname">PharException</a> will be thrown.</p></p></blockquote>
<p class="para">
Delete a file within an archive. This is the functional equivalent of
calling <span class="function"><a href="function.unlink.html" class="function">unlink()</a></span> on the stream wrapper equivalent,
as shown in the example below.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-phar.delete-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">entry</code></em></span>
<dd>
<p class="para">
Path within an archive to the file to delete.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-phar.delete-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
returns <strong><code>TRUE</code></strong> on success, but it is better to check for thrown exception,
and assume success if none is thrown.
</p>
</div>
<div class="refsect1 errors" id="refsect1-phar.delete-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Throws <a href="class.pharexception.html" class="classname">PharException</a> if errors occur while flushing
changes to disk.
</p>
</div>
<div class="refsect1 examples" id="refsect1-phar.delete-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-678">
<p><strong>Example #1 A <span class="function"><strong>Phar::delete()</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: #007700">try {<br /> </span><span style="color: #0000BB">$phar </span><span style="color: #007700">= new </span><span style="color: #0000BB">Phar</span><span style="color: #007700">(</span><span style="color: #DD0000">'myphar.phar'</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$phar</span><span style="color: #007700">-></span><span style="color: #0000BB">delete</span><span style="color: #007700">(</span><span style="color: #DD0000">'unlink/me.php'</span><span style="color: #007700">);<br /> </span><span style="color: #FF8000">// this is equivalent to:<br /> </span><span style="color: #0000BB">unlink</span><span style="color: #007700">(</span><span style="color: #DD0000">'phar://myphar.phar/unlink/me.php'</span><span style="color: #007700">);<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// handle errors<br /></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.delete-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="phardata.delete.html" class="function" rel="rdfs-seeAlso">PharData::delete()</a> - Delete a file within a tar/zip archive</span></li>
<li class="member"> <span class="function"><a href="phar.unlinkarchive.html" class="function" rel="rdfs-seeAlso">Phar::unlinkArchive()</a> - Completely remove a phar archive from disk and from memory</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.delmetadata.html">Phar::delMetadata</a></div>
<div class="next" style="text-align: right; float: right;"><a href="phar.extractto.html">Phar::extractTo</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>
