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

<!-- EN-Revision: 13834 -->
<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 :</para>

    <itemizedlist>
        <listitem>
            <para><code>width</code> : soit un entier ou la constante <code>AUTO</code> de
            <classname>Zend_Console_ProgressBar</classname>.</para>
        </listitem>

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

            <itemizedlist>
                <listitem>
                    <para><code>ELEMENT_PERCENT</code> : la valeur courante en pourcentage.</para>
                </listitem>

                <listitem>
                    <para><code>ELEMENT_BAR</code> : la barre qui va représenter le pourcentage.</para>
                </listitem>

                <listitem>
                    <para><code>ELEMENT_ETA</code> : le calcul automatique du temps restant estimé (NDT. : "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><code>ELEMENT_TEXT</code> : un message de statut optionnel concernant le processus
                    courant.</para>
                </listitem>
            </itemizedlist>
        </listitem>

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

        <listitem>
            <para><code>barLeftChar</code> : 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> : 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> : un caractère qui est utilisé pour l'indicateur de la barre de
            progression. Celui-ci peut être vide.</para>
        </listitem>
    </itemizedlist>
</sect3>