repo_zf1/documentation/manual/fr/module_specs/Zend_ProgressBar_Adapter_Console.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 24249 -->
<!-- Reviewed: no -->
<sect3 id="zend.progressbar.adapter.console">
    <title>Zend_ProgressBar_Adapter_Console</title>

    <para>
        <classname>Zend_ProgressBar_Adapter_Console</classname> est un adaptateur de type
        texte pour les terminaux. Il peut automatiquement détecter la largeur du terminal mais
        supporte aussi des largeurs personnalisées. Vous pouvez définir quels éléments seront
        affichés avec la barre de progression et personnaliser leur ordre. Vous pouvez aussi définir
        le style de la barre de progression elle-même.
    </para>

    <note>
        <title>Reconnaissance automatique de la largeur de la console</title>

        <para>
            <code>shell_exec</code> est nécessaire pour que ceci fonctionne sur les systèmes
            de type *nix. Sur Windows, il y a toujours un terminal fixe de 80 caractères de large,
            donc la reconnaissance automatique n'est pas nécessaire.
        </para>
    </note>

    <para>
        Vous pouvez paramétrer les options de l'adaptateur soit via les méthodes
        <code>set*</code> soit en fournissant un tableau ("array") ou une instance
        <classname>Zend_Config</classname> en tant que premier paramètre du constructeur. Les
        options disponibles sont&#160;:
    </para>

    <itemizedlist>
         <listitem>
             <para>
                <code>outputStream</code>&#160;: un flux de sortie différent, si vous ne souhaitez pas
                utiliser STDOUT. Peut être n'importe quel autre flux come <code>php://stderr</code>
                ou un chemin vers un fichier.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>width</code>&#160;: soit un entier ou la constante <constant>AUTO</constant> de
                <classname>Zend_Console_ProgressBar</classname>.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>elements</code>&#160;: soit <constant>NULL</constant> par défaut ou un tableau avec
                au moins l'une des constantes de <classname>Zend_Console_ProgressBar</classname>
                suivantes comme valeur&#160;:
            </para>

            <itemizedlist>
                <listitem>
                    <para>
                        <constant>ELEMENT_PERCENT</constant>&#160;: la valeur courante en
                        pourcentage.
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <constant>ELEMENT_BAR</constant>&#160;: la barre qui va représenter le
                        pourcentage.
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <constant>ELEMENT_ETA</constant>&#160;: le calcul automatique du temps restant
                        estimé (NDT.&#160;: "Estimated Time for Accomplishment"). Cet élément est affiché
                        pour la première fois qu'après cinq secondes, car durant ce temps, il n'est
                        pas possible de calculer des résultats précis.
                    </para>
                </listitem>

                <listitem>
                    <para>
                        <constant>ELEMENT_TEXT</constant>&#160;: un message de statut optionnel concernant
                        le processus courant.
                    </para>
                </listitem>
            </itemizedlist>
        </listitem>

        <listitem>
            <para>
                <code>textWidth</code>&#160;: largeur en caractères de l'élément
                <constant>ELEMENT_TEXT</constant>. Par défaut vaut 20.
            </para>
        </listitem>

         <listitem>
             <para>
                <code>charset</code>&#160;: encodage de l'élément <constant>ELEMENT_TEXT</constant>. Par défaut
                vaut "utf-8".
            </para>
        </listitem>

        <listitem>
            <para>
                <code>barLeftChar</code>&#160;: un caractère qui est utilisé du côté gauche de
                l'indicateur de la barre de progression.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>barRightChar</code>&#160;: un caractère qui est utilisé du côté droit de
                l'indicateur de la barre de progression.
            </para>
        </listitem>

        <listitem>
            <para>
                <code>barIndicatorChar</code>&#160;: un caractère qui est utilisé pour l'indicateur
                de la barre de progression. Celui-ci peut être vide.
            </para>
        </listitem>
    </itemizedlist>
</sect3>