documentation/manual/fr/module_specs/Zend_ProgressBar_Adapter_Console.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- EN-Revision: 20827 -->
   3 <!-- Reviewed: no -->
   4 <sect3 id="zend.progressbar.adapter.console">
   5     <title>Zend_ProgressBar_Adapter_Console</title>
   6
   7     <para>
   8         <classname>Zend_ProgressBar_Adapter_Console</classname> est un adaptateur de type
   9         texte pour les terminaux. Il peut automatiquement détecter la largeur du terminal mais
  10         supporte aussi des largeurs personnalisées. Vous pouvez définir quels éléments seront
  11         affichés avec la barre de progression et personnaliser leur ordre. Vous pouvez aussi définir
  12         le style de la barre de progression elle-même.
  13     </para>
  14
  15     <note>
  16         <title>Reconnaissance automatique de la largeur de la console</title>
  17
  18         <para>
  19             <code>shell_exec</code> est nécessaire pour que ceci fonctionne sur les systèmes
  20             de type *nix. Sur Windows, il y a toujours un terminal fixe de 80 caractères de large,
  21             donc la reconnaissance automatique n'est pas nécessaire.
  22         </para>
  23     </note>
  24
  25     <para>
  26         Vous pouvez paramétrer les options de l'adaptateur soit via les méthodes
  27         <code>set*</code> soit en fournissant un tableau ("array") ou une instance
  28         <classname>Zend_Config</classname> en tant que premier paramètre du constructeur. Les
  29         options disponibles sont&#160;:
  30     </para>
  31
  32     <itemizedlist>
  33          <listitem>
  34              <para>
  35                 <code>outputStream</code>&#160;: un flux de sortie différent, si vous ne souhaitez pas
  36                 utiliser STDOUT. Peut être n'importe quel autre flux come <code>php://stderr</code>
  37                 ou un chemin vers un fichier.
  38             </para>
  39         </listitem>
  40
  41         <listitem>
  42             <para>
  43                 <code>width</code>&#160;: soit un entier ou la constante <constant>AUTO</constant> de
  44                 <classname>Zend_Console_ProgressBar</classname>.
  45             </para>
  46         </listitem>
  47
  48         <listitem>
  49             <para>
  50                 <code>elements</code>&#160;: soit <constant>NULL</constant> par défaut ou un tableau avec
  51                 au moins l'une des constantes de <classname>Zend_Console_ProgressBar</classname>
  52                 suivantes comme valeur&#160;:
  53             </para>
  54
  55             <itemizedlist>
  56                 <listitem>
  57                     <para>
  58                         <constant>ELEMENT_PERCENT</constant>&#160;: la valeur courante en
  59                         pourcentage.
  60                     </para>
  61                 </listitem>
  62
  63                 <listitem>
  64                     <para>
  65                         <constant>ELEMENT_BAR</constant>&#160;: la barre qui va représenter le
  66                         pourcentage.
  67                     </para>
  68                 </listitem>
  69
  70                 <listitem>
  71                     <para>
  72                         <constant>ELEMENT_ETA</constant>&#160;: le calcul automatique du temps restant
  73                         estimé (NDT.&#160;: "Estimated Time for Accomplishment"). Cet élément est affiché
  74                         pour la première fois qu'après cinq secondes, car durant ce temps, il n'est
  75                         pas possible de calculer des résultats précis.
  76                     </para>
  77                 </listitem>
  78
  79                 <listitem>
  80                     <para>
  81                         <constant>ELEMENT_TEXT</constant>&#160;: un message de statut optionnel concernant
  82                         le processus courant.
  83                     </para>
  84                 </listitem>
  85             </itemizedlist>
  86         </listitem>
  87
  88         <listitem>
  89             <para>
  90                 <code>textWidth</code>&#160;: largeur en caractères de l'élément
  91                 <constant>ELEMENT_TEXT</constant>. Par défaut vaut 20.
  92             </para>
  93         </listitem>
  94
  95          <listitem>
  96              <para>
  97                 <code>charset</code>&#160;: encodage de l'élément <constant>ELEMENT_TEXT</constant>. Par défaut
  98                 vaut "utf-8".
  99             </para>
 100         </listitem>
 101
 102         <listitem>
 103             <para>
 104                 <code>barLeftChar</code>&#160;: un caractère qui est utilisé du côté gauche de
 105                 l'indicateur de la barre de progression.
 106             </para>
 107         </listitem>
 108
 109         <listitem>
 110             <para>
 111                 <code>barRightChar</code>&#160;: un caractère qui est utilisé du côté droit de
 112                 l'indicateur de la barre de progression.
 113             </para>
 114         </listitem>
 115
 116         <listitem>
 117             <para>
 118                 <code>barIndicatorChar</code>&#160;: un caractère qui est utilisé pour l'indicateur
 119                 de la barre de progression. Celui-ci peut être vide.
 120             </para>
 121         </listitem>
 122     </itemizedlist>
 123 </sect3>