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

<!-- EN-Revision: 12116 -->
<sect1 id="zend.text.figlet">
    <title>Zend_Text_Figlet</title>

    <para><classname>Zend_Text_Figlet</classname> est un composant qui permet aux développeurs de créer des textes dénommés
    FIGlet. Un texte FIGlet test une chaîne de caractères, qui est représenté en "ASCII-art". FIGlet utilise une format
    de police spécial , nommée FLT (FigLet Font). Par défaut, une police standard est fourni avec
    <classname>Zend_Text_Figlet</classname>, mais vous pouvez ajouter des polices additionnels à <ulink
    url="http://www.figlet.org/fontdb.cgi">http://www.figlet.org</ulink>.</para>

    <note>
        <title>Polices compressée</title>

        <para><classname>Zend_Text_Figlet</classname> supporte les polices compressées en gzip. Ceci veut dire que vous pouvez
        prendre un fichier <code>.flf</code> et le gzipper. Pour permettre à <classname>Zend_Text_Figlet</classname> de les
        reconnaître, les polices gzippées doivent avoir l'extension <code>.gz</code>. De plus, pour pouvoir utiliser les
        polices compressées, vous devez activer l'extension GZIP de PHP.</para>
    </note>

    <note>
        <title>Encodage</title>

        <para><classname>Zend_Text_Figlet</classname> considère que vos chaînes sont encodées en UTF-8 par défaut. Si ce n'est pas
        le cas, vous pouvez fournir le type d'encodage des caractères en tant que second paramètre à la méthode
        <code>render()</code>.</para>
    </note>

    <para>Il existe plusieurs options pour un FIGlet. Quand vous instanciez <classname>Zend_Text_Figlet</classname>, vous pouvez
    les fournir sous la forme d'un tableau ou d'un objet <classname>Zend_Config</classname>. <itemizedlist>
            <listitem>
                <para><code>font</code> : défini la police utilisée pour le rendu. Par défaut la police incorporé sera
                utilisée.</para>
            </listitem>

            <listitem>
                <para><code>outputWidth</code> : défini la largeur maximum de la chaîne résultat. Ceci est utilisé pour
                le retour à la ligne automatique ainsi que pour la justification. Attention cependant à de trop petites
                valeurs, qui pourraient induire un comportement indéfini. La valeur par défaut est 80.</para>
            </listitem>

            <listitem>
                <para><code>handleParagraphs</code> : un booléen qui indique, comment les nouvelles lignes sont gérées.
                Réglé à <code>true</code>, les nouvelles lignes uniques sont ignorées et traitées comme un espace
                unique. Seules des nouvelles lignes multiples seront gérées comme telles. La valeur par défaut est
                <code>false</code>.</para>
            </listitem>

            <listitem>
                <para><code>justification</code> : peut être une des valeurs de type
                <classname>Zend_Text_Figlet::JUSTIFICATION_*</classname>. Il existe <code>JUSTIFICATION_LEFT</code>,
                <code>JUSTIFICATION_CENTER</code> et <code>JUSTIFICATION_RIGHT</code>. La justification par défaut est
                défini par la valeur de <code>rightToLeft</code>.</para>
            </listitem>

            <listitem>
                <para><code>rightToLeft</code> : défini la direction d'écriture du texte. Peut être
                <classname>Zend_Text_Figlet::DIRECTION_LEFT_TO_RIGHT</classname> ou
                <classname>Zend_Text_Figlet::DIRECTION_RIGHT_TO_LEFT</classname>. Par défaut le réglage du fichier de police est
                utilisé. Quand aucune justification n'est définie, un texte écrit de droite à gauche est automatiquement
                aligné à droite.</para>
            </listitem>

            <listitem>
                <para><code>smushMode</code> : un entier qui définit comme chaque caractère est fusionné avec les
                autres. Peut être la somme de multiple valeurs de type <classname>Zend_Text_Figlet::SM_*</classname>. Il existe
                les modes de fusion suivant : SM_EQUAL, SM_LOWLINE, SM_HIERARCHY, SM_PAIR, SM_BIGX, SM_HARDBLANK,
                SM_KERN et SM_SMUSH. Une valeur de 0 ne désactive pas entièrement la fusion, mais force la valeur
                SM_KERN, tandis que la valeur de -1 la désactive. Une explication des différents modes de fusion peut
                être trouvé <ulink url="http://www.jave.de/figlet/figfont.txt">ici</ulink>. Par défaut le réglage de la
                police est utilisé. L'option du mode de fusion est normalement seulement utilisé par les concepteurs de
                police testant les différents mode de disposition d'une nouvelle police.</para>
            </listitem>
        </itemizedlist></para>

    <example id="zend.text.figlet.example.using">
        <title>Utilisation Zend_Text_Figlet</title>

        <para>Cet exemple illustre une utilisation basique de <classname>Zend_Text_Figlet</classname> pour créer une texte FIGlet
        simple :</para>

        <programlisting role="php"><![CDATA[
$figlet = new Zend_Text_Figlet();
echo $figlet->render('Zend');
]]></programlisting>

        <para>En considérant que vous utilisez une police à espacement fixe, vous obtiendrez quelque chose comme ceci
        :</para>

        <programlisting role="text"><![CDATA[
  ______    ______    _  __   ______
 |__  //   |  ___||  | \| || |  __ \\
   / //    | ||__    |  ' || | |  \ ||
  / //__   | ||___   | .  || | |__/ ||
 /_____||  |_____||  |_|\_|| |_____//
 `-----`'  `-----`   `-` -`'  -----`
]]></programlisting>
    </example>
</sect1>