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

<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<!-- EN-Revision: 24249 -->
<sect3 id="zend.progressbar.adapter.console">
    <title>Zend_ProgressBar_Adapter_Console(日本語)</title>
    <para>
        <classname>Zend_ProgressBar_Adapter_Console</classname> は、
        ターミナル用に使用するテキストベースのアダプタです。
        ターミナルの横幅を自動的に検出できますが、
        独自に幅を指定することもできます。
        プログレスバーとともに表示する要素や、その順序も変更できます。
        また、プログレスバーそのものの形式も設定できます。
    </para>
    <note>
        <title>自動的なコンソール幅の認識</title>
        <para>
            この機能を *nix 系のシステムで使用するには
            <code>shell_exec</code> が必要です。Windows
            ではターミナルの幅は 80 文字固定なので、
            認識処理は不要です。
        </para>
    </note>
    <para>
        アダプタのオプションを設定するには、<code>set*</code>
        メソッドを使用するか、あるいはコンストラクタの最初のパラメータで
        配列か <classname>Zend_Config</classname> インスタンスを渡します。
        使用できるオプションは次のとおりです。
    </para>
    <itemizedlist>
        <listitem>
            <para>
                <code>outputStream</code>: さまざまな出力ストリーム。
                STDOUT 意外に出力したい場合に使用します。
                <code>php://stderr</code> のようなストリーム、
                あるいはファイルへのパスを指定できます。
            </para>
        </listitem>
        <listitem>
            <para>
                <code>width</code>: 整数値、あるいは
                <classname>Zend_Console_ProgressBar</classname> の定数 <constant>AUTO</constant>。
            </para>
        </listitem>
        <listitem>
            <para>
                <code>elements</code>: デフォルトは <constant>NULL</constant>。
                あるいは以下の <classname>Zend_Console_ProgressBar</classname>
                の定数のうちの少なくともひとつを値として持つ配列。
            </para>

            <itemizedlist>
                <listitem>
                    <para>
                        <constant>ELEMENT_PERCENT</constant>: パーセントであらわした現在値。
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <constant>ELEMENT_BAR</constant>:
                        パーセンテージを表示するバー。
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <constant>ELEMENT_ETA</constant>: 自動的に計算した予想残り時間。
                        この要素が表示されるのは、開始後 5 秒たってからです。
                        それまでは正確な結果を算出できないからです。
                    </para>
                </listitem>
                <listitem>
                    <para>
                        <constant>ELEMENT_TEXT</constant>:
                        現在の処理に関する状況を説明するオプションのメッセージ。
                    </para>
                </listitem>
            </itemizedlist>
        </listitem>
        <listitem>
            <para>
                <code>textWidth</code>:
                <constant>ELEMENT_TEXT</constant> 要素の幅を文字数で表したもの。デフォルトは 20。
            </para>
        </listitem>
        <listitem>
            <para>
                <code>charset</code>:
                <constant>ELEMENT_TEXT</constant> 要素の文字セット。デフォルトは utf-8。
            </para>
        </listitem>
        <listitem>
            <para>
                <code>barLeftChar</code>:
                プログレスバー内で左側のインジケータとして使用する文字列。
            </para>
        </listitem>
        <listitem>
            <para>
                <code>barRightChar</code>:
                プログレスバー内で右側のインジケータとして使用する文字列。
            </para>
        </listitem>
        <listitem>
            <para>
                <code>barIndicatorChar</code>:
                プログレスバー内でインジケータとして使用する文字列。
                これは空にすることもできます。
            </para>
        </listitem>
    </itemizedlist>
</sect3>
<!--
vim:se ts=4 sw=4 et:
-->