<!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>Remove a file from 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.offsetset.html">PharData::offsetSet</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.setalias.html">PharData::setAlias</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.offsetunset" class="refentry"> <div class="refnamediv"> <h1 class="refname">PharData::offsetUnset</h1> <p class="verinfo">(PHP 5 >= 5.3.0, PHP 7, PECL phar >= 2.0.0)</p><p class="refpurpose"><span class="refname">PharData::offsetUnset</span> — <span class="dc-title">Remove a file from a tar/zip archive</span></p> </div> <div class="refsect1 description" id="refsect1-phardata.offsetunset-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>PharData::offsetUnset</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$offset</code></span> )</div> <p class="para rdfs-comment"> This is an implementation of the <span class="interfacename"><a href="class.arrayaccess.html" class="interfacename">ArrayAccess</a></span> interface allowing direct manipulation of the contents of a tar/zip archive using array access brackets. offsetUnset is used for deleting an existing file, and is called by the <span class="function"><a href="function.unset.html" class="function">unset()</a></span> language construct. </p> </div> <div class="refsect1 parameters" id="refsect1-phardata.offsetunset-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">offset</code></dt> <dd> <p class="para"> The filename (relative path) to modify in the tar/zip archive. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-phardata.offsetunset-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-phardata.offsetunset-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para"> Throws <a href="class.pharexception.html" class="classname">PharException</a> if there are any problems flushing changes made to the tar/zip archive to disk. </p> </div> <div class="refsect1 examples" id="refsect1-phardata.offsetunset-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-807"> <p><strong>Example #1 A <span class="function"><strong>PharData::offsetUnset()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$p </span><span style="color: #007700">= new </span><span style="color: #0000BB">PharData</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/my.zip'</span><span style="color: #007700">);<br />try {<br /> </span><span style="color: #FF8000">// deletes file.txt from my.zip by calling offsetUnset<br /> </span><span style="color: #007700">unset(</span><span style="color: #0000BB">$p</span><span style="color: #007700">[</span><span style="color: #DD0000">'file.txt'</span><span style="color: #007700">]);<br />} catch (</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">'Could not delete file.txt: '</span><span style="color: #007700">, </span><span style="color: #0000BB">$e</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-phardata.offsetunset-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <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="phardata.offsetset.html">PharData::offsetSet</a></div> <div class="next" style="text-align: right; float: right;"><a href="phardata.setalias.html">PharData::setAlias</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>