1 <?xml version="1.0" encoding="UTF-8"?>
3 <!-- EN-Revision: 20807 -->
4 <sect1 id="zend.text.figlet">
5 <title>Zend_Text_Figlet</title>
8 <classname>Zend_Text_Figlet</classname> は、いわゆる
9 FIGlet テキストを作成するためのコンポーネントです。
10 FIGlet テキストとは、<acronym>ASCII</acronym> アートで表した文字列のことです。
11 FIGlet では、FLT (FigLet Font) と呼ばれる特殊なフォント形式を使用します。
12 デフォルトで <classname>Zend_Text_Figlet</classname>
13 に同梱されているフォントは標準フォント 1 つだけですが、
14 <ulink url="http://www.figlet.org/fontdb.cgi">http://www.figlet.org</ulink>
15 からその他のフォントをダウンロードできます。
19 <title>圧縮されたフォント</title>
22 <classname>Zend_Text_Figlet</classname> は gzip で圧縮されたフォントに対応しています。
23 つまり、<code>.flf</code> ファイルを gzip した状態で使えるということです。
24 <classname>Zend_Text_Figlet</classname> でこれを使用するには、gzip
25 したフォントの拡張子が <code>.gz</code> でなければなりません。
26 さらに、gzip されたフォントを使用するには <acronym>PHP</acronym>
27 の GZIP 拡張モジュールを有効にする必要があります。
32 <title>エンコーディング</title>
35 <classname>Zend_Text_Figlet</classname> は、デフォルトでは文字列が UTF-8
36 でエンコードされていることを想定しています。それ以外の場合は、
37 <methodname>render()</methodname> メソッドの
38 2 番目のパラメータで文字エンコーディングを指定します。
43 FIGlet 用のさまざまなオプションを指定できます。
44 <classname>Zend_Text_Figlet</classname> のインスタンスを作成する際に、
45 配列あるいは <classname>Zend_Config</classname> のインスタンスで指定します。
50 <code>font</code> - レンダリングに使用するフォント。
51 未定義の場合は組み込みのフォントを使用します。
57 <code>outputWidth</code> - 出力文字列の最大幅。
60 予期せぬ結果となってしまうので注意しましょう。
67 <code>handleParagraphs</code> - 改行の処理方法を示す boolean 値。
68 <constant>TRUE</constant> を指定すると、単一の改行文字を無視してひとつの空白文字として扱います。
69 ほんとうに改行させたい場合は、改行文字を 2 つ続けます。
70 デフォルトは <constant>FALSE</constant> です。
76 <code>justification</code> -
77 <classname>Zend_Text_Figlet::JUSTIFICATION_*</classname>
78 のいずれかの値。<constant>JUSTIFICATION_LEFT</constant>、
79 <constant>JUSTIFICATION_CENTER</constant> そして
80 <constant>JUSTIFICATION_RIGHT</constant> があります。
82 <code>rightToLeft</code> の値によって決まります。
88 <code>rightToLeft</code> - テキストを記述する方向。
89 <constant>Zend_Text_Figlet::DIRECTION_LEFT_TO_RIGHT</constant> あるいは
90 <constant>Zend_Text_Figlet::DIRECTION_RIGHT_TO_LEFT</constant>
91 となります。デフォルトでは、フォントファイルの設定を使用します。
92 justification が定義されていない場合は、
93 右から左にテキストを書くときには自動的に右揃えとなります。
99 <code>smushMode</code> - 整数値。
101 <classname>Zend_Text_Figlet::SM_*</classname> の複数の値の和を指定できます。
102 SM_EQUAL, SM_LOWLINE,
103 SM_HIERARCHY, SM_PAIR, SM_BIGX, SM_HARDBLANK, SM_KERN そして
104 SM_SMUSH といったモードがあります。値 0 は、
105 「すべてを無効にする」ではなく「SM_KERN を適用する」
106 という意味になります。無効にするには -1 を指定します。
107 それぞれのモードがどんなものなのかについての説明が
108 <ulink url="http://www.jave.de/figlet/figfont.txt">ここ</ulink>
110 デフォルトでは、フォントファイルの設定を使用します。
112 フォントデザイナが新しいフォントを作成する際に
113 レイアウトを確かめるといった場合のみです。
119 <example id="zend.text.figlet.example.using">
120 <title>Zend_Text_Figlet の使用法</title>
123 この例は、<classname>Zend_Text_Figlet</classname>
124 の基本的な使用法を説明するためにシンプルな
125 FIGlet テキストを作成するものです。
128 <programlisting language="php"><![CDATA[
129 require_once 'Zend/Text/Figlet.php';
130 $figlet = new Zend_Text_Figlet();
131 echo $figlet->render('Zend');
135 等幅フォントを使用すると、この結果は次のようになります。
138 <programlisting language="text"><![CDATA[
139 ______ ______ _ __ ______
140 |__ // | ___|| | \| || | __ \\
141 / // | ||__ | ' || | | \ ||
142 / //__ | ||___ | . || | |__/ ||
143 /_____|| |_____|| |_|\_|| |_____//
144 `-----`' `-----` `-` -`' -----`