cvs: phpdoc /en/reference/phar/Phar delete.xml offsetUnset.xml unlinkArchive.xml

From: Date: Sat, 03 May 2008 02:04:28 +0000
Subject: cvs: phpdoc /en/reference/phar/Phar delete.xml offsetUnset.xml unlinkArchive.xml
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-1588@lists.php.net to get a copy of this message
cellog Sat May 3 02:04:28 2008 UTC Added files: /phpdoc/en/reference/phar/Phar unlinkArchive.xml Modified files: /phpdoc/en/reference/phar/Phar delete.xml offsetUnset.xml Log: document Phar::unlinkArchive http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/phar/Phar/delete.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/phar/Phar/delete.xml diff -u phpdoc/en/reference/phar/Phar/delete.xml:1.1 phpdoc/en/reference/phar/Phar/delete.xml:1.2 --- phpdoc/en/reference/phar/Phar/delete.xml:1.1 Fri May 2 04:36:22 2008 +++ phpdoc/en/reference/phar/Phar/delete.xml Sat May 3 02:04:28 2008 @@ -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 @@ <para> <simplelist> <member><function>PharData::delete</function></member> + <member><function>Phar::unlinkArchive</function></member> </simplelist> </para> </refsect1> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/phar/Phar/offsetUnset.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/phar/Phar/offsetUnset.xml diff -u phpdoc/en/reference/phar/Phar/offsetUnset.xml:1.2 phpdoc/en/reference/phar/Phar/offsetUnset.xml:1.3 --- phpdoc/en/reference/phar/Phar/offsetUnset.xml:1.2 Mon Jan 21 21:54:18 2008 +++ phpdoc/en/reference/phar/Phar/offsetUnset.xml Sat May 3 02:04:28 2008 @@ -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 @@ <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> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/phar/Phar/unlinkArchive.xml?view=markup&rev=1.1 Index: phpdoc/en/reference/phar/Phar/unlinkArchive.xml +++ phpdoc/en/reference/phar/Phar/unlinkArchive.xml <?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 -->

« previous php.doc.cvs (#1588) next »