cvs: peardoc /fr/packages/file archive-tar.xml
| From: | Vincent Blavet | Date: | Thu, 09 May 2002 13:39:01 +0000 |
| Subject: | cvs: peardoc /fr/packages/file archive-tar.xml | ||
| Groups: | php.pear.cvs | ||
| Request: | Send a blank email to pear-cvs+get-3729@lists.php.net to get a copy of this message | ||
vblavet Thu May 9 09:39:01 2002 EDT
Modified files:
/peardoc/fr/packages/file archive-tar.xml
Log:
* Adding examples to explain the support of windows path format
Index: peardoc/fr/packages/file/archive-tar.xml diff -u peardoc/fr/packages/file/archive-tar.xml:1.1 peardoc/fr/packages/file/archive-tar.xml:1.2 --- peardoc/fr/packages/file/archive-tar.xml:1.1 Sun Feb 17 17:32:56 2002 +++ peardoc/fr/packages/file/archive-tar.xml Thu May 9 09:39:01 2002 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="packages.file.archive-tar"> <refnamediv> <refname>Archive_Tar</refname> <refpurpose>Gestion des archives au format GNU Tar</refpurpose> </refnamediv> <refsect1 id="packages.file.archive-tar.tar"> - <title>Archive_Tar::Archive_Tar()</title> + <title>Archive_Tar::Archive_Tar()</title> <funcsynopsis> <funcprototype> <funcdef>void <function>Archive_Tar</function></funcdef> <paramdef>string <parameter>$tarname</parameter></paramdef> <paramdef>boolean - <parameter><optional>$compress</optional></parameter></paramdef> + <parameter><optional>$compress</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Le constructeur déclare un nouvel objet <classname>Archive_Tar</classname>, - en l'identifiant par le nom de l'archive. + Le constructeur déclare un nouvel objet <classname>Archive_Tar</classname>, + en l'identifiant par le nom de l'archive. </para> <para> Parameter @@ -29,17 +29,17 @@ </listitem> <listitem> <para> - <parameter>$compress</parameter> - si <parameter>true</parameter>, indique que l'archive - est compressée (gzip). + <parameter>$compress</parameter> - si <parameter>true</parameter>, indique que l'archive + est compressée (gzip). Par défaut <parameter>false</parameter>. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> </refsect1> <refsect1 id="packages.file.archive-tar.create"> - <title>Archive_Tar::create()</title> + <title>Archive_Tar::create()</title> <funcsynopsis> <funcprototype> <funcdef>void <function>create</function></funcdef> @@ -47,19 +47,19 @@ </funcprototype> </funcsynopsis> <para> - Cette méthode créé le fichier archive et ajoute tous les fichiers et dossiers listés + Cette méthode créé le fichier archive et ajoute tous les fichiers et dossiers listés dans <parameter>filelist</parameter>. - Si un fichier, avec le même nom que celui de l'archive, existe et est accessible en écriture + Si un fichier, avec le même nom que celui de l'archive, existe et est accessible en écriture il est remplacé par la nouvelle archive (c'est un 'créer' pas un 'ajouter'). Si le fichier existe et est protégé en écriture ou s'il s'agit d'un dossier, la méthode retourne <parameter>false</parameter> - et un texte + et un texte d'erreur PEAR. </para> <para> <parameter>filelist</parameter> peut être un tableau de chaines de caractères contenant le nom d'un fichier ou d'un dossier (avec leurs chemin d'accès si nécessaire). Cela peut aussi être une simple chaine avec les noms séparés par un espace. Pour chaque dossier ajouter dans l'archive, - les fichiers et les sous-dossiers de ce dossier sont aussi ajoutés. + les fichiers et les sous-dossiers de ce dossier sont aussi ajoutés. </para> <para> Parameter @@ -70,18 +70,18 @@ simple chaine de caractères avec les noms séparés par un espace. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> @@ -95,7 +95,7 @@ $v_list[2]="file.log"; $tar_object->create($v_list); ]]> - </programlisting> + </programlisting> </example> <para> Dans cet exemple une archive GNU Tar non compressée est créée. Les fichiers 'file.txt' et @@ -109,7 +109,7 @@ $tar_object->setErrorHandling(PEAR_ERROR_PRINT); // Optional error handling $tar_object->create("file.txt data/ file.log"); ]]> - </programlisting> + </programlisting> </example> <para> Dans cet exemple une archive GNU Tar compressée est créée. Les mêmes fichiers et dossier @@ -118,7 +118,7 @@ </refsect1> <refsect1 id="packages.file.archive-tar.add"> - <title>Archive_Tar::add()</title> + <title>Archive_Tar::add()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>add</function></funcdef> @@ -142,18 +142,18 @@ simple chaine de caractères avec les noms séparés par un espace. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>add()</title> @@ -165,12 +165,12 @@ $v_list[2]="log/file.log"; $tar_object->add($v_list); ]]> - </programlisting> + </programlisting> </example> </refsect1> <refsect1 id="packages.file.archive-tar.extract"> - <title>Archive_Tar::extract()</title> + <title>Archive_Tar::extract()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>extract</function></funcdef> @@ -205,18 +205,18 @@ <parameter>$path</parameter> - le dossier où extraire l'archive. Par deafut le dossier courant. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>extract()</title> @@ -225,12 +225,12 @@ $tar = new Archive_Tar('archive.tgz', true); $result = $tar->extract('destination_folder'); ]]> - </programlisting> + </programlisting> </example> </refsect1> <refsect1 id="packages.file.archive-tar.listcontent"> - <title>Archive_Tar::listContent()</title> + <title>Archive_Tar::listContent()</title> <funcsynopsis> <funcprototype> <funcdef>array <function>listContent</function></funcdef> @@ -283,17 +283,17 @@ $file[typeflag] : "" pour un fichier, "5" pour un dossier </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>array</parameter> - Un tableau contenant les propriétés des fichiers ou dossiers contenus dans l'archive. + <parameter>array</parameter> - Un tableau contenant les propriétés des fichiers ou dossiers contenus dans l'archive. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>listContent()</title> @@ -312,26 +312,26 @@ echo " .typeflag :'".$v_list[$i][typeflag]."'<br>"; } ]]> - </programlisting> + </programlisting> </example> - </refsect1> - + </refsect1> + <refsect1 id="packages.file.archive-tar.addmodify"> - <title>Archive_Tar::addModify()</title> + <title>Archive_Tar::addModify()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>addModify</function></funcdef> <paramdef>array <parameter>$filelist</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$add_dir</parameter></paramdef> - <paramdef>string - <parameter><optional>$remove_dir</optional></parameter></paramdef> + <paramdef>string + <parameter><optional>$remove_dir</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> Cette méthode ajoute à la fin d'une archive les fichiers ou dossiers indiqués dans <parameter> - filelist</parameter>. + filelist</parameter>. </para> <para> Si l'archive n'existe pas déjà elle est créée. @@ -339,7 +339,7 @@ ajouté à la fin de l'archive. Il ne s'agit pas d'une mise à jour mais d'un ajout simple. Cela peut donc entrainer une non optimisation de l'archive. Si un fichier ou un dossier passé en paramètre n'existe pas, il est ignoré. - Si le nom du fichier ou du dossier (après l'ajout/retrait eventuel d'un chemin) est + Si le nom du fichier ou du dossier (après l'ajout/retrait eventuel d'un chemin) est supérieur à 99, il est ignoré. </para> <para> @@ -353,8 +353,8 @@ L'ajout d'un chemin n'est effectué qu'après la suppression optionnelle précedente. </para> <para> - La capacité de modifier le chemin mémorisé par rapport au chemin réel du fichier, - permet de préparer une archive pour une extraction dans un dossier particulier différent + La capacité de modifier le chemin mémorisé par rapport au chemin réel du fichier, + permet de préparer une archive pour une extraction dans un dossier particulier différent de celui d'origine </para> <para> @@ -368,28 +368,28 @@ </listitem> <listitem> <para> - <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque + <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque fichier ou dossier. - </para> + </para> </listitem> <listitem> <para> <parameter>$remove_dir</parameter> - un chemin qui sera retiré, lorsque cela est possible, au chemin mémorisé de chaque fichier ou dossier. Par défaut une chaine vide. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>addModify()</title> @@ -397,7 +397,7 @@ <![CDATA[ $tar_object = new Archive_Tar("tarname.tar"); $v_list[0]="dev/file.txt"; -$v_list[1]="dev/data/"; +$v_list[1]="dev/data/"; $v_list[2]="log/file.log"; $tar_object->addModify($v_list, "install"); // files are stored in the archive as : @@ -407,7 +407,7 @@ // install/data/... all the files and sub-dirs of data/ // install/file.log ]]> - </programlisting> + </programlisting> </example> <example> <title>addModify()</title> @@ -415,7 +415,7 @@ <![CDATA[ $tar_object = new Archive_Tar("tarname.tar"); $v_list[0]="dev/file.txt"; -$v_list[1]="dev/data/"; +$v_list[1]="dev/data/"; $v_list[2]="log/file.log"; $tar_object->addModify($v_list, "install", "dev"); // files are stored in the archive as : @@ -425,30 +425,55 @@ // install/data/... all the files and sub-dirs of data/ // install/log/file.log ]]> - </programlisting> + </programlisting> + </example> + <example> + <title>addModify()</title> + <programlisting role="php"> + <![CDATA[ +$tar_object = new Archive_Tar("tarname.tar"); +$v_list[0]="d:\dev\file.txt"; +$v_list[1]="d:\dev\data\"; +$v_list[2]="d:\log\file.log"; +$tar_object->addModify($v_list, "install/temp", "d:\dev"); +// files are stored in the archive as : +// install/temp/file.txt +// install/temp/data +// install/temp/data/file1.txt +// install/temp/data/... all the files and sub-dirs of data/ +// install/temp/log/file.log + ]]> + </programlisting> </example> + <para> + Sous un OS windows, les chemins de dossier au format windows ('c:\path\dir') + sont supportés. Cependant si vous utilisez le format wondows pour les fichiers + vous devez utiliser aussi ce format pour le paramètre $remove_dir. + Le paramètre $add_dir peut utiliser les deux formats. + </para> + </refsect1> </refsect1> <refsect1 id="packages.file.archive-tar.createmodify"> - <title>Archive_Tar::createModify()</title> + <title>Archive_Tar::createModify()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>createModify</function></funcdef> <paramdef>array <parameter>$filelist</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$add_dir</parameter></paramdef> - <paramdef>string - <parameter><optional>$remove_dir</optional></parameter></paramdef> + <paramdef>string + <parameter><optional>$remove_dir</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Cette méthode créé une archive GNU Tar composée des fichiers ou dossiers indiqués + Cette méthode créé une archive GNU Tar composée des fichiers ou dossiers indiqués dans <parameter>filelist</parameter>. Elle permet de plus de manipuler les chemins mémorisés. </para> <para> Si un fichier existe avec le même nom et est accessible en écriture il est remplacé par la - nouvelle archive. Il s'agit bien d'une création et non d'un ajout. Les propriétés d'ajout et - de suppression de chemin, permet de préparer une archive pour son extraction dans un dossier particulier, différent + nouvelle archive. Il s'agit bien d'une création et non d'un ajout. Les propriétés d'ajout et + de suppression de chemin, permet de préparer une archive pour son extraction dans un dossier particulier, différent de celui d'origine. Pour plus de détails voir Archive_Tar::addModify(). </para> <para> @@ -462,37 +487,37 @@ </listitem> <listitem> <para> - <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque + <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque fichier ou dossier. - </para> + </para> </listitem> <listitem> <para> <parameter>$remove_dir</parameter> - un chemin qui sera retiré, lorsque cela est possible, au chemin mémorisé de chaque fichier ou dossier. Par défaut une chaine vide. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>createModify()</title> <programlisting role="php"> <![CDATA[ $tar_object = new Archive_Tar("tarname.tgz", true); -$tar_object->setErrorHandling(PEAR_ERROR_PRINT); +$tar_object->setErrorHandling(PEAR_ERROR_PRINT); $v_list[0]="dev/file.txt"; -$v_list[1]="dev/data/"; +$v_list[1]="dev/data/"; $v_list[2]="log/file.log"; $tar_object->createModify($v_list, "install", "dev"); // files are stored in the archive as : @@ -502,24 +527,43 @@ // install/data/... all the files and sub-dirs of data/ // install/log/file.log ]]> - </programlisting> + </programlisting> + </example> + <example> + <title>createModify()</title> + <programlisting role="php"> + <![CDATA[ +$tar_object = new Archive_Tar("tarname.tgz", true); +$tar_object->setErrorHandling(PEAR_ERROR_PRINT); +$v_list[0]="c:\dev\file.txt"; +$v_list[1]="c:\dev\data\"; +$v_list[2]="c:\log\file.log"; +$tar_object->createModify($v_list, "install/temp", "c:\dev"); +// files are stored in the archive as : +// install/temp/file.txt +// install/temp/data +// install/temp/data/file1.txt +// install/temp/data/... all the files and sub-dirs of data/ +// install/temp/log/file.log + ]]> + </programlisting> </example> </refsect1> <refsect1 id="packages.file.archive-tar.extractmodify"> - <title>Archive_Tar::extractModify()</title> + <title>Archive_Tar::extractModify()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>extractModify</function></funcdef> <paramdef>string <parameter>$path</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$remove_path</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Cette méthode extrait tous les fichiers de l'archive dans le dossier + Cette méthode extrait tous les fichiers de l'archive dans le dossier <parameter>path</parameter>. Lorsque cela est possible, le chemin mémorisé dans l'archive - est modifié de façon à y retirer le chemin <parameter>remove_path</parameter> se trouvant + est modifié de façon à y retirer le chemin <parameter>remove_path</parameter> se trouvant au debut du chemin du fichier ou du dossier. </para> <para> @@ -543,28 +587,28 @@ <itemizedlist> <listitem> <para> - <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les + <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les dossiers archivés seront extrait. </para> </listitem> <listitem> <para> - <parameter>$remove_path</parameter> - partie du chemin mémorisé des fichiers ou dossiers + <parameter>$remove_path</parameter> - partie du chemin mémorisé des fichiers ou dossiers qui sera retiré avant l'extraction si cela est possible. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>extractModify()</title> @@ -583,25 +627,50 @@ // install/data/log.txt // install/readme.txt ]]> - </programlisting> + </programlisting> </example> + <example> + <title>extractModify()</title> + <programlisting role="php"> + <![CDATA[ +// tarname.tar with files : +// dev/data/file.txt +// dev/data/log.txt +// readme.txt + +$tar_object = new Archive_Tar("tarname.tar"); +$tar_object->extractModify("d:\install\temp", "dev"); + +// Files will be extracted there : +// d:\install\temp\data\file.txt +// d:\install\temp\data\log.txt +// d:\install\temp\readme.txt + ]]> + </programlisting> + </example> + <para> + Sous un OS windows, le chemin de dossier au format windows ('d:\path\dir') + peut être utilisé pour le paramètre $add_dir. Il ne doit pas être utilsé + pour le paramètre $remove_dir qui doit correspondre au format mémorisé dans + l'archive. + </para> </refsect1> <refsect1 id="packages.file.archive-tar.extractlist"> - <title>Archive_Tar::extractList()</title> + <title>Archive_Tar::extractList()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>extractList</function></funcdef> <paramdef>array <parameter>$filelist</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$path</parameter></paramdef> - <paramdef>string - <parameter><optional>$remove_path</optional></parameter></paramdef> + <paramdef>string + <parameter><optional>$remove_path</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> Cette méthode extrait de l'archive uniquement les fichiers indiqués dans - <parameter>filelist</parameter>. Ces fichiers ou dossiers sont extraits dans le dossier + <parameter>filelist</parameter>. Ces fichiers ou dossiers sont extraits dans le dossier courant ou dans le dossier indiqué par le paramètre optionnel <parameter>path</parameter>. </para> <para> @@ -615,7 +684,7 @@ </listitem> <listitem> <para> - <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les + <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les dossiers archivés seront extrait. </para> </listitem> @@ -623,20 +692,20 @@ <para> <parameter>$remove_path</parameter> - partie du chemin mémorisé des fichiers ou dossiers qui sera retiré avant l'extraction si cela est possible. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>extractList()</title> @@ -655,11 +724,11 @@ // install/data/file.txt // install/readme.txt ]]> - </programlisting> + </programlisting> </example> </refsect1> - - </refentry> + + </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -678,4 +747,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +--> \ No newline at end of file
Index: peardoc/fr/packages/file/archive-tar.xml diff -u peardoc/fr/packages/file/archive-tar.xml:1.1 peardoc/fr/packages/file/archive-tar.xml:1.2 --- peardoc/fr/packages/file/archive-tar.xml:1.1 Sun Feb 17 17:32:56 2002 +++ peardoc/fr/packages/file/archive-tar.xml Thu May 9 09:39:01 2002 @@ -1,23 +1,23 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="packages.file.archive-tar"> <refnamediv> <refname>Archive_Tar</refname> <refpurpose>Gestion des archives au format GNU Tar</refpurpose> </refnamediv> <refsect1 id="packages.file.archive-tar.tar"> - <title>Archive_Tar::Archive_Tar()</title> + <title>Archive_Tar::Archive_Tar()</title> <funcsynopsis> <funcprototype> <funcdef>void <function>Archive_Tar</function></funcdef> <paramdef>string <parameter>$tarname</parameter></paramdef> <paramdef>boolean - <parameter><optional>$compress</optional></parameter></paramdef> + <parameter><optional>$compress</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Le constructeur déclare un nouvel objet <classname>Archive_Tar</classname>, - en l'identifiant par le nom de l'archive. + Le constructeur déclare un nouvel objet <classname>Archive_Tar</classname>, + en l'identifiant par le nom de l'archive. </para> <para> Parameter @@ -29,17 +29,17 @@ </listitem> <listitem> <para> - <parameter>$compress</parameter> - si <parameter>true</parameter>, indique que l'archive - est compressée (gzip). + <parameter>$compress</parameter> - si <parameter>true</parameter>, indique que l'archive + est compressée (gzip). Par défaut <parameter>false</parameter>. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> </refsect1> <refsect1 id="packages.file.archive-tar.create"> - <title>Archive_Tar::create()</title> + <title>Archive_Tar::create()</title> <funcsynopsis> <funcprototype> <funcdef>void <function>create</function></funcdef> @@ -47,19 +47,19 @@ </funcprototype> </funcsynopsis> <para> - Cette méthode créé le fichier archive et ajoute tous les fichiers et dossiers listés + Cette méthode créé le fichier archive et ajoute tous les fichiers et dossiers listés dans <parameter>filelist</parameter>. - Si un fichier, avec le même nom que celui de l'archive, existe et est accessible en écriture + Si un fichier, avec le même nom que celui de l'archive, existe et est accessible en écriture il est remplacé par la nouvelle archive (c'est un 'créer' pas un 'ajouter'). Si le fichier existe et est protégé en écriture ou s'il s'agit d'un dossier, la méthode retourne <parameter>false</parameter> - et un texte + et un texte d'erreur PEAR. </para> <para> <parameter>filelist</parameter> peut être un tableau de chaines de caractères contenant le nom d'un fichier ou d'un dossier (avec leurs chemin d'accès si nécessaire). Cela peut aussi être une simple chaine avec les noms séparés par un espace. Pour chaque dossier ajouter dans l'archive, - les fichiers et les sous-dossiers de ce dossier sont aussi ajoutés. + les fichiers et les sous-dossiers de ce dossier sont aussi ajoutés. </para> <para> Parameter @@ -70,18 +70,18 @@ simple chaine de caractères avec les noms séparés par un espace. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> @@ -95,7 +95,7 @@ $v_list[2]="file.log"; $tar_object->create($v_list); ]]> - </programlisting> + </programlisting> </example> <para> Dans cet exemple une archive GNU Tar non compressée est créée. Les fichiers 'file.txt' et @@ -109,7 +109,7 @@ $tar_object->setErrorHandling(PEAR_ERROR_PRINT); // Optional error handling $tar_object->create("file.txt data/ file.log"); ]]> - </programlisting> + </programlisting> </example> <para> Dans cet exemple une archive GNU Tar compressée est créée. Les mêmes fichiers et dossier @@ -118,7 +118,7 @@ </refsect1> <refsect1 id="packages.file.archive-tar.add"> - <title>Archive_Tar::add()</title> + <title>Archive_Tar::add()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>add</function></funcdef> @@ -142,18 +142,18 @@ simple chaine de caractères avec les noms séparés par un espace. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>add()</title> @@ -165,12 +165,12 @@ $v_list[2]="log/file.log"; $tar_object->add($v_list); ]]> - </programlisting> + </programlisting> </example> </refsect1> <refsect1 id="packages.file.archive-tar.extract"> - <title>Archive_Tar::extract()</title> + <title>Archive_Tar::extract()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>extract</function></funcdef> @@ -205,18 +205,18 @@ <parameter>$path</parameter> - le dossier où extraire l'archive. Par deafut le dossier courant. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>extract()</title> @@ -225,12 +225,12 @@ $tar = new Archive_Tar('archive.tgz', true); $result = $tar->extract('destination_folder'); ]]> - </programlisting> + </programlisting> </example> </refsect1> <refsect1 id="packages.file.archive-tar.listcontent"> - <title>Archive_Tar::listContent()</title> + <title>Archive_Tar::listContent()</title> <funcsynopsis> <funcprototype> <funcdef>array <function>listContent</function></funcdef> @@ -283,17 +283,17 @@ $file[typeflag] : "" pour un fichier, "5" pour un dossier </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>array</parameter> - Un tableau contenant les propriétés des fichiers ou dossiers contenus dans l'archive. + <parameter>array</parameter> - Un tableau contenant les propriétés des fichiers ou dossiers contenus dans l'archive. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>listContent()</title> @@ -312,26 +312,26 @@ echo " .typeflag :'".$v_list[$i][typeflag]."'<br>"; } ]]> - </programlisting> + </programlisting> </example> - </refsect1> - + </refsect1> + <refsect1 id="packages.file.archive-tar.addmodify"> - <title>Archive_Tar::addModify()</title> + <title>Archive_Tar::addModify()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>addModify</function></funcdef> <paramdef>array <parameter>$filelist</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$add_dir</parameter></paramdef> - <paramdef>string - <parameter><optional>$remove_dir</optional></parameter></paramdef> + <paramdef>string + <parameter><optional>$remove_dir</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> Cette méthode ajoute à la fin d'une archive les fichiers ou dossiers indiqués dans <parameter> - filelist</parameter>. + filelist</parameter>. </para> <para> Si l'archive n'existe pas déjà elle est créée. @@ -339,7 +339,7 @@ ajouté à la fin de l'archive. Il ne s'agit pas d'une mise à jour mais d'un ajout simple. Cela peut donc entrainer une non optimisation de l'archive. Si un fichier ou un dossier passé en paramètre n'existe pas, il est ignoré. - Si le nom du fichier ou du dossier (après l'ajout/retrait eventuel d'un chemin) est + Si le nom du fichier ou du dossier (après l'ajout/retrait eventuel d'un chemin) est supérieur à 99, il est ignoré. </para> <para> @@ -353,8 +353,8 @@ L'ajout d'un chemin n'est effectué qu'après la suppression optionnelle précedente. </para> <para> - La capacité de modifier le chemin mémorisé par rapport au chemin réel du fichier, - permet de préparer une archive pour une extraction dans un dossier particulier différent + La capacité de modifier le chemin mémorisé par rapport au chemin réel du fichier, + permet de préparer une archive pour une extraction dans un dossier particulier différent de celui d'origine </para> <para> @@ -368,28 +368,28 @@ </listitem> <listitem> <para> - <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque + <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque fichier ou dossier. - </para> + </para> </listitem> <listitem> <para> <parameter>$remove_dir</parameter> - un chemin qui sera retiré, lorsque cela est possible, au chemin mémorisé de chaque fichier ou dossier. Par défaut une chaine vide. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>addModify()</title> @@ -397,7 +397,7 @@ <![CDATA[ $tar_object = new Archive_Tar("tarname.tar"); $v_list[0]="dev/file.txt"; -$v_list[1]="dev/data/"; +$v_list[1]="dev/data/"; $v_list[2]="log/file.log"; $tar_object->addModify($v_list, "install"); // files are stored in the archive as : @@ -407,7 +407,7 @@ // install/data/... all the files and sub-dirs of data/ // install/file.log ]]> - </programlisting> + </programlisting> </example> <example> <title>addModify()</title> @@ -415,7 +415,7 @@ <![CDATA[ $tar_object = new Archive_Tar("tarname.tar"); $v_list[0]="dev/file.txt"; -$v_list[1]="dev/data/"; +$v_list[1]="dev/data/"; $v_list[2]="log/file.log"; $tar_object->addModify($v_list, "install", "dev"); // files are stored in the archive as : @@ -425,30 +425,55 @@ // install/data/... all the files and sub-dirs of data/ // install/log/file.log ]]> - </programlisting> + </programlisting> + </example> + <example> + <title>addModify()</title> + <programlisting role="php"> + <![CDATA[ +$tar_object = new Archive_Tar("tarname.tar"); +$v_list[0]="d:\dev\file.txt"; +$v_list[1]="d:\dev\data\"; +$v_list[2]="d:\log\file.log"; +$tar_object->addModify($v_list, "install/temp", "d:\dev"); +// files are stored in the archive as : +// install/temp/file.txt +// install/temp/data +// install/temp/data/file1.txt +// install/temp/data/... all the files and sub-dirs of data/ +// install/temp/log/file.log + ]]> + </programlisting> </example> + <para> + Sous un OS windows, les chemins de dossier au format windows ('c:\path\dir') + sont supportés. Cependant si vous utilisez le format wondows pour les fichiers + vous devez utiliser aussi ce format pour le paramètre $remove_dir. + Le paramètre $add_dir peut utiliser les deux formats. + </para> + </refsect1> </refsect1> <refsect1 id="packages.file.archive-tar.createmodify"> - <title>Archive_Tar::createModify()</title> + <title>Archive_Tar::createModify()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>createModify</function></funcdef> <paramdef>array <parameter>$filelist</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$add_dir</parameter></paramdef> - <paramdef>string - <parameter><optional>$remove_dir</optional></parameter></paramdef> + <paramdef>string + <parameter><optional>$remove_dir</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Cette méthode créé une archive GNU Tar composée des fichiers ou dossiers indiqués + Cette méthode créé une archive GNU Tar composée des fichiers ou dossiers indiqués dans <parameter>filelist</parameter>. Elle permet de plus de manipuler les chemins mémorisés. </para> <para> Si un fichier existe avec le même nom et est accessible en écriture il est remplacé par la - nouvelle archive. Il s'agit bien d'une création et non d'un ajout. Les propriétés d'ajout et - de suppression de chemin, permet de préparer une archive pour son extraction dans un dossier particulier, différent + nouvelle archive. Il s'agit bien d'une création et non d'un ajout. Les propriétés d'ajout et + de suppression de chemin, permet de préparer une archive pour son extraction dans un dossier particulier, différent de celui d'origine. Pour plus de détails voir Archive_Tar::addModify(). </para> <para> @@ -462,37 +487,37 @@ </listitem> <listitem> <para> - <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque + <parameter>$add_dir</parameter> - un chemin qui sera ajouté au chemin mémorisé de chque fichier ou dossier. - </para> + </para> </listitem> <listitem> <para> <parameter>$remove_dir</parameter> - un chemin qui sera retiré, lorsque cela est possible, au chemin mémorisé de chaque fichier ou dossier. Par défaut une chaine vide. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>createModify()</title> <programlisting role="php"> <![CDATA[ $tar_object = new Archive_Tar("tarname.tgz", true); -$tar_object->setErrorHandling(PEAR_ERROR_PRINT); +$tar_object->setErrorHandling(PEAR_ERROR_PRINT); $v_list[0]="dev/file.txt"; -$v_list[1]="dev/data/"; +$v_list[1]="dev/data/"; $v_list[2]="log/file.log"; $tar_object->createModify($v_list, "install", "dev"); // files are stored in the archive as : @@ -502,24 +527,43 @@ // install/data/... all the files and sub-dirs of data/ // install/log/file.log ]]> - </programlisting> + </programlisting> + </example> + <example> + <title>createModify()</title> + <programlisting role="php"> + <![CDATA[ +$tar_object = new Archive_Tar("tarname.tgz", true); +$tar_object->setErrorHandling(PEAR_ERROR_PRINT); +$v_list[0]="c:\dev\file.txt"; +$v_list[1]="c:\dev\data\"; +$v_list[2]="c:\log\file.log"; +$tar_object->createModify($v_list, "install/temp", "c:\dev"); +// files are stored in the archive as : +// install/temp/file.txt +// install/temp/data +// install/temp/data/file1.txt +// install/temp/data/... all the files and sub-dirs of data/ +// install/temp/log/file.log + ]]> + </programlisting> </example> </refsect1> <refsect1 id="packages.file.archive-tar.extractmodify"> - <title>Archive_Tar::extractModify()</title> + <title>Archive_Tar::extractModify()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>extractModify</function></funcdef> <paramdef>string <parameter>$path</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$remove_path</parameter></paramdef> </funcprototype> </funcsynopsis> <para> - Cette méthode extrait tous les fichiers de l'archive dans le dossier + Cette méthode extrait tous les fichiers de l'archive dans le dossier <parameter>path</parameter>. Lorsque cela est possible, le chemin mémorisé dans l'archive - est modifié de façon à y retirer le chemin <parameter>remove_path</parameter> se trouvant + est modifié de façon à y retirer le chemin <parameter>remove_path</parameter> se trouvant au debut du chemin du fichier ou du dossier. </para> <para> @@ -543,28 +587,28 @@ <itemizedlist> <listitem> <para> - <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les + <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les dossiers archivés seront extrait. </para> </listitem> <listitem> <para> - <parameter>$remove_path</parameter> - partie du chemin mémorisé des fichiers ou dossiers + <parameter>$remove_path</parameter> - partie du chemin mémorisé des fichiers ou dossiers qui sera retiré avant l'extraction si cela est possible. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>extractModify()</title> @@ -583,25 +627,50 @@ // install/data/log.txt // install/readme.txt ]]> - </programlisting> + </programlisting> </example> + <example> + <title>extractModify()</title> + <programlisting role="php"> + <![CDATA[ +// tarname.tar with files : +// dev/data/file.txt +// dev/data/log.txt +// readme.txt + +$tar_object = new Archive_Tar("tarname.tar"); +$tar_object->extractModify("d:\install\temp", "dev"); + +// Files will be extracted there : +// d:\install\temp\data\file.txt +// d:\install\temp\data\log.txt +// d:\install\temp\readme.txt + ]]> + </programlisting> + </example> + <para> + Sous un OS windows, le chemin de dossier au format windows ('d:\path\dir') + peut être utilisé pour le paramètre $add_dir. Il ne doit pas être utilsé + pour le paramètre $remove_dir qui doit correspondre au format mémorisé dans + l'archive. + </para> </refsect1> <refsect1 id="packages.file.archive-tar.extractlist"> - <title>Archive_Tar::extractList()</title> + <title>Archive_Tar::extractList()</title> <funcsynopsis> <funcprototype> <funcdef>boolean <function>extractList</function></funcdef> <paramdef>array <parameter>$filelist</parameter></paramdef> - <paramdef>string + <paramdef>string <parameter>$path</parameter></paramdef> - <paramdef>string - <parameter><optional>$remove_path</optional></parameter></paramdef> + <paramdef>string + <parameter><optional>$remove_path</optional></parameter></paramdef> </funcprototype> </funcsynopsis> <para> Cette méthode extrait de l'archive uniquement les fichiers indiqués dans - <parameter>filelist</parameter>. Ces fichiers ou dossiers sont extraits dans le dossier + <parameter>filelist</parameter>. Ces fichiers ou dossiers sont extraits dans le dossier courant ou dans le dossier indiqué par le paramètre optionnel <parameter>path</parameter>. </para> <para> @@ -615,7 +684,7 @@ </listitem> <listitem> <para> - <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les + <parameter>$path</parameter> - le chemin du dossier dans lequel les fichiers et les dossiers archivés seront extrait. </para> </listitem> @@ -623,20 +692,20 @@ <para> <parameter>$remove_path</parameter> - partie du chemin mémorisé des fichiers ou dossiers qui sera retiré avant l'extraction si cela est possible. - </para> + </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <para> Returns <itemizedlist> <listitem> <para> - <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, + <parameter>boolean</parameter> - <parameter>true</parameter> sur réussite, <parameter>false</parameter> et un texte d'erreur PEAR sur échec. </para> </listitem> - </itemizedlist> + </itemizedlist> </para> <example> <title>extractList()</title> @@ -655,11 +724,11 @@ // install/data/file.txt // install/readme.txt ]]> - </programlisting> + </programlisting> </example> </refsect1> - - </refentry> + + </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -678,4 +747,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 ---> +--> \ No newline at end of file