From 93b337cdf49457f2eaaa0feac10bd70b69ffb34e Mon Sep 17 00:00:00 2001
From: Greg Beaver <cellog@php.net>
Date: Sat, 3 May 2008 02:04:28 +0000
Subject: [PATCH] document Phar::unlinkArchive

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@258948 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/phar/Phar/delete.xml        |   3 +-
 reference/phar/Phar/offsetUnset.xml   |   4 +-
 reference/phar/Phar/unlinkArchive.xml | 111 ++++++++++++++++++++++++++
 3 files changed, 116 insertions(+), 2 deletions(-)
 create mode 100644 reference/phar/Phar/unlinkArchive.xml

diff --git a/reference/phar/Phar/delete.xml b/reference/phar/Phar/delete.xml
index ae2003928f..1e68913d08 100644
--- a/reference/phar/Phar/delete.xml
+++ b/reference/phar/Phar/delete.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
 <refentry xml:id="phar.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <refnamediv>
   <refname>Phar::delete</refname>
@@ -82,6 +82,7 @@ try {
   <para>
    <simplelist>
     <member><function>PharData::delete</function></member>
+    <member><function>Phar::unlinkArchive</function></member>
    </simplelist>
   </para>
  </refsect1>
diff --git a/reference/phar/Phar/offsetUnset.xml b/reference/phar/Phar/offsetUnset.xml
index 1c27bce39e..8c88187e1a 100644
--- a/reference/phar/Phar/offsetUnset.xml
+++ b/reference/phar/Phar/offsetUnset.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="phar.offsetunset">
  <refnamediv>
   <refname>Phar::offsetUnset</refname>
@@ -87,6 +87,8 @@ try {
     <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>
diff --git a/reference/phar/Phar/unlinkArchive.xml b/reference/phar/Phar/unlinkArchive.xml
new file mode 100644
index 0000000000..9626c7c83f
--- /dev/null
+++ b/reference/phar/Phar/unlinkArchive.xml
@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+<refentry xml:id="phar.unlinkarchive" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>Phar::unlinkArchive</refname>
+  <refpurpose>Completely remove a phar archive from disk and from memory</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>Phar::unlinkArchive</methodname>
+   <methodparam><type>string</type><parameter>archive</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>archive</parameter></term>
+     <listitem>
+      <para>
+       The path on disk to the phar archive.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns &true; if the archive is successfully removed from disk.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   <classname>PharException</classname> is thrown if there are any open file pointers to
+   the phar archive, or any existing <classname>Phar</classname>, <classname>PharData</classname>,
+   or <classname>PharFileInfo</classname> objects referring to the phar archive.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>A <function>Phar::unlinkArchive</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+// simple usage
+Phar::unlinkArchive('/path/to/my.phar');
+
+// more common example:
+$p = new Phar('my.phar');
+$fp = fopen('phar://my.phar/file.txt', 'r');
+// this creates 'my.phar.gz'
+$gp = $p->compress(Phar::GZ);
+// remove all references to the archive
+unset($p);
+fclose($fp);
+// now remove all traces of the archive
+Phar::unlinkArchive('my.phar');
+?>
+]]>
+    </programlisting>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>Phar::delete</function></member>
+    <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:"../../../../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
+-->