From 93b337cdf49457f2eaaa0feac10bd70b69ffb34e Mon Sep 17 00:00:00 2001 From: Greg Beaver 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 @@ - + Phar::delete @@ -82,6 +82,7 @@ try { PharData::delete + Phar::unlinkArchive 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 @@ - + Phar::offsetUnset @@ -87,6 +87,8 @@ try { Phar::offsetExists Phar::offsetGet Phar::offsetSet + Phar::unlinkArchive + Phar::delete 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 @@ + + + + + Phar::unlinkArchive + Completely remove a phar archive from disk and from memory + + + + &reftitle.description; + + boolPhar::unlinkArchive + stringarchive + + + + + + + &reftitle.parameters; + + + + archive + + + The path on disk to the phar archive. + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the archive is successfully removed from disk. + + + + + &reftitle.errors; + + PharException is thrown if there are any open file pointers to + the phar archive, or any existing Phar, PharData, + or PharFileInfo objects referring to the phar archive. + + + + + &reftitle.examples; + + + A <function>Phar::unlinkArchive</function> example + +compress(Phar::GZ); +// remove all references to the archive +unset($p); +fclose($fp); +// now remove all traces of the archive +Phar::unlinkArchive('my.phar'); +?> +]]> + + + + + + + &reftitle.seealso; + + + Phar::delete + Phar::offsetUnset + + + + + + +