Files
doc-fr/reference/phar/Phar/delete.xml
George Peter Banyard ede1b06016 Sync Phar docs with EN
2021-09-07 17:20:29 +01:00

113 lines
2.8 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 28046efaba656e158bdf45a2585c23a339943869 Maintainer: gui Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Phar::delete</refname>
<refpurpose>Efface un fichier au sein d'une archive phar</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>Phar::delete</methodname>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
</methodsynopsis>
&phar.write;
<para>
Efface une fichier au sein d'une archive phar. C'est l'équivalent fonctionnel de l'appel
à <function>unlink</function> dans un contexte de flux, comme décrit dans l'exemple suivant...
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
Chemin du fichier à effacer au sein de l'archive.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
retourne &true; en cas de succès, mais il est plus sûr de vérifier si des exceptions sont levées,
et de considérer que tout s'est bien passé si aucune n'est levée.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Lève une exception <classname>PharException</classname> si des erreurs apparaissent pendant
l'écriture sur le disque.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Un exemple avec <function>Phar::delete</function></title>
<programlisting role="php">
<![CDATA[
<?php
try {
$phar = new Phar('monphar.phar');
$phar->delete('efface/moi.php');
// c'est équivalent à :
unlink('phar://monphar.phar/efface/moi.php');
} catch (Exception $e) {
// traite les erreurs
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PharData::delete</function></member>
<member><function>Phar::unlinkArchive</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
-->