Files
doc-fr/reference/phar/Phar/buildFromDirectory.xml
2021-12-27 12:45:04 +00:00

153 lines
4.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: ed66a8608b9b7e9e6b880226e7265a0ef69f816d Maintainer: gui Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="phar.buildfromdirectory" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Phar::buildFromDirectory</refname>
<refpurpose>Construit une archive phar à partir des fichiers d'un répertoire</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>array</type><methodname>Phar::buildFromDirectory</methodname>
<methodparam><type>string</type><parameter>directory</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>pattern</parameter><initializer>""</initializer></methodparam>
</methodsynopsis>
&phar.write;
<para>
Remplit une archive phar à partir du contenu d'un répertoire. Le second paramètre,
optionnel, est une expression rationnelle (pcre) utilisée pour exclure des fichiers.
Tout fichier dont le nom satisfait l'expression rationnelle sera inclus, les autres seront exclus.
Pour un contrôle plus fin, utilisez <function>Phar::buildFromIterator</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>directory</parameter></term>
<listitem>
<para>
Le chemin absolu ou relatif vers le répertoire contenant tous les fichiers
à ajouter à l'archive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
Une expression rationnelle optionnelle utilisée pour filtrer la liste
des fichiers. Seuls les fichiers dont le nom satisfait l'expression rationnelle
seront inclus dans l'archive.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
<function>Phar::buildFromDirectory</function> retourne un tableau associatif
faisant correspondre le chemin interne du fichier avec le chemin complet sur le système
de fichiers.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Cette méthode lève une exception <classname>BadMethodCallException</classname> quand elle est
incapable d'instancier l'itérateur de répertoire interne,
ou une exception <classname>PharException</classname> s'il y a eu des erreurs lors
de la sauvegarde de l'archive.
</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.1.0</entry>
<entry>
<methodname>Phar::buildFromDirectory</methodname> ne retourne plus &false;.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Un exemple avec<function>Phar::buildFromDirectory</function></title>
<para>
</para>
<para>
<programlisting role="php">
<![CDATA[
<?php
// crée avec l'alias "projet.phar"
$phar = new Phar('projet.phar', 0, 'projet.phar');
// ajoute des fichiers dans le projet
$phar->buildFromDirectory(dirname(__FILE__) . '/projet');
$phar->setStub($phar->createDefaultWebStub('cli/index.php', 'www/index.php'));
$phar2 = new Phar('projet2.phar', 0, 'projet2.phar');
// ajoute tous les fichiers dans le projet, mais juste les fichiers .php
$phar->buildFromDirectory(dirname(__FILE__) . '/projet', '/\.php$/');
$phar->setStub($phar->createDefaultStub('cli/index.php', 'www/index.php'));
?>
]]>
</programlisting>
</para>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>Phar::buildFromIterator</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
-->