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

148 lines
4.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 28046efaba656e158bdf45a2585c23a339943869 Maintainer: gui Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phardata.addfile" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>PharData::addFile</refname>
<refpurpose>Ajoute un fichier du système de fichiers à l'archive tar/zip</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>void</type><methodname>PharData::addFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>string</type><type>null</type></type><parameter>localName</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Avec cette méthode, n'importe quel fichier ou URL peut être ajouté à l'archive tar/zip. Si
le second paramètre optionnel <literal>localname</literal> est spécifié,
le fichier sera stocké dans l'archive avec ce nom, sans quoi le paramètre
<literal>file</literal> est utilisé comme chemin vers lequel stocker le fichier au sein de
l'archive. Les URL doivent avoir un nom local sans quoi une exception est levée.
Cette méthode est identique à <function>ZipArchive::addFile</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
Chemin relatif ou absolu vers un fichier du disque à ajouter
à l'archive phar.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>localName</parameter></term>
<listitem>
<para>
Chemin vers lequel le fichier sera stocké au sein de l'archive.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
aucune valeur de retour, une exception est levée en cas d'échec.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>localName</parameter> est désormais nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Un exemple avec <function>PharData::addFile</function></title>
<programlisting role="php">
<![CDATA[
<?php
try {
$a = new PharData('/chemin/vers/mon.tar');
$a->addFile('/chemin/complet/vers/fichier');
// montre comment le fichier est stocké
$b = $a['chemin/complet/vers/fichier']->getContent();
$a->addFile('/chemin/complet/vers/fichier', 'mon/fichier.txt');
$c = $a['mon/fichier.txt']->getContent();
// montre l'utilisation des URLs
$a->addFile('http://www.exemple.com', 'exemple.html');
} catch (Exception $e) {
// les erreurs sont traitées ici
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&phardata.note.performance;
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>PharData::offsetSet</function></member>
<member><function>Phar::addFile</function></member>
<member><function>PharData::addFromString</function></member>
<member><function>PharData::addEmptyDir</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
-->