Files
doc-fr/reference/phar/PharData/delete.xml
George Peter Banyard 1b2cc82a3c Sync PharData with EN
2021-09-06 22:13:52 +01:00

111 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="phardata.delete" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>PharData::delete</refname>
<refpurpose>Efface un fichier au sein de l'archive tar/zip</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>PharData::delete</methodname>
<methodparam><type>string</type><parameter>localName</parameter></methodparam>
</methodsynopsis>
<para>
Efface un fichier au sein de l'archive. C'est l'équivalent fonctionnel de
l'appel à <function>unlink</function> à l'aide du gestionnaire de flux phar,
comme montré dans l'exemple ci-dessous.
</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 préférable de vérifier les exception soulevées
et de considérer le succès si aucune ne l'est.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Soulève une exception <classname>PharException</classname> si des erreurs sont rencontrés lors
de l'écriture des changements sur le disque.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Un exemple avec <function>PharData::delete</function></title>
<programlisting role="php">
<![CDATA[
<?php
try {
$phar = new PharData('monphar.zip');
$phar->delete('efface/moi.php');
// c'est l'équivalent de :
unlink('phar://monphar.phar/efface/mon.php');
} catch (Exception $e) {
// on traite les erreurs
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::delete</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
-->