php-doc-en/reference/phar/Phar/offsetUnset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="phar.offsetunset" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>Phar::offsetUnset</refname>
  <refpurpose>Remove a file from a phar</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>void</type><methodname>Phar::offsetUnset</methodname>
   <methodparam><type>string</type><parameter>localName</parameter></methodparam>
  </methodsynopsis>
  &phar.write;


  <para>
   This is an implementation of the <interfacename>ArrayAccess</interfacename> interface allowing
   direct manipulation of the contents of a Phar archive using
   array access brackets.  offsetUnset is used for deleting an
   existing file, and is called by the <function>unset</function>
   language construct.
  </para>

 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>localName</parameter></term>
     <listitem>
      <para>
       The filename (relative path) to modify in a Phar.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   if <link linkend="ini.phar.readonly">phar.readonly</link> is <literal>1</literal>,
   <classname>BadMethodCallException</classname> is thrown, as modifying a Phar
   is only allowed when phar.readonly is set to <literal>0</literal>. Throws
   <classname>PharException</classname> if there are any problems flushing
   changes made to the Phar archive to disk.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>A <function>Phar::offsetUnset</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php
$p = new Phar('/path/to/my.phar', 0, 'my.phar');
try {
    // deletes file.txt from my.phar by calling offsetUnset
    unset($p['file.txt']);
} catch (Exception $e) {
    echo 'Could not delete file.txt: ', $e;
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Phar::offsetExists</function></member>
    <member><function>Phar::offsetGet</function></member>
    <member><function>Phar::offsetSet</function></member>
    <member><function>Phar::unlinkArchive</function></member>
    <member><function>Phar::delete</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->