documentation/manual/ja/module_specs/Zend_ProgressBar_Adapter_Console.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- Reviewed: no -->
   3 <!-- EN-Revision: 20827 -->
   4 <sect3 id="zend.progressbar.adapter.console">
   5     <title>Zend_ProgressBar_Adapter_Console</title>
   6     <para>
   7         <classname>Zend_ProgressBar_Adapter_Console</classname> は、
   8         ターミナル用に使用するテキストベースのアダプタです。
   9         ターミナルの横幅を自動的に検出できますが、
  10         独自に幅を指定することもできます。
  11         プログレスバーとともに表示する要素や、その順序も変更できます。
  12         また、プログレスバーそのものの形式も設定できます。
  13     </para>
  14     <note>
  15         <title>自動的なコンソール幅の認識</title>
  16         <para>
  17             この機能を *nix 系のシステムで使用するには
  18             <code>shell_exec</code> が必要です。Windows
  19             ではターミナルの幅は 80 文字固定なので、
  20             認識処理は不要です。
  21         </para>
  22     </note>
  23     <para>
  24         アダプタのオプションを設定するには、<code>set*</code>
  25         メソッドを使用するか、あるいはコンストラクタの最初のパラメータで
  26         配列か <classname>Zend_Config</classname> インスタンスを渡します。
  27         使用できるオプションは次のとおりです。
  28     </para>
  29     <itemizedlist>
  30         <listitem>
  31             <para>
  32                 <code>outputStream</code>: さまざまな出力ストリーム。
  33                 STDOUT 意外に出力したい場合に使用します。
  34                 <code>php://stderr</code> のようなストリーム、
  35                 あるいはファイルへのパスを指定できます。
  36             </para>
  37         </listitem>
  38         <listitem>
  39             <para>
  40                 <code>width</code>: 整数値、あるいは
  41                 <classname>Zend_Console_ProgressBar</classname> の定数 <constant>AUTO</constant>。
  42             </para>
  43         </listitem>
  44         <listitem>
  45             <para>
  46                 <code>elements</code>: デフォルトは <constant>NULL</constant>。
  47                 あるいは以下の <classname>Zend_Console_ProgressBar</classname>
  48                 の定数のうちの少なくともひとつを値として持つ配列。
  49             </para>
  50
  51             <itemizedlist>
  52                 <listitem>
  53                     <para>
  54                         <constant>ELEMENT_PERCENT</constant>: パーセントであらわした現在値。
  55                     </para>
  56                 </listitem>
  57                 <listitem>
  58                     <para>
  59                         <constant>ELEMENT_BAR</constant>:
  60                         パーセンテージを表示するバー。
  61                     </para>
  62                 </listitem>
  63                 <listitem>
  64                     <para>
  65                         <constant>ELEMENT_ETA</constant>: 自動的に計算した予想残り時間。
  66                         この要素が表示されるのは、開始後 5 秒たってからです。
  67                         それまでは正確な結果を算出できないからです。
  68                     </para>
  69                 </listitem>
  70                 <listitem>
  71                     <para>
  72                         <constant>ELEMENT_TEXT</constant>:
  73                         現在の処理に関する状況を説明するオプションのメッセージ。
  74                     </para>
  75                 </listitem>
  76             </itemizedlist>
  77         </listitem>
  78         <listitem>
  79             <para>
  80                 <code>textWidth</code>:
  81                 <constant>ELEMENT_TEXT</constant> 要素の幅を文字数で表したもの。デフォルトは 20。
  82             </para>
  83         </listitem>
  84         <listitem>
  85             <para>
  86                 <code>charset</code>:
  87                 <constant>ELEMENT_TEXT</constant> 要素の文字セット。デフォルトは utf-8。
  88             </para>
  89         </listitem>
  90         <listitem>
  91             <para>
  92                 <code>barLeftChar</code>:
  93                 プログレスバー内で左側のインジケータとして使用する文字列。
  94             </para>
  95         </listitem>
  96         <listitem>
  97             <para>
  98                 <code>barRightChar</code>:
  99                 プログレスバー内で右側のインジケータとして使用する文字列。
 100             </para>
 101         </listitem>
 102         <listitem>
 103             <para>
 104                 <code>barIndicatorChar</code>:
 105                 プログレスバー内でインジケータとして使用する文字列。
 106                 これは空にすることもできます。
 107             </para>
 108         </listitem>
 109     </itemizedlist>
 110 </sect3>
 111 <!--
 112 vim:se ts=4 sw=4 et:
 113 -->