<!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 tar/zip archive</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="phardata.delmetadata.html">PharData::delMetadata</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.extractto.html">PharData::extractTo</a></div> <div class="up"><a href="class.phardata.html">PharData</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="phardata.delete" class="refentry"> <div class="refnamediv"> <h1 class="refname">PharData::delete</h1> <p class="verinfo">(PHP >= 5.3.0, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::delete</span> — <span class="dc-title">Delete a file within a tar/zip archive</span></p> </div> <div class="refsect1 description" id="refsect1-phardata.delete-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>PharData::delete</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$entry</code></span> )</div> <p class="para rdfs-comment"> 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-phardata.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-phardata.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-phardata.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-phardata.delete-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-720"> <p><strong>Example #1 A <span class="function"><strong>PharData::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">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'myphar.zip'</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-phardata.delete-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> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="phardata.delmetadata.html">PharData::delMetadata</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.extractto.html">PharData::extractTo</a></div> <div class="up"><a href="class.phardata.html">PharData</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>