offsetUnset.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: f03806fcd8fe03a0501bd40b6e3939ff6589a1d2 Maintainer: takagi Status: ready -->
<refentry xml:id="phardata.offsetunset" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>PharData::offsetUnset</refname>
  <refpurpose>ファイルを tar/zip アーカイブから削除する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="PharData">
   <modifier>public</modifier> <type>void</type><methodname>PharData::offsetUnset</methodname>
   <methodparam><type>string</type><parameter>localName</parameter></methodparam>
  </methodsynopsis>


  <para>
   これは <interfacename>ArrayAccess</interfacename> インターフェイスを実装したものです。
   これにより、Phar アーカイブの内容に対して配列形式の角括弧を使用したアクセスが可能となります。
   offsetUnset を使用して、既存のファイルを削除します。また
   <function>unset</function> が使用された場合にもコールされます。
  </para>

 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>localName</parameter></term>
     <listitem>
      <para>
       tar/zip アーカイブ内で変更するファイル名 (相対パス)。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   tar/zip アーカイブへの変更をディスクに書き込む際に何らかのエラーが発生すると
   <classname>PharException</classname> をスローします。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>PharData::offsetUnset</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php
$p = new PharData('/path/to/my.zip');
try {
    // offsetUnset がコールされ、file.txt が my.zip から削除されます
    unset($p['file.txt']);
} catch (Exception $e) {
    echo 'file.txt を削除できません: ', $e;
}
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>Phar::offsetUnset</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
-->